封面

概述

学术文章的封面需要更多细节，而不仅仅是标题和作者。Quarto 提供了一套丰富的 YAML 元数据键来描述这些细节。在本页中，您将了解如何指定作者及其所属单位、文章摘要（如摘要和关键词），以及如何包含版权、许可和资金信息。

此 YAML 标头包含本页讨论的所有顶级键的示例：

document.qmd
---
title: "Toward a Unified Theory of High-Energy Metaphysics: Silly String Theory"
date: 2008-02-29
author:
  - name: Josiah Carberry
    id: jc
    orcid: 0000-0002-1825-0097
    email: josiah@psychoceramics.org
    affiliation: 
      - name: Brown University
        city: Providence
        state: RI
        url: www.brown.edu
abstract: > 
  The characteristic theme of the works of Stone is 
  the bridge between culture and society. ...
keywords:
  - Metaphysics
  - String Theory
license: "CC BY"
copyright: 
  holder: Josiah Carberry
  year: 2008
citation: 
  container-title: Journal of Psychoceramics
  volume: 1
  issue: 1
  doi: 10.5555/12345678
funding: "The author received no specific funding for this work."
---

通过上述元数据生成的 HTML 和 JATS 格式文件如下所示。

Screenshot of the JATS preview from the document with the above metadata.

Screenshot of the HTML preview from the document with the above metadata.

并非每种格式都使用所有元数据键。不过，期刊文章格式一般都支持本页描述的标记。目前，JATS 格式使用了最广泛的元数据标记集，因此如果您想查看渲染效果，建议使用 format: jats 进行预览。

作者和所属

描述作者的最简单方法是直接在 author 键上输入一个字符串：

---
author: Norah Jones
---

不过，作者 键有许多子键，可提供学术文章所需的额外细节。例如，您可以使用 affiliation 键添加作者的所属单位。在最简单的形式中，可以通过向name和affiliation各传递一个字符串来描述作者及其所属单位：

---
author:
  name: Norah Jones
  affiliation: Carnegie Mellon University
---

您可以在下面相应的 Author 和 Affiliation 章节中阅读有关您可以为 author 和 affiliation 提供的其他键的信息。

Both author and affiliation都可以包含多个元素，以描述多个作者或具有多个所属关系的作者。例如，下面的 YAML 描述了一个有两个作者的文档，其中第一个作者有两个所属单位：

---
author:
  - name: Norah Jones
    affiliation: 
      - Carnegie Mellon University
      - University of Chicago
  - name: Josiah Carberry
    affiliation: Brown University
---

请注意，author and affiliation的每个元素前都有一个”-“，并适当缩进。您可以在下面的Multiple Authors部分阅读更多有关作者共享隶属关系时避免重复的快捷方式。

Singular or Plural?

这两个键都可以使用单数（author and affiliation）或复数（authors and affiliations）形式指定。

Author

除了 name and affiliation外，author还可以使用以下任何一项：

Available keys to author
email
phone
fax
url		 string Contact details for the author. Converted to hyperlinks in many formats.
degrees string(s) Academic titles or professional certifications displayed following a personal name.
orcid string Author’s Open Researcher and Contributor ID (ORCID), in the form 0000-0000-0000-0000. Creates a link to the author’s ORCID in many formats.
note
acknowledgements		 string Notes to attach to an author, such as contribution details;
Author’s acknowledgements.
roles string(s) Author’s roles. Read more in Author Roles below.
corresponding
equal-contributor
deceased		 true/false Set this author as:
the corresponding author;
as having contributed equally with all other contributors;
and/or deceased.
id string An identifier to be used to refer to this author in other fields. See an example in [Funding].

也可以向 author“提供 affiliations-url键，该键将传播到 affiliation的 url键。

举例来说，对作者更完整的描述可能如下：

---
author:
  - name: Josiah Carberry
    orcid: 0000-0002-1825-0097
    url: https://en.wikipedia.org/wiki/Josiah_S._Carberry
    email: josiah@psychoceramics.org
    corresponding: true
---

名称组件 | Name Components

Quarto 会自动将 name 键解析为其组件。 但是，如果解析不正确，您可以直接指定given、family、dropping-particle和non-dropping-particle等组件：

---
author: 
  - name: 
      given: Charles
      family: Gaulle
      non-dropping-particle: de
  - name: 
      given: Ludwig
      family: Beethoven
      dropping-particle: van
---

学位

可以使用作者的 degrees 字段指定学位或学术头衔：

author:
  - name: Josiah Carberry
    degrees: 
      - B.S.
      - PhD

Author Roles

使用 roles 来描述作者对作品的贡献。您可以使用自由格式文本作为字符串：

author:
  - name: Josiah Carberry
    roles: "Conceived and designed the study, analysed the results and wrote the manuscript."

或者使用贡献者角色分类标准（CRediT）。 要使用 CRediT 角色，请提供 14 个贡献者 角色之一，例如：

author:
  - name: Josiah Carberry
    roles: conceptualization

或者，一系列角色：

author:
  - name: Josiah Carberry
    roles: [investigation, data curation]

或具体说明角色和贡献程度：

author:
  - name: Josiah Carberry
    roles: 
      - investigation: lead 
      - data curation: supporting

Affiliation

与 author一样，您也可以直接为 affiliation 提供一个字符串，如

---
author:
  name: Norah Jones
  affiliation: Carnegie Mellon University
---

或者，您也可以向 name 键明确提供名称，如

---
author:
  name: Norah Jones
  affiliation: 
    name: Carnegie Mellon University
---

除了 name 以外，affiliation 还可以包含以下任何内容：

Available keys to affiliation
department String
group String Team or research group within the affiliation
address
city
region or state
country
postal-code		 String Affiliation’s location. Provide one of region or state, and any combination of the other keys.
url String Affiliation’s website. Converted to a link in many formats.

isni
ringgold
ror
Numeric
Numeric
String		 Affiliation IDs:
16 digit International Standard Name Identifier (ISNI);
4-6 digit Ringgold ID;
Research Organization Registry (ROR) ID, starting with https://ror.org/, followed by a 9 digit alphanumeric identifier.

例如，一个作者更完整的 affiliation(隶属关系) 可能是这样的：

---
author:
  name: Josiah Carberry
  orcid: 0000-0002-1825-0097
  url: https://en.wikipedia.org/wiki/Josiah_S._Carberry
  email: josiah@psychoceramics.org
  corresponding: true
  affiliation: 
    - name: Brown University
      department: Psychoceramics
      city: Providence
      state: RI
      country: US
      url: www.brown.edu
      ringgold: 6752
      isni: 0000000419369094
---

Multiple Authors

当一篇文档有多个作者时，他们通常会共享隶属关系。为了避免重复隶属关系的细节，可以先描述一次隶属关系，为其分配一个 id，然后在其他字段中引用该 id。

一种方法是为作者中描述的每个从属关系分配一个 id。例如，在这里我们为作者的从属关系分配了 cmu 和 ichicago id：

---
author:
  - name: Norah Jones
    affiliation:
      - id: cmu
        name: Carnegie Mellon University
      - id: chicago
        name: University of Chicago
---

然后，在添加其他作者时，您可以使用 ref: 引用隶属关系：

---
author:
  - name: Norah Jones
    affiliation:
      - id: cmu
        name: Carnegie Mellon University
      - id: chicago
        name: University of Chicago
  - name: John Hamm
    affiliation:
      - ref: cmu
---

另一种方法是在顶层定义从属关系，而不是在 author中定义从属关系：

---
author:
  - name: Norah Jones
    affiliation:
      - ref: cmu
      - ref: chicago
  - name: John Hamm
    affiliation:
      - ref: cmu
affiliations:
  - id: cmu
    name: Carnegie Mellon University
  - id: chicago
    name: University of Chicago
---

如果您还想在 author以外的字段中引用隶属关系，例如 funding(资助)，这种方法可能更方便。

摘要 | Abstract

您可以使用 abstract 键添加摘要。由于摘要通常长于一行，而且可能包含标记符，因此需要使用 YAML 的字面块样式来提供摘要。也就是说，在 abstract: 的同一行放置一个 |，并将原始摘要文本缩进两个空格。

例如:

---
abstract: |
  This article evaluates novel approaches to do
  some really important things.
---

关键字 | Keywords

可使用 keywords 添加关键词：

---
keywords: 
  - open-source 
  - scientific publishing
  - reproducible research
---

许可证 | License

要指定许可证，可以直接向 license 传递一个字符串：

---
license: "This work is dedicated to the Public Domain"
---

这相当于直接指定 text 子键：

---
license:
  text: "This work is dedicated to the Public Domain"
---

您可以通过提供 type 和 url 子键来添加其他详细信息：

---
license:
  text: > 
    允许复制、分发和/或 
    或修改本文档。
    文档许可证》1.3 版或自由软件基金会发布的任何后续版本的条款，允许复制、分发和/或修改本文档。
    自由软件基金会发布的 GNU 自由文档许可证第 1.3 版或任何更新版本的条款，复制和/或修改本文档。
    无不变章节、无封面文本、无封底文本。
    封底文本。许可证副本包含在 
    章节中包含了许可证的副本。
  type: open-access
  url: https://www.gnu.org/licenses/fdl-1.3-standalone.html
---

如果选择 “知识共享”许可协议，则只需通过缩写即可：

---
license: "CC BY"
---

下文知识共享部分介绍了可用缩写。

Creative Commons

知识共享(Creative Commons)版权许可协议和工具在版权法规定的 “all rights reserved”（保留所有权利 ）的传统框架内建立了一种平衡。从个人创作者到大型公司和机构，都可以通过这些工具以简单、标准化的方式为自己的创意作品授予版权许可。

以下是一些常见的知识共享内容许可形式：

License Name Description
CC BY Attribution 该许可证允许他人对你的作品进行发布、混音、调整和改编，甚至是商业性的改编，只要他们将你的原创归功于你。这是最宽松的许可证。
CC BY-SA Attribution-ShareAlike 这种许可证允许他人对你的作品进行混音、调整和改编，甚至用于商业目的，只要他们注明你的名字，并以相同的条款许可他们的新创作。这种许可通常与 “copyleft”自由和开源软件许可相提并论。所有以你的作品为基础的新作品都将使用相同的许可，因此任何衍生作品也允许用于商业用途。
CC BY-ND Attribution-NoDerivs 本许可证允许商业和非商业性的再分发，只要不作任何改动和完整地传递，并注明出处即可。
CC BY-NC Attribution-NonCommercial 这种许可允许他人在你的作品基础上进行非商业性的混音、调整和构建，尽管他们的新作品也必须承认你的存在，并且是非商业性的，但他们不必以同样的条款许可他们的衍生作品。
CC BY-NC-SA Attribution-NonCommercial-ShareAlike 该许可允许他人对您的作品进行非商业性的混音、改编和构建，只要他们注明您的名字，并根据相同的条款许可他们的新创作。
CC BY-NC-ND Attribution-NonCommercial-NoDerivs 该许可证是六种主要许可证中限制最严格的一种，只允许他人下载你的作品并与他人分享，只要他们注明你的名字，但他们不能以任何方式更改作品或将其用于商业用途。

如果您为内容指定了知识共享许可协议，Quarto 将自动包含指向相应许可协议的相关链接。

引文 | Citation

引用 “键允许您指定用于为文档创建引用的附加元数据。你可以在创建可引用文章中阅读更多相关信息。

资助 | Funding

funding 键可以直接使用字符串：

---
funding: "The author(s) received no specific funding for this work."
---

这相当于直接提供 statement 子键：

---
funding: 
  statement: "The author(s) received no specific funding for this work."
---

funding “键还可以包含子键 source, recipient and investigator.。recipient and investigator 都可以是一个字符串，也可以使用 ref: 引用作者或所属单位。例如，该前置事项添加了使用作者 ID 指定研究者的资金：

---
author:
  - name: Norah Jones
    id: nj
funding:
  - source: "NIH (Grant #: 1-R01-MH99999-01A1)"
    investigator: 
      - ref: nj
---