Citation.js 使用教程
项目介绍
Citation.js 是一个用于浏览器和命令行的格式独立模块化参考文献工具。它能够将 BibTeX、BibJSON、DOI 和 Wikidata 等格式转换为 CSL-JSON,并进一步转换为 APA、Vancouver 等样式,以及 BibTeX 和 RIS 格式。Citation.js 的特点包括模块化方法、预加载样式和区域设置、支持 Node.js 和浏览器环境,以及提供命令行接口(CLI)。
项目快速启动
安装
首先,通过 npm 安装 Citation.js 及其插件:
npm install @citation-js/core @citation-js/plugin-doi
使用
以下是一个简单的示例,展示如何使用 Citation.js 解析 DOI 并格式化输出:
// 加载 Citation.js
const { Cite } = require('@citation-js/core');
// 加载插件
require('@citation-js/plugin-doi');
// 解析输入
Cite.async('10.7717/peerj-cs.214').then(data => {
// 格式化输出
const bibliography = data.format('bibliography', {
format: 'html',
template: 'apa',
lang: 'en-US'
});
console.log(bibliography);
});
应用案例和最佳实践
应用案例
- PubPub: 一个开放出版平台,使用 Citation.js 进行参考文献管理。
- Scholia: 一个界面,显示并增强来自 Wikidata 的数据。
- wcite: 一个 CLI,用于从 Wikidata 获取和管理书目记录。
最佳实践
- 模块化使用: 根据需要选择并加载插件,避免不必要的依赖。
- 样式定制: 使用预加载的样式和区域设置,或自定义样式以满足特定需求。
- 错误处理: 在解析和格式化过程中添加错误处理逻辑,确保程序的健壮性。
典型生态项目
- citeproc-js: Citation Style Language (CSL) 的权威实现,也被 Citation.js 使用。
- Zotero: 一个参考文献管理应用程序,具有广泛的解析器和抓取器。
- JabRef: 一个基于 BibTeX 的参考文献管理器。
- Better BibTeX: 一个 BibTeX 解析器,输出 CSL-JSON。
通过这些生态项目,Citation.js 能够与多种参考文献管理工具和格式进行交互,提供全面的参考文献解决方案。