Statements about the work, not part of its discourse — titles, contributors, provenance, and configuration.
<abstract>category metadata · eHTML <abstract> · JATS <abstract> · content structured → <children>
| attribute | kind | values / default | notes |
|---|---|---|---|
type |
kwarg | unstructured structured graphical executive-summary other (default unstructured) |
Distinguishes abstract types. |
word-limit |
kwarg | Optional documentation of the journal’s word limit for this abstract. |
Produced by: canonical <abstract>.
<abstract |
This paper presents new evidence that elephant populations
significantly affect regional climate patterns through their
role in shaping vegetation and carbon storage.
>
This paper presents new evidence that elephant populations significantly affect regional climate patterns through their role in shaping vegetation and carbon storage.
Unstructured abstract (the default). Single paragraph of summary prose.
<abstract type=structured |
**Background:** Elephant populations have declined significantly.
**Methods:** We surveyed 50 forest sites over 10 years.
**Results:** Decline correlates with vegetation loss.
**Conclusion:** Conservation efforts are essential.
>
Background: Elephant populations have declined significantly.
Methods: We surveyed 50 forest sites over 10 years.
Results: Decline correlates with vegetation loss.
Conclusion: Conservation efforts are essential.
Structured abstract using markdown bold for section headings. Common in medical and scientific journals. The structure is visible in the rendered output via the bold prefixes.
<abstract word-limit=250 |
This paper presents...
>
This paper presents…
<affiliation>category metadata · eHTML <affiliation> · JATS <aff> · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <affiliation>.
<author>
<name | Jane Goodall>
<affiliation | Anthropic>
</author>
Simple author affiliation. The affiliation sits as a sub-element of <author>, parallel to other rich-author-metadata elements (<orcid>, <email>).
<author>
<name | Jane Goodall>
<affiliation #aff1 | Anthropic, San Francisco, USA>
</author>
<author>
<name | David Attenborough>
<affiliation #aff1 />
</author>
Shared affiliation. The id on the first affiliation lets subsequent authors reference the same one by id via a self-closing tag. JATS exporter generates the appropriate <xref ref-type=”aff” rid=”aff1”> structure.
<article-subtitle>category metadata · eHTML <article-subtitle> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <article-subtitle>.
<article-title>category metadata · eHTML <article-title> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <article-title>.
<book-part-subtitle>category metadata · eHTML <book-part-subtitle> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <book-part-subtitle>.
<book-part-title>category metadata · eHTML <book-part-title> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <book-part-title>.
<book-subtitle>category metadata · eHTML <book-subtitle> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <book-subtitle>.
<book-title>category metadata · eHTML <book-title> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <book-title>.
<config>category configuration · eHTML <config> · JATS (no direct JATS counterpart) · content empty → <children>
| attribute | kind | values / default | notes |
|---|---|---|---|
notes |
kwarg |
Produced by: canonical <config>.
<config citation-style=author-year number-sections=true />
The authoring form for <config> is kwargs. Settings are read at the discovery pass into the configuration registry; the element itself produces no body output (it renders as an empty <config>).
<config number-figures=true number-tables=true show-source=true />
More operational options, all from the live kwarg allowlist (citation-style, number-sections, number-figures, number-tables, number-equations, show-source, parse-data-tables, ref-prefix-).*
<date>category metadata · eHTML <date> · JATS <pub-date or date (in history)> · content prose → <children>
| attribute | kind | values / default | notes |
|---|---|---|---|
type |
kwarg | publication submission acceptance revision retraction embargo other (default publication) |
Distinguishes different kinds of dates. |
format |
kwarg | iso ymd ymd-time mdy dmy custom |
Optional hint about how the date should be parsed and formatted. |
Produced by: canonical <date>.
<date | 2024-03-15>
A bare <date> is UNTYPED (no data-date-type) — an authoring date is “when you wrote it” (like the date on a letter), not a publication date (cf. Quarto/Pandoc/Bookdown preamble date slots). Use an explicit type= (e.g. <date type=publication | …>) for a typed date. (#325)
<date type=submission | 2023-11-01>
<meta>
<date type=submission | 2023-11-01>
<date type=acceptance | 2024-02-10>
<date type=publication | 2024-03-15>
</meta>
Multiple dates of different types. The publication date is the primary; submission, acceptance, etc., go in JATS history.
<date | March 15, 2024>
Free-form date format. Acceptable but ISO 8601 is preferred for machine readability and for predictable JATS export.
<editor>category structured-data-containers · eHTML <editor> · JATS <contrib contrib-type="editor"> · content empty → <children>
| attribute | kind | values / default | notes |
|---|---|---|---|
name |
kwarg | The editor’s name. | |
affiliation |
kwarg | Editor’s institutional affiliation. | |
orcid |
kwarg | Editor’s ORCID identifier. | |
email |
kwarg | Editor’s contact email address. | |
role |
kwarg | editor co-editor series-editor volume-editor guest-editor other (default editor) |
The editorial role — the one field that distinguishes an <editor> from an <author>. |
Produced by: canonical <editor>.
<editor | The Editor>
Casual form — the pipe content is the editor’s name (text content, not lifted to a <name> child), mirroring <author | …>.
<editor role=series-editor name="Jane Goodall" affiliation="Cambridge University" />
Kwarg form. name / affiliation / orcid / email lift to child tags at the gate (unified to <author>’s shape, #338); role stays a scalar attribute (data-role) — the one field that differs from <author>.
<email>category metadata · eHTML <email> · JATS <email> · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <email>.
<author>
<name | Jane Goodall>
<email | jane@example.org>
</author>
Author contact email. Common in journal article metadata for the corresponding author (see also the +corresponding boolean kwarg on <author>).
<keywords>category metadata · eHTML <keywords> · JATS <kwd-group> · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <keywords>.
<meta>
<keywords | elephants, conservation, climate, carbon storage>
</meta>
Comma-separated keyword list — the simpler and more common authoring form. The exporter splits on commas when emitting JATS.
<meta keywords="elephants, conservation, climate" />
Kwarg-form authoring lifts to the child-tag form at the gate.
<lang>category metadata · eHTML <lang> · JATS <(no direct element; maps to xml:lang attribute)> · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <lang>.
<meta>
<lang | en-US>
</meta>
BCP 47 language tag. The eHTML form preserves the value as a child element of <meta>; downstream consumers (the JATS exporter, the render-mode lowering) project it where each format expects.
<meta lang="fr" />
Kwarg-form authoring lifts to the child-tag form at the gate.
<license>category metadata · eHTML <license> · JATS <license> · content prose → <children>
| attribute | kind | values / default | notes |
|---|---|---|---|
href |
kwarg | Optional URL of the license terms (e.g. |
Produced by: canonical <license>.
<meta>
<license href="https://creativecommons.org/licenses/by/4.0/" | CC BY 4.0>
</meta>
License name with canonical URL.
<meta license="MIT License" />
Kwarg-form authoring (license name only) lifts to the child-tag form at the normalize-to-canonical gate.
<meta>category structured-data-containers · eHTML <meta> · JATS <article-meta, book-meta, or book-part-meta> · content empty → <children>
| attribute | kind | values / default | notes |
|---|---|---|---|
type |
kwarg | article book book-part website (default article) |
Declares the document class. |
book-part-type |
kwarg | chapter part introduction conclusion other preface foreword dedication appendix glossary colophon afterword (default chapter) |
For a single-file book-part (type=book-part) only: |
icon |
kwarg | Optional brand icon for a website’s top bar (#246): | |
slug |
kwarg | The page’s stable public SLUG (#289) — its identity, independent of title and of where it sits in a website’s <nav>. |
Produced by: canonical <meta>.
<meta type=article>
<title | The Effect of Elephants on Climate>
<author | Jane Goodall>
<date | 2024-03-15>
</meta>
<section | Introduction>
The paper begins.
The paper begins.
*Author writes <meta type=article> at the top with no <article> wrapper. The structural plugin reads type=article and generates:
- the <article> container
- <article-front> wrapping the original <meta>
- <article-body> wrapping the section content <title> is promoted to <article-title> as the first child of <meta>. <meta> itself survives in the output, inside <article-front>.*
<meta type=book>
<title | A Natural History of Elephants>
<author | Jane Goodall>
</meta>
<chapter | Origins>
Content.
Content.
type=book generates the book-shaped wrapper instead. Changing the single kwarg switches the entire output structure. Each book-part contains its own <meta> with <book-part-title>; no <book-part-meta> wrapper.
<name>category metadata · eHTML <name> · JATS <string-name> · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <name>.
<author>
<name | Jane Goodall>
</author>
The common case. Pipe content becomes the name string.
<author name="Jane Goodall" orcid="0000-0001-2345-6789" +corresponding>
Kwarg form of <author>. The name kwarg lifts to a <name> child
tag at the normalize-to-canonical gate, parallel to <meta>’s
kwarg-to-child-tag lift. The +corresponding boolean stays as
a kwarg/attribute on the canonical eHTML <author> (it is a
scalar marker, not a structured field).
<orcid>category metadata · eHTML <orcid> · JATS <contrib-id> · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <orcid>.
<author>
<name | Jane Goodall>
<orcid | 0000-0002-1825-0097>
</author>
Bare 16-digit ORCID — the canonical form.
<author>
<name | Jane Goodall>
<orcid | https://orcid.org/0000-0002-1825-0097>
</author>
URL form is accepted but bare form is preferred.
<publication-date>category metadata · eHTML <publication-date> · JATS <pub-date> · content prose → <children>
| attribute | kind | values / default | notes |
|---|---|---|---|
format |
kwarg | iso ymd ymd-time mdy dmy custom |
Optional hint about how the date should be parsed and formatted. |
Produced by: canonical <publication-date>.
<meta>
<publication-date | 2024-03-15>
</meta>
ISO 8601 publication date — the preferred form.
<meta>
<publication-date | March 15, 2024>
</meta>
Free-form publication date. Acceptable but ISO 8601 is preferred for predictable JATS export and machine readability.
<section-subtitle>category metadata · eHTML <section-subtitle> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <section-subtitle>.
<section-title>category metadata · eHTML <section-title> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <section-title>.
<sub-section-subtitle>category metadata · eHTML <sub-section-subtitle> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <sub-section-subtitle>.
<sub-section-title>category metadata · eHTML <sub-section-title> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <sub-section-title>.
<sub-sub-section-subtitle>category metadata · eHTML <sub-sub-section-subtitle> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <sub-sub-section-subtitle>.
<sub-sub-section-title>category metadata · eHTML <sub-sub-section-title> · JATS (no direct JATS counterpart) · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <sub-sub-section-title>.
<subject>category metadata · eHTML <subject> · JATS <subject> · content prose → <children>
| attribute | kind | values / default | notes |
|---|---|---|---|
scheme |
kwarg | Optional classification scheme this subject belongs to (e.g. |
Produced by: canonical <subject>.
<meta>
<subject | Ecology of large mammals>
</meta>
Free-form subject. Common for general-interest documents.
<meta>
<subject scheme=MSC2020 | 92D40>
<subject scheme=MSC2020 | 92D25>
</meta>
Multiple subjects from a controlled vocabulary. The scheme identifies the classification system; the JATS exporter generates the appropriate <subj-group subj-group-type=”…”> wrapper.
<subtitle>category metadata · eHTML <subtitle> · JATS <subtitle> · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <subtitle>.
<meta>
<title | The Effect of Elephants on Climate>
<subtitle | A Multi-Year Field Study in Tanzania>
</meta>
<title>category metadata · eHTML <title> · JATS <article-title or book-title (inside title-group inside article-meta or book-meta)> · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <title>.
<meta>
<title | The Effect of Elephants on Climate>
</meta>
Inside <article>, <title> in <meta> becomes <article-title>.
<book>
<meta>
<title | A Comprehensive Guide>
</meta>
</book>
Inside <book>, <title> in <meta> becomes <book-title>.
<meta>
<title | The role of <i type=taxonomic | Loxodonta africana> in ecosystem dynamics>
</meta>
Titles can contain inline elements. The recursive content parsing handles nested constructs.
<version>category metadata · eHTML <version> · JATS <(no direct standard element; uncertain — may map to article-version or custom-meta)> · content prose → <children>
No kwargs or boolean flags.
Produced by: canonical <version>.
<meta>
<version | 1.0.0>
</meta>
Semantic version. Other formats are equally valid as a free-form string.
<meta version="draft-2" />
Kwarg-form authoring lifts to the child-tag form at the gate.