zotero-plugin-toolkit 中文文档教程

Question

Zotero插件工具包

简介

此存储库作为NPM包zotero-plugin-toolkit发布，它提供了有用的API适用于 Zotero 插件开发人员。

API文档

模块

• ZoteroToolkit：包含以下所有模块这个图书馆。从从“zotero-plugin-toolkit”导入 ZoteroToolkit 开始熟悉 API。

• 基本工具

• getGlobal：获取引导插件沙箱的全局变量。 Zotero、ZoteroPane、window、document 以及 window 下的任何变量。带类型提示。

• log：输出到 Zotero.debug 和 console.log< /代码>。可以根据开发/生产环境进行自定义。

• isZotero7/isXULElement

• createXULElement/getDOMParser：兼容 Zotero 6 和 Zotero 6 7+。请参阅 https://www.zotero.org/support/dev/zotero7for_developers

• 工具

• UI：创建元素并自动管理它们。

• Reader：Reader 实例 API。

• ExtraField：获取/设置额外字段 API。

• 管理器

• ItemTree：注册额外的列/自定义单元格。

• PreferencePane：注册 Zotero 6 和 Zotero 的首选项窗格7+。请参阅 https://www.zotero.org/support/dev/zotero7for_developers

• LibraryTabPanel：在库右侧注册额外的选项卡面板。

• ReaderTabPanel：在阅读器右侧边栏中注册额外的选项卡面板。

• 菜单：注册菜单/弹出菜单。

• 快捷方式：注册快捷键。

• 助手

• 剪贴板：复制文本/富文本/图像。

• FilePicker：打开文件选择器。

• ProgressWindow：打开进度窗口。

• VirtualizedTable：创建VirtualizedTable（高级表格视图元素，由Zotero项目树、集合树、项目使用） picker等）

• 对话框：创建一个对话框窗口（XUL 对话框的超集）。具有数据绑定、自动布局和控制按钮。

用法

1. 运行npm install --save zotero-plugin-toolkit。

2. 导入工具包类

import ZoteroToolkit from "zotero-plugin-toolkit";
/* Alternatively, import class you need to minify the plugin size
 * ```ts
 * import { BasicTool } from "zotero-plugin-toolkit/dist/basic";
 * import { UITool } from "zotero-plugin-toolkit/dist/tools/ui";
 */
const ztoolkit = new ZoteroToolkit();

3. 按照此API文档使用工具包

ztoolkit.log("This is Zotero:", toolkit.getGlobal("Zotero"));

⚠️所有 Manager 类都有 register 方法以及相应的 unregister/unregisterAll。插件退出时不要忘记取消注册。

此存储库取决于 zotero-types。有关 Zotero 类型定义的更多详细信息，请参阅其主页。

示例

此包集成到 Zotero 插件模板中。您可以在那里找到示例。

如果您不熟悉 Zotero 插件/正在寻找从 Zotero 6 迁移到 7 的解决方案，请查看该存储库。

API 文档还包含一些 API 的示例代码。

贡献

设置

1. 分叉此存储库。

2. 确保您已安装 nodejs 和 npm。克隆 repo 文件夹并安装依赖项：

git clone https://github.com/windingwind/zotero-plugin-toolkit
cd zotero-plugin-toolkit
npm install

Build

Run npm run build。

• ./dist下的.js包和.d.ts;

• ./docs 下的文档。

本地测试

使用您的插件进行测试或使用 Zotero 插件模板 作为游乐场。

在 Playground repo 文件夹下运行 npm install /path/to/this/repo ，该库将从本地构建安装。

游乐场采用最新的建筑。如果重建此库，则无需再次 npm install。

发布

npm run release。标记的推送将触发 npm-publish GitHub 操作。

免责声明

根据 MIT 许可证使用此代码。不提供任何保证。请牢记您所在地区的法律！

如果您想更改许可证，请通过 wyzlshx@foxmail.com 联系我

我的 Zotero 插件

• zotero-better-notes：关于笔记管理的一切。一切尽在佐特罗。
• zotero-pdf-preview：Zotero 的 PDF 预览。
• zotero-pdf-translate：Zotero 6 的 PDF 翻译。
• zotero-tag：自动标记项目/批量标记