
VS Code 插件 zotero-live-cite:在 LaTeX 中直接引用 Zotero 文献
来源标题:VSCode extension to add bib entries from your Zotero library
这款 VS Code 扩展为 LaTeX 提供类似 Overleaf 的引用自动补全:输入 \cite{ 后按作者、标题词、年份或 key 搜索,建议直接来自正在运行的 Zotero 库。选中后插入引用 key,并自动把对应的 BibTeX 条目加入项目的 .bib 文件(若尚不存在)。它无需导出步骤,也不依赖 Better BibTeX,而是直接调用 Zotero 客户端的本地 API,生成的 key 与 Zotero 自身 BibTeX 导出格式一致。
以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。
在 VS Code 中为 LaTeX 提供 Overleaf 风格的引用自动补全。输入 \cite{ 后开始键入作者、标题中的词、年份或 key,建议就直接来自正在运行的 Zotero 文库。选中一条建议后,会插入对应的 key,并把该文献的 BibTeX 条目添加到项目的 .bib 文件中(如果尚不存在)。录制时使用的是一个示例文库(npm run demo)。 无需导出步骤,也不需要 Better BibTeX:该扩展直接与 Zotero 应用内置的本地 API 通信,生成的 key 与 Zotero 自身 BibTeX 导出的结果完全一致(lastname_titleword_year,例如 vaswani_attention_2017)。 在终端(macOS 或 Linux,bash 或 zsh)中运行以下命令之一。每条命令都会把打包好的扩展下载到临时文件夹,安装到 VS Code,然后删除该文件夹,因此 Downloads 或其他任何位置都不会留下文件。再次运行同一命令即可更新,然后重新加载所有打开的 VS Code 窗口(命令面板 → Developer: Reload Window)。 d=$(mktemp -d) && git clone -q --depth 1 --branch vsix https://github.com/justachetan/zotero-live-cite.git "$d" && code --install-extension "$d/zotero-live-cite.vsix" --force; rm -rf "$d" 如果你通过 SSH 使用 GitHub,请把 URL 替换为 git@github.com:justachetan/zotero-live-cite.git。 使用 GitHub CLI 时,先用 gh auth login 登录: d=$(mktemp -d) && gh release download -R justachetan/zotero-live-cite -p '.vsix' -D "$d" && code --install-extension "$d"/.vsix --force; rm -rf "$d" 两条命令都要求 VS Code 的 code 命令在 PATH 中(在 VS Code 中:命令面板 → Shell Command: Install 'code' command in PATH)。 code --uninstall-extension local.zotero-live-cite 配置 Zotero Zotero 7 或更高版本必须处于运行状态。已用 Zotero 10.0.7 测试。 在 Zotero 中打开 设置 → 高级,勾选 Allow other applications on this computer to communicate with Zotero。 可选:在 VS Code 中,从命令面板运行 Zotero Live Cite: Select Collection to Search,将建议限制在单个分类中(包含子分类)。该选择会保存在工作区的 .vscode/settings.json 中。 使用 在任意引用命令(\cite、\citep、\citet、\citeauthor、\nocite、\textcite、\parencite、\Citep 等)中,于 { 或逗号之后键入。 标记为 Zotero 的建议来自你的文库;右侧文字是论文标题。键入 key 的一部分也可以:vaswani_att 会搜索 "vaswani att"。 接受建议后,该条目会追加到 .bib 文件并保存。如果 .bib 文件有未保存的更改,条目会添加到缓冲区中,留给你自行保存。 设置 默认值 含义 zoteroLiveCite.collection ""(整个文库) 分类名称(Thesis)、路径(Reading List/Transformers)或 key。 zoteroLiveCite.bibFile ""(自动) 要追加到的 .bib 文件,相对于工作区文件夹。为空时,使用工作区中唯一的 .bib 文件;若有多个,则每个工作区询问一次。 zoteroLiveCite.libraryUrl http://127.0.0.1:23119/api/users/0 要搜索的文库。群组文库请使用 http://127.0.0.1:23119/api/groups/<groupID>。 工作原理 在 \cite{...} 内按键 → src/citeContext.ts 找到光标下的部分 key → src/zoteroClient.ts GET <library>/items/top?q=...&include=data,bibtex (设置了分类时,每个分类发一次请求) → src/completion.ts 显示结果;VS Code 在每次按键时重新询问 接受 → src/bibWriter.ts 把该条目的 BibTeX 追加到 .bib,除非其 key 已存在 每次搜索都会在返回元数据的同时返回每个条目的 BibTeX 导出,因此你看到的 key 就是最终写入 .bib 的 key,接受时无需第二次请求。Zotero 的快速搜索会匹配任意共同作者并按日期排序,因此最多获取 100 条匹配结果并在本地排序:以你所键入内容开头的 key 排在最前,其次是包含你键入的每个词的 key,然后才是其余结果。导出相同 key 的条目(文库中的重复项)只提供一次。 针对本地文库的搜索大约耗时 30–200 毫秒。 Zotero 必须处于运行状态。如果未运行,或本地 API 已关闭,会提示一次警告,Zotero 恢复后建议会继续出现。 Zotero 为每个条目单独计算导出 key,因此两个不同的条目可能得到相同的 key(在 noauthor_..._nodate 情况下很常见)。如果某个 key 已存在于 .bib 中,则不会添加或覆盖任何内容。 引用命令与 key 必须位于同一行。 安装了 LaTeX Workshop 时,它从 .bib 中给出的建议会与这些建议一起出现;已存在于 .bib 中的 key 可能显示两次。 该扩展在受限模式(不受信任的工作区)下会被禁用。 开发 npm test # 针对模拟 Zotero HTTP 服务器的单元测试 npm run test:vscode # 在单独的 VS Code 窗口中进行端到端测试 npm run smoke -- vaswani_att Thesis # 搜索你真实的 Zotero 文库 npm run demo # 重新录制 docs/demo.gif(需要 ffmpeg) 在 VS Code 中按 F5 启动扩展开发宿主。端到端测试在存在 /Applications/Visual Studio Code.app 时使用它(可通过 VSCODE_EXECUTABLE 覆盖),否则会把 VS Code 下载到 .vscode-test/。 要从克隆仓库而非发布版本构建并安装: npm install && npm run package && code --install-extension zotero-live-cite-*.vsix --force 发布 在 package.json 中提升版本号,提交并推送到 main,然后运行: scripts/release.sh 它会打包扩展,并将同一个 .vsix 发布两次:一次作为 GitHub release(用于 gh 安装命令),一次发布到 vsix 分支,该分支只保存最新的 .vsix(用于 git 安装命令)。
正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。