format-citations
关于
This skill formats academic citations for multiple styles (APA, Chicago, etc.) and generates reference lists using CSL processors and R tooling like citeproc and Quarto. It's used when rendering Quarto/R Markdown documents, converting bibliographies between styles, or setting up project citation infrastructure. Developers should use it to automate and validate citation formatting against official style guides.
快速安装
Claude Code
推荐npx skills add pjt222/agent-almanac -a claude-code/plugin add https://github.com/pjt222/agent-almanacgit clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/format-citations在 Claude Code 中复制并粘贴此命令以安装该技能
技能文档
Format Citations
Format citations across academic styles using CSL (Citation Style Language) processors and R tooling. This skill covers converting BibTeX entries into properly formatted in-text citations and reference lists for APA 7, Chicago, Vancouver, IEEE, and custom styles. It leverages Pandoc's citeproc, the knitcitations package, and Quarto's native citation engine for reproducible document production.
When to Use
- Rendering an R Markdown or Quarto document with formatted citations
- Converting a bibliography from one citation style to another
- Generating a standalone reference list from a .bib file
- Validating that in-text citations match a specific style guide
- Setting up citation infrastructure for a multi-document project (book, thesis)
Inputs
- Required: A .bib file (or other bibliography source recognized by Pandoc)
- Required: Target citation style (e.g.,
apa,chicago-author-date,ieee) - Optional: CSL file path (default: uses Pandoc built-in styles)
- Optional: Output format (
html,pdf,docx; default: inferred from document) - Optional: Locale for language-specific formatting (default:
en-US)
Procedure
Step 1: Verify Citation Infrastructure
# Check Pandoc availability (required for citeproc)
pandoc_path <- Sys.which("pandoc")
if (!nzchar(pandoc_path)) {
pandoc_path <- Sys.getenv("RSTUDIO_PANDOC")
}
stopifnot("Pandoc not found" = nzchar(pandoc_path))
message(sprintf("Pandoc: %s", system2(pandoc_path, "--version", stdout = TRUE)[1]))
# Check for citeproc support
citeproc_ok <- any(grepl("citeproc", system2(pandoc_path, "--list-extensions", stdout = TRUE)))
message(sprintf("Citeproc: %s", ifelse(citeproc_ok, "built-in", "external needed")))
Got: Pandoc version 2.11+ detected with built-in citeproc support.
If fail: Install Pandoc or set RSTUDIO_PANDOC in .Renviron to point to
the RStudio-bundled Pandoc. Quarto also ships its own Pandoc.
Step 2: Configure Document YAML for Citations
For R Markdown:
---
title: "My Document"
bibliography: references.bib
csl: apa.csl
link-citations: true
output:
html_document:
pandoc_args: ["--citeproc"]
---
For Quarto:
---
title: "My Document"
bibliography: references.bib
csl: apa.csl
link-citations: true
cite-method: citeproc
---
Got: YAML header correctly references the .bib file and CSL style.
If fail: If the CSL file is not found, download it from the CSL repository (see Step 3) and place it in the project directory.
Step 3: Obtain CSL Style Files
# Common CSL styles and their repository names
csl_styles <- list(
apa = "apa.csl",
chicago = "chicago-author-date.csl",
vancouver = "vancouver.csl",
ieee = "ieee.csl",
nature = "nature.csl",
harvard = "harvard-cite-them-right.csl",
mla = "modern-language-association.csl"
)
download_csl <- function(style, dest_dir = ".") {
base_url <- "https://raw.githubusercontent.com/citation-style-language/styles/master"
filename <- csl_styles[[style]]
if (is.null(filename)) stop(sprintf("Unknown style: %s", style))
dest <- file.path(dest_dir, filename)
utils::download.file(
url = sprintf("%s/%s", base_url, filename),
destfile = dest, quiet = TRUE
)
message(sprintf("Downloaded %s to %s", filename, dest))
dest
}
# Download APA 7 style
download_csl("apa")
Got: CSL file downloaded to the project directory.
If fail: Check network connectivity. The CSL GitHub repository contains 10,000+ styles. For offline use, bundle required CSL files in the project.
Step 4: Write In-Text Citations
Use Pandoc citation syntax in your document body:
<!-- Single citation -->
According to @Smith2020, the method improves accuracy.
<!-- Parenthetical citation -->
The method improves accuracy [@Smith2020].
<!-- Multiple citations -->
Several studies confirm this [@Smith2020; @Jones2021; @Lee2022].
<!-- Citation with page number -->
As noted by @Smith2020 [p. 42], the results are significant.
<!-- Suppress author name -->
The results are significant [-@Smith2020].
<!-- Citation with prefix -->
[see @Smith2020, pp. 42-45; also @Jones2021, ch. 3]
Got: Pandoc/Quarto renders these into properly formatted citations in the
target style (e.g., (Smith, 2020) for APA, (Smith 2020) for Chicago).
Step 5: Generate Standalone Reference Lists with R
# Using RefManageR to print formatted references
library(RefManageR)
BibOptions(style = "text", bib.style = "authoryear", sorting = "nyt")
bib <- ReadBib("references.bib", check = FALSE)
# Print all entries in text format
print(bib)
# Format specific entries
print(bib[author = "Smith"])
# Generate markdown reference list programmatically
format_reference_list <- function(bib, style = "apa") {
BibOptions(style = "text", bib.style = "authoryear")
entries <- capture.output(print(bib))
entries <- entries[nzchar(trimws(entries))]
paste(sprintf("- %s", entries), collapse = "\n")
}
cat(format_reference_list(bib))
Got: Formatted reference list printed to console or captured as character vector for further processing.
Step 6: Convert Between Citation Styles
# Render the same document in different styles
styles <- c("apa", "chicago", "ieee")
for (style in styles) {
csl_file <- download_csl(style)
output_file <- sprintf("output_%s.html", style)
rmarkdown::render(
input = "document.Rmd",
output_file = output_file,
params = list(csl = csl_file),
quiet = TRUE
)
message(sprintf("Rendered %s with %s style", output_file, style))
}
For Quarto:
quarto render document.qmd --metadata csl:apa.csl -o output_apa.html
quarto render document.qmd --metadata csl:ieee.csl -o output_ieee.html
Got: Multiple output files, each with the same content formatted in a different citation style.
If fail: If rendering fails, check that all citation keys in the document body exist in the .bib file. Missing keys produce warnings but may break formatting.
Step 7: Validate Citation Formatting
# Check for undefined citations in rendered output
validate_citations <- function(rmd_file, bib_file) {
# Extract citation keys from document
doc_text <- readLines(rmd_file, warn = FALSE)
doc_keys <- unique(unlist(regmatches(
doc_text,
gregexpr("@([A-Za-z][A-Za-z0-9_:.#$%&+-?<>~/]*)", doc_text)
)))
doc_keys <- gsub("^@", "", doc_keys)
# Remove false positives (email-like patterns)
doc_keys <- doc_keys[!grepl("\\.", doc_keys)]
# Extract keys from .bib file
bib <- RefManageR::ReadBib(bib_file, check = FALSE)
bib_keys <- names(bib)
# Find mismatches
undefined <- setdiff(doc_keys, bib_keys)
unused <- setdiff(bib_keys, doc_keys)
list(
undefined = undefined,
unused = unused,
cited = intersect(doc_keys, bib_keys)
)
}
result <- validate_citations("document.Rmd", "references.bib")
if (length(result$undefined) > 0) {
warning(sprintf("Undefined citation keys: %s",
paste(result$undefined, collapse = ", ")))
}
if (length(result$unused) > 0) {
message(sprintf("Unused .bib entries: %s",
paste(result$unused, collapse = ", ")))
}
Got: Report of undefined keys (cited but not in .bib), unused entries (in .bib but never cited), and valid citations.
If fail: False positives may occur with email addresses or code containing @.
Refine the regex or manually review flagged keys.
Validation
- Document renders without citation warnings from Pandoc/citeproc
- All
@keyreferences in the document resolve to .bib entries - Reference list appears at the end of the document (or in
div#refs) - In-text citations match the target style format
- Citation sorting follows style rules (alphabetical for APA, numbered for IEEE)
- Hyperlinks from in-text citations to reference list entries work (if
link-citations: true)
Pitfalls
- Missing CSL file: Pandoc falls back to Chicago author-date if no CSL is
specified. Always set
csl:explicitly for style consistency - Citation key typos: A misspelled key like
@Smtih2020silently renders as literal text. Enable Pandoc warnings with--verboseto catch these - Locale-dependent formatting: APA requires "and" between authors in English
but "und" in German. Set
lang:in the YAML header to match - nocite for uncited entries: To include entries in the reference list without
citing them in text, add
nocite: '@*'(all) ornocite: '@key1, @key2'to YAML - CSL version mismatch: Some older CSL 0.8 files are incompatible with modern Pandoc. Always use CSL 1.0+ from the official repository
- Quarto vs R Markdown differences: Quarto uses
cite-method: citeprocby default; R Markdown may need explicitpandoc_args: ["--citeproc"]
Related Skills
manage-bibliography- create and maintain the .bib files this skill consumesvalidate-references- verify .bib entry completeness before formatting../reporting/format-apa-report- full APA report formatting beyond citations../reporting/create-quarto-report- Quarto document setup with citation support
GitHub 仓库
相关推荐技能
content-collections
元Content Collections 是一个 TypeScript 优先的构建工具,可将本地 Markdown/MDX 文件转换为类型安全的数据集合。它专为构建博客、文档站和内容密集型 Vite+React 应用而设计,提供基于 Zod 的自动模式验证。该工具涵盖从 Vite 插件配置、MDX 编译到生产环境部署的完整工作流。
polymarket
元这个Claude Skill为开发者提供完整的Polymarket预测市场开发支持,涵盖API调用、交易执行和市场数据分析。关键特性包括实时WebSocket数据流,可监控实时交易、订单和市场动态。开发者可用它构建预测市场应用、实施交易策略并集成实时市场预测功能。
creating-opencode-plugins
元该Skill帮助开发者创建OpenCode插件,用于接入命令、文件、LSP等25+种事件。它提供了插件结构、事件API规范和JavaScript/TypeScript实现模式,适合需要拦截操作、扩展功能或自定义事件处理的场景。开发者可通过它快速构建响应式模块来增强OpenCode AI助手的能力。
sglang
元SGLang是一个专为LLM设计的高性能推理框架,特别适用于需要结构化输出的场景。它通过RadixAttention前缀缓存技术,在处理JSON、正则表达式、工具调用等具有重复前缀的复杂工作流时,能实现极速生成。如果你正在构建智能体或多轮对话系统,并追求远超vLLM的推理性能,SGLang是理想选择。
