Pandoc 对 JATS 的支持

本文档描述了 pandoc 对 JATS 的处理。

元数据值

以下是提供的英文内容的中文翻译：

• abstract

  文章摘要。通过文档的前置事项通过 <abstract> 元素添加。

• author

  文章贡献者的列表。每个作者都应该列出姓氏和名字；如果作者没有姓氏，则该项将被用作贡献者的 字符串姓名。

  • orcid

    贡献者的 ORCID 标识符。

  • surname

    贡献者的姓氏。通常是西方名字中的家族姓氏。

    参见 <surname>。

  • given-names

    贡献者的个人名字；这包括西方名字风格中的中间名（如果有）。

    参见 <given-names>。

  • name

    作者的全名；仅在没有 author.surname 可用的情况下作为备选。标记为 <string-name>。

  • email

    贡献者的电子邮箱地址。

    用作 <email> 元素的内容。

  • affiliation

    可以是按照 affiliation 字段描述的完整隶属机构条目，或者是隶属机构标识符的列表。

    这些标识符链接到作者所属的组织。这个列表中的每个标识符也必须出现在顶级隶属机构列表中的某个隶属机构的 id 属性中。

    如果顶级隶属机构字段已设置，则认为此条目是一个标识符列表；如果没有设置，则认为这是一个完整的条目列表。

    如果使用了文章作者标签集，则必须给出完整的条目，因为该模式不允许使用隶属机构链接。

  • equal-contrib

    boolean 属性，用于标记对工作做出同等贡献的作者。如果设置为真值，则将 equal-contrib 属性设置为 yes 并添加到作者的 <contrib> 元素上。

  • cor-id

    标识符，用于链接到贡献者的通信信息。通信信息本身必须存储在 article.author-notes.corresp 中的一项里。如果设置了 cor-id 值，则会添加一个 ref-type corresp 的 <xref> 链接。rid 属性设置为 cor-<ID>，其中 <ID> 是该属性的字符串形式的值。

    此外，如果设置了此属性且其值为真值，则会在作者的 <contrib> 元素上将 corresp 属性设置为 yes。

• affiliation

  这是关于贡献者所关联机构列表的描述。每个机构都被添加为 <aff> 元素到作者的 contrib-group 中。

  字段按照它们在输出中出现的顺序给出。

  • id: 内部标识符；用作 <aff> 元素的 id 属性值，并且以 aff- 作为前缀。
  • group: 研究小组或其他低级别的组织结构名称；用作带有 content-type 设置为 group 的 <institution> 元素的值。
  • department: 部门或其他中级组织结构的名称；用作带有 content-type 设置为 dept 的 <institution> 元素的值。
  • organization: 公司、大学或其他顶级组织结构的名称；用作 <institution> 元素的值。该 <institution> 元素被包裹在一个 <institution-wrap> 元素中；任何标识符，如 ringgold 或 ror，都被添加到包裹器中并且必须属于这个组织（而非部门或小组）。
  • isni: 组织的国际标准名称标识符(ISNI)。通过带有 institution-id-type 设置为 ISNI 的 <institution-id> 元素添加。
  • ringgold: 组织的 Ringgold 标识符。通过带有 institution-id-type 设置为 Ringgold 的 <institution-id> 元素添加。
  • ror: 组织的研究组织注册标识符(ROR)。通过带有 institution-id-type 设置为 ROR 的 <institution-id> 元素添加。
  • pid: 持久标识符数组，这些标识符作为 <institution-id> 元素添加。每一项必须包含一个具有键 type 和 id 的映射，其中 type 用于 institution-id-type，而 id 用于元素的内容。
  • street-address: 组织的街道地址；每个列表项都包裹在一个 <addr-line> 元素中，并用逗号和空格分隔。
  • city: 组织所在的城市；仅当没有提供 street-address 时使用，此时值包裹在一个 <city> 元素中。
  • country: 组织所在的国家；用作 <country> 元素的值。
  • country-code: 两个字母的 ISO-3166-1 国家标识符；用作 <country> 元素的 [country] 属性（如果存在的话）。

• copyright

  版权和许可信息。这些信息是通过 <permissions> 元素呈现的。

  建议使用 license 字段（如下所述）来包含许可信息。如果许可信息包含在 copyright 下面，则变量 type、link 和 text 应该始终一起使用。

  • statement: 版权声明或通知；用作 <copyright-statement> 的内容。对于多个声明，请使用列表。
  • year: 版权的年份；用作 <copyright-year> 的内容。对于多个版权年份，请使用列表。JATS 文档指出，如果年份已经包含在版权声明中，则不必使用此字段。
  • holder: 版权持有者；通过 <copyright-holder> 元素包含。对于多个版权持有者，请使用列表。
  • text: 设置文本发布的许可条件的内联文本；通过 <license-p> 元素包含。
  • type: 许可类型；用作 license-type 属性的值。
  • link: 描述许可的外部链接；用作 <license> 元素中的 xlink:href 属性的值。

• date

  出版日期。这个值通常应该是一个日期的字符串表示形式。Pandoc 会解析并拆解这个日期成下面给出的各个组成部分。也可以直接传递这些组成部分。

  出版日期记录在文档中通过 <pub-date> 元素及其子元素。publication-format 属性总是设置为 electronic。

  • iso-8601: 出版日期的 ISO-8601 表示形式。用作 <pub-date> 元素的 iso-8601-date 属性的值。

    如果 Pandoc 能够将 date 值解析为日期，这个值会自动设置。

  • day, month, year: 出版日期的日、月和年。只需要出版年份。这些值用作相应名称元素的内容。

    如果 Pandoc 能够将 date 值解析为日期，这些值会自动设置。

  • type: 标记此日期事件的类型。该值设置为 <pub-date> 元素上的 date-type 属性，默认为 "pub"（如果未指定）。

• article

  关于文章的信息，用于识别或描述它。此映射中的键值对通常用于 <article-meta> 元素中。

  • publisher-id: 出版商分配的文章外部标识符。用作带有 pub-id-type 属性设置为 publisher-id 的 <article-id> 元素的内容。
  • doi: 分配给文章的数字对象标识符(DOI)。用作带有 pub-id-type 属性设置为 doi 的 <article-id> 元素的内容。
  • pmid: 分配给文章的 PubMed 标识符(PMID)。用作带有 pub-id-type 属性设置为 pmid 的 <article-id> 元素的内容。
  • pmcid: 分配给文章的 PubMed Central 标识符。用作带有 pub-id-type 属性设置为 pmcid 的 <article-id> 元素的内容。
  • art-access-id: 通用文章存取标识符。用作带有 pub-id-type 属性设置为 art-access-id 的 <article-id> 元素的内容。
  • heading: 描述文章的主题或话题名称。用作 <subject> 元素的内容，嵌套在一个带有 subj-group-type 属性为 heading 的 <subj-group> 元素中。
  • categories: 列出描述文章的主题或话题。每个项目都用作 <subject> 元素的内容，分组在一个带有 subj-group-type 属性设置为 categories 的单一 <subj-group> 元素中。
  • author-notes: 关于作者的附加信息，例如利益冲突声明和通讯作者联系信息。包裹在一个 <author-notes> 元素中。
    • conflict: 利益冲突声明。渲染为 <fn> 注脚元素，其 fn-type 为 conflict。
    • con: 由...贡献的信息。渲染为 <fn> 注脚元素，其 fn-type 为 con。
    • corresp: 通讯信息。这必须是一系列贡献者通讯项的列表，其中每一项必须具有属性 id 和 email。然后通过 <corresp> 元素来渲染这些信息。
  • funding-statement: 描述资助情况的文字。通过 funding-statement 元素添加到文章的前言部分。

• journal

  关于文章发表期刊的信息。这必须是一个映射；以下键值对被识别。

  • publisher-id: 出版商分配的期刊标识符。用作带有 journal-id-type 属性设置为 publisher-id 的 <journal-id> 元素的内容。
  • nlm-ta: PubMed 分配的期刊标识符。用作带有 journal-id-type 属性设置为 nlm-ta 的 <journal-id> 元素的内容。
  • pmc: PubMed Central 分配的期刊标识符。用作带有 journal-id-type 属性设置为 pmc 的 <journal-id> 元素的内容。
  • title: 发表文章的期刊全称。用作 <journal-title> 元素的内容。
  • abbrev-title: 期刊的简称。用作 <abbrev-journal-title> 元素的内容。
  • pissn: 刊物印刷版的 ISSN 标识符。用作带有 publication-format 属性设置为 print 的 <issn> 元素的内容。
  • eissn: 刊物电子版的 ISSN 标识符。用作带有 publication-format 属性设置为 electronic 的 <issn> 元素的内容。
  • publisher-name: 出版实体（个人、公司或其他）的名称。用作 <publisher-name> 元素的内容。
  • publisher-loc: 出版地点。用作 <publisher-loc> 元素的内容。

• license

  文章的许可信息。此字段的每一项都会被渲染为 <permissions> 元素内的 <license> 元素。

  项目内容可以是一个单独的段落，或者是一个包含以下字段的映射。

  • text: 描述文本发布许可条件的内联文本；通过 <license-p> 元素包含。
  • type: 许可类型；用作 license-type 属性的值。
  • link: 描述许可的外部链接；用作 <license> 元素中的 xlink:href 属性的值。

• notes

  关于整篇文章的额外注释。通过 <notes> 元素添加到文章的前言部分。

• subtitle

  文档标题的附属部分。作为 <subtitle> 元素添加到文档的前言部分。

• tags

  关键词列表。各项用作 <kwd> 元素的内容；这些元素被分组在一个带有 kwd-group-type 值为 author 的 <kwd-group> 中。

• title

  文章的标题。通过 <article-title> 元素添加到文档的前言部分。

• supplementary-material

  补充元数据。通过 <supplementary-material> 元素添加到文档的前言部分。仅在使用 jats_articlepublishing 时可用。

必需的元数据

Pandoc 会尝试生成一个有效的 JATS 文档，即使信息缺失也会填充占位符或使用空值。这规避了确保特定标签集文档中存在最小信息集的初衷。因此，建议始终提供下面列出的信息。

发布标签集

必需的元数据值：

• 以下之一：journal.publisher-id、journal.nlm-ta、journal.pmc。
• 以下之一：journal.pissn、journal.eissn。