创建可引用的文章

通过在文章的 YAML 前言中提供额外的元数据,你可以使其他人更容易引用你的工作。无论是发布到网络上的文章还是发表在期刊上的文章(无论是否有 DOI),都可以提供引用信息。

网络文章

要为发布到网络上的文章提供引用信息,请包含作者和日期元数据以及引用 URL。例如:

---
title: "总结可重复文档的输出"
description: | 
  总结可重复科学文档输出的最佳实践概述。
date: 2018/5/4
author:
  - name: 诺拉·琼斯 
    url: https://example.com/norahjones
    affiliation: 斯帕塞利·斯普罗凯茨
    affiliation-url: https://example.com/spacelysprockets
citation:
  url: https://example.com/summarizing-output
bibliography: biblio.bib
---

名称部分可以根据 Citation Style Language (CSL) 规范name 键中进一步定义。如果你省略了引用 URL,Quarto 将尝试通过使用 site-url 和当前页面的位置来生成引用 URL。如果你想让 Quarto 生成引用 URL,你可以省略引用 URL 并在页面上简单地启用引用输出。例如:

---
title: "总结可重复文档的输出"
description: | 
  总结可重复科学文档输出的最佳实践概述。
date: 2018/5/4
author:
  - name: 诺拉·琼斯 
    url: https://example.com/norahjones
    affiliation: 斯帕塞利·斯普罗凯茨
    affiliation-url: https://example.com/spacelysprockets
citation: true
bibliography: biblio.bib
---

当这些元数据可用时,引用附录会自动添加到文章中。引用附录将提供文档的可复制 bibtex 表示形式和格式化的引用表示形式(基于文档的 CSL 文件,如果指定的话)。例如:

引用附录的外观,包含 BibTeX 引用和纯文本引用,用于归属。

默认情况下,bibtex 和格式化的表示形式都会显示。你可以使用 appendix-cite-as 选项来控制此行为:

appendex-cite-as: false 不在附录中包含任何引用。 |
appendix-cite-as: bibtex 仅显示引用的 BibTeX 版本。 |
appendix-cite-as: display 仅显示引用的显示版本。 |

期刊文章

如果你的文章发表在期刊上,你可以添加以下额外字段以生成适当的引用条目:

---
title: "总结可重复文档的输出"
description: | 
  总结可重复科学文档输出的最佳实践概述。
date: 2018/5/4
author:
  - name: 诺拉·琼斯 
    url: https://example.com/norahjones
    affiliation: 斯帕塞利·斯普罗凯茨
    affiliation-url: https://example.com/spacelysprockets
citation:
  type: article-journal
  container-title: "数据科学软件杂志"
  doi: "10.23915/reprodocs.00010"
  url: https://example.com/summarizing-output
bibliography: biblio.bib
---

这是引用在附录中的呈现方式:

期刊引用在文档附录中的外观,包含 BibTex 和纯文本引用,用于归属。

其他类型的文档

文档中显示的 BibTeX 和格式化归属将基于 citation 键中存在的完整引用信息生成,该信息基于 Citation Style Language (CSL) 规范。你可以在 引用元数据参考 中了解更多可用选项。

Google Scholar

Quarto 文档可以包含与 Google Scholar 索引格式兼容的元数据。这使得索引引擎(Google Scholar 或其他)不仅可以提取你文章的引用,还可以提取你引用的其他来源的信息。要启用此功能,请使用 google-scholar 选项:

title: "总结可重复文档的输出"
description: | 
  总结可重复科学文档输出的最佳实践概述。
date: 2018/5/4
author:
  - name: 诺拉·琼斯 
    url: https://example.com/norahjones
    affiliation: Spacely Sprockets
    affiliation-url: https://example.com/spacelysprokets
citation:
  type: 期刊文章
  container-title: "数据科学软件杂志"
  doi: "10.23915/reprodocs.00010"
  url: https://example.com/summarizing-output
bibliography: biblio.bib 
google-scholar: true

例如,以下是使用上述元数据创建的文档自动包含的Google Scholar元数据:

<meta name="citation_title" content="可重复文档的输出总结">
<meta name="citation_author" content="诺拉·琼斯">
<meta name="citation_online_date" content="2018-05-04">
<meta name="citation_fulltext_html_url" content="https://example.com/summarizing-output">
<meta name="citation_publication_date" content="2018-05-04">
<meta name="citation_journal_title" content="数据科学软件杂志">
<meta name="citation_reference" content="citation_title=唐纳德·克努特;,citation_fulltext_html_url=http://dx.doi.org/10.7551/mitpress/
5485.003.0041;,citation_publication_date=1989;,citation_journal_title
=未定义;">

除了上述文档的引用元数据外,Quarto还将自动为文档参考文献中的每个条目生成一个citatation_reference条目。

引用字段

Quarto在生成学术元数据时的方法是采用标准CSL字段,并将它们转换为相应的Google Scholar/Zotero/Highwire元数据标签(如果适用)。在文档元数据的citation键下指定的以下字段,将根据描述在渲染的HTML文档中生成学术元标签。这些字段包括Google Scholar所需的必填字段以及可能包含的其他可选字段。

文档Yaml 元数据标签
title  | citation_title 如果未提供,将使用文档的title |
author  | citation_author 一个或多个作者1。如果未作为引用子键提供,将使用文档的author |
editor
一个或多个编辑2
citation_editor
abstract  | citation_abstract 如果未提供,将使用文档的abstract |
关键词3  | 引用关键词 如果未提供,将使用文档的关键词 | |
发布日期  | 引用出版日期 如果未提供,将使用文档的日期 | | | 此外,发布日期将用于填充以下字段:  | |
| 引用封面日期
| 引用年份
可用日期  | 引用在线日期 如果未提供,将使用文档的日期 | |
网址  | 引用全文HTML网址 如果已指定站点网址,将为当前文档合成网址 |
PDF网址 引用PDF网址
语言  | 引用语言 如果未提供,将使用文档的语言 | |
类型  | <无> | 有效的CSL类型。参见https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types. | |
doi  | 引用_doi | 如果未提供,将使用文档的doi | |
isbn 引用_isbn |
issn 引用_issn |
eissn 引用_eissn |
pmid 引用_pmid |
issue 引用_issue |
volume 引用_volume |
page  | 引用_firstpage | 将在-上拆分以创建适当的页面元数据。 | | | citation_lastpage
page-first citation_firstpage
page-last citation_lastpage
abstract-url citation_abstract_html_url
container-title

citation_journal_title

对于特定类型,将生成其他元标签: |

  • 类型: paper-conference
    citation_conference_title

  • 类型: book
    citation_book_title

  • 类型: chapter
    citation_inbook_title

number

citation_technical_report_number

citation_technical_report_number 将在类型为报告时创建。 |

publisher

citation_publisher

对于特定类型,将生成其他元标签: |

  • 类型:paper-conference  | citation_conference

  • 类型:thesis
    citation_dissertation_institution

  • 类型:report
    citation_technical_report_institution

container-title-short citation_journal_abbrev
collection-title citation_series_title

例如,在文档前文中定义的已发表会议论文的引用数据:

title: A Published Conference Paper
author:
  - name: Norah Jones
    affiliation: School of Hard Knocks
    orcid: 0000-0001-8715-9476
citation:
  type: paper-conference
  container-title: "Proceedings of the annual conference of the Society for Research"
  publisher: "Society for Research"
  issued: 2020/09/23
  volume: 2
  doi: "10.23915/reprodocs.00010"
  url: https://example.com/summarizing-output
  page-first: 46
  page-last: 53
  editor:
  - Don Draper
  - Nick Fury
google-scholar: true  

提供了如下HTML元数据:

<meta name="citation_title" content="A Published Conference Paper">
<meta name="citation_author" content="Norah Jones">
<meta name="citation_editor" content="Nick Cage">
<meta name="citation_editor" content="Don Draper">
<meta name="citation_publication_date" content="2020-09-23">
<meta name="citation_cover_date" content="2020-09-23">
<meta name="citation_year" content="2020">
<meta name="citation_fulltext_html_url" content="https://example.com/summarizing-output">
<meta name="citation_doi" content="10.23915/reprodocs.00010">
<meta name="citation_volume" content="2">
<meta name="citation_language" content="en">
<meta name="citation_conference_title" content="Proceedings of the annual conference of the Society for Research">
<meta name="citation_conference" content="Society for Research">

Footnotes

  1. 使用以下任一方式指定一个或多个作者:

    author: Norah Jones

    或多个值:

    author:
    -   Norah Jones
    -   Nick Fury

    在生成HTML元数据时,引用键下提供的作者列表将替代文档作者。↩︎

  2. 使用以下任一方式指定一个或多个编辑:

    editors: Norah Jones

    或多个值:

    editors:
    -   Norah Jones
    -   Nick Fury
    ↩︎
  3. 请注意,keyword 引用字段是一个由逗号分隔的关键词字符串(与CSL一致)。↩︎