Zotero Addons 开源项目教程

Zotero Addons 开源项目教程

zotero-addonsZotero add-on to list and install add-ons in Zotero项目地址:https://gitcode.com/gh_mirrors/zo/zotero-addons

1. 项目的目录结构及介绍

Zotero Addons 项目的目录结构如下：

zotero-addons/
├── README.md
├── package.json
├── src/
│   ├── background.js
│   ├── content.js
│   ├── options.html
│   ├── options.js
│   └── popup.html
├── manifest.json
└── styles/
    └── main.css

目录结构介绍

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• package.json: 项目的依赖管理文件，定义了项目所需的依赖和脚本。
• src/: 源代码目录，包含项目的核心代码。
  • background.js: 后台脚本文件，负责处理后台逻辑。
  • content.js: 内容脚本文件，注入到网页中执行。
  • options.html: 选项页面文件，用于配置插件的选项。
  • options.js: 选项页面的脚本文件。
  • popup.html: 弹出窗口页面文件，用户点击插件图标时显示。
• manifest.json: 项目的配置文件，定义了插件的基本信息和权限。
• styles/: 样式文件目录，包含项目的CSS样式文件。
  • main.css: 主样式文件，定义了插件的样式。

2. 项目的启动文件介绍

项目的启动文件是 background.js，它位于 src/ 目录下。background.js 负责处理插件的后台逻辑，包括监听事件、处理数据等。

background.js 主要功能

• 初始化插件状态。
• 监听浏览器事件，如页面加载完成、插件图标点击等。
• 处理与内容脚本的通信。

3. 项目的配置文件介绍

项目的配置文件是 manifest.json，它位于项目根目录下。manifest.json 定义了插件的基本信息、权限、启动文件等。

manifest.json 主要内容

{
  "manifest_version": 2,
  "name": "Zotero Addons",
  "version": "1.0",
  "description": "A collection of addons for Zotero.",
  "permissions": [
    "activeTab",
    "storage"
  ],
  "background": {
    "scripts": ["src/background.js"]
  },
  "browser_action": {
    "default_popup": "src/popup.html",
    "default_icon": {
      "16": "icons/icon16.png",
      "48": "icons/icon48.png",
      "128": "icons/icon128.png"
    }
  },
  "options_ui": {
    "page": "src/options.html",
    "open_in_tab": true
  }
}

配置文件介绍

• manifest_version: 指定 manifest 文件的版本，目前为 2。
• name: 插件的名称。
• version: 插件的版本号。
• description: 插件的描述。
• permissions: 插件所需的权限，如 activeTab 和 storage。
• background: 定义后台脚本文件。
• browser_action: 定义浏览器动作，包括弹出窗口和图标。
• options_ui: 定义选项页面的配置。

zotero-addonsZotero add-on to list and install add-ons in Zotero项目地址:https://gitcode.com/gh_mirrors/zo/zotero-addons