前言

概述

学术文章的前言部分比仅包含标题和作者需要更多的细节。Quarto 提供了一组丰富的 YAML 元数据键来描述这些细节。在本页中，您将学习如何指定作者及其所属机构、文章摘要（如摘要和关键词），以及如何包含版权、许可和资金信息。

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

document.qmd

---
title: "迈向高能形而上学统一理论：愚蠢字符串理论"
date: 2008-02-29
author:
  - name: 乔赛亚·卡贝里
    id: jc
    orcid: 0000-0002-1825-0097
    email: josiah@psychoceramics.org
    affiliation: 
      - name: 布朗大学
        city: 普罗维登斯
        state: 罗德岛州
        url: www.brown.edu
abstract: > 
  斯通的著作的显著主题是文化与社会之间的桥梁。...
keywords:
  - 形而上学
  - 字符串理论
license: "CC BY"
copyright: 
  holder: 乔赛亚·卡贝里
  year: 2008
citation: 
  container-title: 心理陶瓷学杂志
  volume: 1
  issue: 1
  doi: 10.5555/12345678
funding: "作者未为此工作获得特定资金。"
---

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

JATS
HTML

上述元数据文档的 JATS 预览截图。

上述元数据文档的 HTML 预览截图。

并非所有元数据键在每种格式中都会用到。然而，本页描述的标签通常会在期刊文章格式中得到支持。目前，JATS 格式使用了最广泛的元数据标签集，因此如果您想查看渲染效果，我们建议使用 format: jats 进行预览。

作者与所属机构

描述作者的最简单方法是直接在 author 键上使用字符串：

---
author: 诺拉·琼斯
---

然而，author 键有许多子键，提供了学术文章所需的额外细节。例如，您可以使用 affiliation 键添加作者的所属机构。在最简单的形式中，作者及其所属机构可以通过将字符串传递给 name 和 affiliation 来描述：

---
author:
  name: 诺拉·琼斯
  affiliation: 卡内基梅隆大学
---

您可以在下面的作者和所属机构部分中了解可以提供给 author 和 affiliation 的其他键。

author 和 affiliation 都可以接受多个元素来描述多个作者或具有多个所属机构的作者。例如，以下是描述具有两位作者的文档的 YAML，其中第一位作者有两个所属机构：

---
author:
  - name: 诺拉·琼斯
    affiliation: 
      - 卡内基梅隆大学
      - 芝加哥大学
  - name: 乔赛亚·卡贝里
    affiliation: 布朗大学
---

请注意，author 和 affiliation 的每个元素前面都有一个 - 并适当缩进。您可以在下面的多位作者部分中了解更多关于避免重复的快捷方式。

单数还是复数？

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

作者

除了 name 和 affiliation，author 还可以接受以下任何一项：

`author` 可用的键
`email` `phone` `fax` `url`	字符串	作者的联系方式。在许多格式中会转换为超链接。
`degrees`	string(s)	个人姓名后显示的学位或专业认证。 \|
`orcid`	string	作者的开放研究人员和贡献者ID（ORCID），格式为`0000-0000-0000-0000`。在多种格式中创建指向作者ORCID的链接。 \|
`note` `acknowledgements`	string	附加到作者的注释，例如贡献细节； \| 作者的致谢。 \|
`roles`	string(s)	作者的角色。更多信息请参见下面的作者角色。 \|
`corresponding` `equal-contributor` `deceased`	`true`/`false`	将此作者设置为： \| 通讯作者； \| 与其他所有贡献者同等贡献； \| 和/或已故。 \|
`id`	string	用于在其他字段中引用此作者的标识符。示例参见资助。 \|

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
---

姓名组成部分

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

作者角色

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

author:
  - name: Josiah Carberry
    roles: "构思并设计了研究，分析了结果并撰写了手稿。"

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

author:
  - name: 约西亚·卡贝里
    roles: 概念化

或者，角色数组：

author:
  - name: 约西亚·卡贝里
    roles: [调查, 数据管理]

或者指定角色及其贡献程度：

author:
  - name: 约西亚·卡贝里
    roles: 
      - 调查: 主要 
      - 数据管理: 支持

展开查看14个贡献者角色

CRediT贡献者角色值可用于`roles`
值	别名
概念化
数据管理
形式分析	分析
资金获取	资金
调查
方法
项目管理
资源
软件
监督
验证
可视化
写作 – 审查与编辑	编辑
写作 – 原始稿	写作

隶属关系

与author类似，你可以直接提供字符串给affiliation，例如：

---
author:
  name: 诺拉·琼斯
  affiliation: 卡内基梅隆大学
---

或者，你可以明确地将名称提供给name键，例如：

---
author:
  name: 诺拉·琼斯
  affiliation: 
    name: 卡内基梅隆大学
---

除了name，affiliation还可以接受以下任何一项：

`affiliation`可用的键
`department`	字符串
`group`	字符串	隶属关系内的团队或研究组 \|
`address` `city` `region` 或 `state` `country` `postal-code`	字符串	隶属关系的位置。提供`region`或`state`之一，以及任何其他键的组合。 \|
`url`	字符串	隶属关系的网站。在许多格式中转换为链接。
`isni` `ringgold` `ror`	\| 隶属关系ID： \| 数字 \| 16位国际标准名称标识符（ISNI）； \| 数字 \| 4-6位数字的Ringgold ID； \| 字符串 \| 研究机构注册(ROR) ID，以`https://ror.org/`开头， \| \| 后跟一个9位字母数字标识符。 \|

例如，作者的更完整的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
---

多作者

当文档有多位作者时，他们通常共享机构。为了避免重复机构的详细信息，你可以描述一次机构，为其分配一个id，然后在其他字段中引用该id。

一种方法是为其描述的每个机构分配一个id。例如，这里我们为作者的机构分配了id cmu和chicago：

---
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键添加摘要。由于摘要通常比一行长，并且可能包含markdown，因此你需要使用YAML的文字块样式来提供它。也就是说，将|放在与abstract:相同的行上，并将你的原始摘要文本缩进两个空格。

例如：

---
abstract: |
  本文评估了实现一些非常重要事情的新方法。
---

关键词

可以使用keywords添加关键词：

---
keywords: 
  - 开源 
  - 科学出版
  - 可重复研究
---

版权

你可以通过两种方式指定版权。直接作为字符串传递给copyright：

---
copyright: "版权所有 Acme, Inc. 2021. 保留所有权利"
---

这等同于将相同的字符串提供给statement子键：

---
copyright: 
  statement: "版权所有 Acme, Inc. 2021. 保留所有权利"
---

或者，通过指定holder和year：

---
copyright: 
  holder: Acme, Inc
  year: 2021
---

在指定year时，你也可以使用范围(year: 2021 - 2023)或数组(year: [2021, 2022, 2023])。

许可证

要指定许可证，你可以直接将字符串传递给license：

---
license: "本作品献给公共领域"
---

这等同于直接指定text子键：

---
license:
  text: "本作品献给公共领域"
---

你可以通过提供type和url子键来添加更多细节：

---
license:
  text: > 
    根据GNU自由文档许可证第1.3版或任何后续版本的条款，授予复制、分发和/或修改本文档的许可；
    没有不变章节，没有封面文字，也没有封底文字。许可证的副本包含在名为“GNU自由文档许可证”的部分中
  type: 开放获取
  url: https://www.gnu.org/licenses/fdl-1.3-standalone.html
---

如果你选择Creative Commons许可证，你可以简单地传递一个缩写：

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

下面Creative Commons部分中涵盖了可用的缩写。

Creative Commons

以下是一些常见的 Creative Commons 内容许可形式：

许可	名称	描述
`CC BY`	署名 \| 该许可允许他人以商业目的分发、混音、调整和基于您的作品进行创作，只要他们为您提供原始创作的署名。这是提供的最宽松的许可。
`CC BY-SA`	署名-相同方式共享 \| 该许可允许他人以商业目的混音、调整和基于您的作品进行创作，只要他们为您提供署名并以相同条款许可他们的新作品。此许可常被比作“copyleft”自由和开源软件许可。基于您作品的所有新作品都将采用相同的许可，因此任何衍生作品也将允许商业使用。 \|
`CC BY-ND`	署名-禁止演绎 \| 该许可允许以商业和非商业目的重新分发，只要作品保持不变且完整地传递，并为您提供署名。 \|
`CC BY-NC`	署名-非商业性使用 \| 该许可允许他人以非商业目的混音、调整和基于您的作品进行创作，尽管他们的新作品也必须为您提供署名且为非商业性，但他们不需要以相同条款许可他们的衍生作品。 \|

`CC BY-NC-SA`	署名-非商业性使用-相同方式共享	该许可证允许他人在非商业基础上对你的作品进行混音、改编和构建，前提是他们必须给你署名，并在相同条款下许可他们的新创作。 \|
`CC BY-NC-ND`	署名-非商业性使用-禁止演绎	该许可证是六大主要许可证中最严格的，仅允许他人下载你的作品并与他人分享，前提是他们必须给你署名，但他们不能以任何方式改变作品或将其用于商业用途。 \|

如果你为你的内容指定了一个Creative Commons许可证，Quarto将自动包含相关许可证的适当链接。

引用

citation键允许你指定用于创建文档引用的附加元数据。你可以在创建可引用文章中了解更多关于这方面的信息。

资助

funding键可以直接接受一个字符串：

---
funding: "作者未为此工作获得特定资助。"
---

这等同于直接提供statement子键：

---
funding: 
  statement: "作者未为此工作获得特定资助。"
---

funding键还可以接受子键source、recipient和investigator。recipient和investigator都可以接受字符串，或者使用ref:引用作者或机构。例如，这个前页添加了资助，其中调查者使用作者ID指定：

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