Zotero Connectors 技术文档

本文档将详细介绍如何安装、使用以及API调用Zotero Connectors项目。

1. 安装指南

首先，确保您的系统中已经安装了Node.js和npm（Node.js的包管理器）。以下是安装Zotero Connectors的步骤：

git clone --recursive https://github.com/zotero/zotero-connectors.git
cd zotero-connectors
npm install
./build.sh -d

上述命令将克隆Zotero Connectors仓库，安装所需的依赖，并构建项目。

2. 项目的使用说明

构建完成后，以下是如何在不同浏览器中运行Zotero Connectors的说明：

Chrome

1. 打开 chrome://extensions/ 并启用“开发者模式”。
2. 点击“加载已解压的扩展程序…”并选择 build/browserExt 目录。

Firefox

1. 打开 about:debugging。
2. 点击“加载临时扩展”并选择 build/browserExt/manifest.json 文件。

或者：

1. 下载并安装 Mozilla web-ext 工具。
2. 切换到项目根目录。
3. 执行 ./scripts/firefox/run_xpi。

Safari

请参考 Zotero Safari App Extension 仓库。

3. 项目API使用文档

Zotero Connectors 的API调用主要通过浏览器扩展的消息传递协议实现。以下是API的基本使用方法：

消息传递

• 发送消息: 从注入脚本向背景脚本发送消息。
• 监听消息: 在背景脚本中注册消息监听器，以响应来自注入脚本的请求。

以下是一个示例：

// 发送消息
Zotero.Messaging.send(requestData);

// 监听消息
Zotero.Messaging.listen(messageType, handlerFunction);

更多详细信息和示例，请参考项目源代码中的 messages.js 文件。

4. 项目安装方式

Zotero Connectors 的安装方式已在“安装指南”部分详细说明。以下是一个简要总结：

1. 克隆仓库：git clone --recursive https://github.com/zotero/zotero-connectors.git
2. 切换到项目目录：cd zotero-connectors
3. 安装依赖：npm install
4. 构建项目：./build.sh -d
5. 根据浏览器类型，加载扩展程序。

以上是关于Zotero Connectors项目的安装、使用和API调用的技术文档。希望这些信息对您有所帮助。