Version 1.3d1 to 1.3d2 Changes

The ANSI/NISO Z39.96-2019: JATS 1.2 version is the latest ANSI/NISO standard JATS. This draft JATS 1.3d2 version (JATS Committee Draft) is fully backward compatible with JATS 1.0 (2012), JATS 1.1 (2015), JATS 1.2 (2019), and JATS 1.3d1. Any document valid to JATS 1.0, 1.1, 1.2, or 1.3d1 will be valid to the JATS 1.3d2 version of the same JATS Tag Set. Changes to JATS 1.3d1 to produce JATS 1.3d2 were made in response to user comments on the previous versions.
This 1.3d2 Committee Draft may not be stable and may change any time until the next version of the standard is approved by ANSI/NISO. There is no commitment that future drafts or future JATS standards will be compatible with this Committee Draft. Basing implementations on this draft may be premature.
Catalog and Formal Public Identifiers in 1.3d2
New catalog files (catalog-jats-v1-3d2-no-base.xml and catalog-jats-v1-3d2-with-base.xml) are provided, as the version 1.3d2 catalogs, with a publication date of August 2020. The most significant change was in the module naming:
  • Each of theJATS-” named files was given a new name, incorporating the full “1.3d2” version number. For example, the file that was previously “JATS-list1.ent” is now “JATS-list1-3d2.ent” and, similarly, the former “JATS-display1.ent” is now “JATS-display1-3d2.ent”.
  • Each module was also given a new Formal Public Identifier (fpi) in which JATS “v1.3d1 20190831” became “v1.3d2 20201130”, which stands for the second JATS Standing Committee Draft following the final ANSI/NISO vote on JATS 1.2.
New Elements Added in 1.3d2
All changes apply to all Tag Sets unless specifically noted in the sections below.
Describing Awards and Grants
Two new elements (<award-name> and <award-desc>) were added to <award-group>, as optional and not repeatable. They join the <award-id> in naming an award or grant. The award IDs, award names, and award descriptions are all connected by being in the same <award-group>.
There are (at least) three independent concepts at work in the description of a grant or an award:
  • <award-id> — An award or grant identifier. Preferably a short, machine-actionable string (such as <award-id>U1605212</award-id> or <award-id>P30DK020572<award-id>).
  • <award-name> — The natural language name of the award or grant, that is typically a phrase such as <award-name>Marie Curie Career Integration Grant</award-name> or <award-name>Schleswig-Holstein Excellence Chair</award-name>.
  • <award-desc> — An award description holds textual material concerning an award or grant that does not fit in one of the two elements above, for example, the word “Fellowship”, “German Egyptian research long-term scholarship”, or the name of an institution or program that is not a funding source.
New Processing Metadata
To provide a more complete in-the-XML description of the tag set associated with a document, JATS 1.3d2 added an optional Processing Metadata element (<processing-meta>) to the model of <article> as a child element, the peer of <front>.
What is <processing-meta>
The <processing-meta> names (through attributes) the tag set, table model, and MathML options a document follows and (through elements) some of the modeling restrictions or extensions the document claims to follow.
Processing metadata is not considered to be part of the content of an article, nor metadata for citing an article; it is metadata about how the XML is constructed — not about how the article is structured. This metadata is information at the “file level” and thus not part of <article-meta>, but inside the article as a peer to <front>, which is the article and journal metadata container in JATS.
  • The elements inside <processing-meta> name tag set extensions (superset) and restrictions (subset, secondary schema, etc.) that the XML document claims to follow. More than one restriction or extension is allowed.
  • The attributes on <processing-meta> describe the modeling choices made by this document in terms of tagset family, tagset, table model, and MathML model.
Contents of <processing-meta>
Holds elements that describe processing information descriptive of the XML-tagged document (document instance):
  • <restricted-by> — Identification of one of the guidelines or other restrictions (such as a tighter subset schema) the document claims to be following. The content of <restricted-by> may be a name such as “jats4r” or “pmc”, or a URI, for example, the URL of a particular JATS4R recommendation. The element is repeatable so that multiple restrictions can be claimed.
  • <extended-by> — Identification of a JATS extension or superset that the document claims to be following. The content of <extended-by> may be a name, such as “taxpub”, or a URI. The element is repeatable so that more than one extension can be claimed.
  • <custom-meta-group> — To hold other processing metadata a JATS user might want to express in the XML file.
Tagset Identification Attributes
Since the @dtd-version attribute has never provided a complete description of which version of the tag set controls a document, several attributes were added to the <processing-meta> element to describe the version choices more fully:
Which of the JATS tagset families is the basis for this document’s tagset? (e.g., “jats” or “bits”)
Which of the JATS standard tag sets is the basis for this document? (e.g., “publishing” or “archiving”)
Which table model is used by the tagset for this document? (e.g., “xhtml” or “oasis”)
Which version of MathML is used by the tagset for this document? (e.g., “3.0” or “2.0”)
Which of the JATS tagset families is the basis for this document’s tagset? @tagset-family is an optional attribute; there is no default. The attribute has a set value list:
BITS (Book Interchange Tag Suite)
JATS (Journal Article Tag Suite)
STS (Standards Tag Suite)
Which of the JATS standard tag sets is the basis for this document? @base-tagset is an optional attribute; there is no default. The attribute has a set value list:
Journal Archiving and Interchange Tag Set
Article Authoring Tag Set
Journal Publishing Tag Set
Which table model is used by the tagset for this document? @table-model is an optional attribute; there is no default.
Both XHTML-inspired and OASIS CALS models are used
No table models are used
The OASIS XML Exchange (CALS) table model
The XHTML-inspired table model
Which version of MathML is used by the tagset for this document? @mathml-version is an optional attribute; there is no default.
MathML 2.0 is used
MathML 3.0 is used
Potential Math Representations
JATS will add the attribute @math-representation to <processing-meta>. This attribute names the style(s) of mathematics representation that may occur in the document collection.
The attribute @math-representation is an NMTOKENS attribute (meaning a space-separated list of values) so that an organization could declare their document to be using both TeX and images, for example, or both MathML and LaTeX.
While the XML schema does not constrain this list, expected values are one or more of the following words:
mathml   tex   latex   images   plain-text 
Changes to Elements in 1.3d2
The following element models were changed (in all tag sets unless specifically noted):
New Attributes in 1.3d2
The following new attributes were added (in all tag sets unless specifically noted):
  • @award-id-type — was added to <award-id>. This attribute records the type of the award identifier for the element <award-id>; it does not record the type of award. In addition to funder-specific award IDs, publishers may need to include Grant IDs in their JATS funding information. Thus, an @award-id-type attribute can identify the award ID as a DOI from the Crossref’s DOI-based Grant Identifier system. The @award-id-type attribute is available only on the <award-id> element.
  • Tagset Identification Attributes — described in the section describing new elements under New Processing Metadata
Custom Type Attribute
Added the attribute Custom Attribute Value Escape Hatch (@custom-type). to the elements
<article-id>, <fn>, <person-group>, <pub-id>, <xref>
This attribute is used only in the same attribute list as attributes whose values come from set lists in one of the JATS tag sets. When a JATS user desires to record an attribute value that is not named on a set attribute list, they use the attribute value “custom”. This tells a JATS processor that this element is not one of the provided types. The attribute @custom-type then records a type value for the element.
The Best Practice rule (unenforceable in DTDs, but enforceable in Schematron at the user’s option) says that, if you use the value “custom” from one of these lists, you should then record what type of custom in the @custom-type attribute.
  <person-group person-group-type=”custom” custom-type=”statisticians”>
  <xref  ref-type=”custom” custom-type=”data-avail-statement”>
The Archiving Tag Set (Green) does not “need” @custom-type because it has no defined-value attribute lists, and the @custom-type attribute is a way to extend static values lists. However, if JATS does not allow the @custom-type attribute in Green, it would mean that, for the first time, all Blue and Pumpkin documents would not be valid to Green. Therefore, the tag sets add @custom-type and the suggested value “custom” to Archiving (Green) everywhere that @custom-type is allowed in publishing (Blue).
Changes to Attributes in 1.3d2
The following attribute modifications were made (in all tag sets unless specifically noted):
Element Description and Use
The following elements already existed in JATS 1.2. Their models have not changed, but their definitions and expected uses have been clarified or changed:
  • <source> — Was defined as the title of a document (for example, journal, book, conference proceedings) that contains (is the source of) the material being cited. The source definition has broadened to be resource-related rather than document-centric and indicate the multi-level nature of cited material.
    New Definition: “Title of the resource (for example, journal, book, podcast, conference proceedings, TV show) that contains (is the source of) the material being cited in a bibliographic reference or product. In the case of a resource that has titles at multiple hierarchical levels, this is the title of the largest titled resource (e.g., the TV show name and not the episode title).”
  • Similarly <part-title> was defined in relationship to a document, and is now defined in relationship to a resource.
    New Definition: “Title of a portion of a larger resource (for example, a chapter in a book, module in a course, episode of a podcast or television series) described in a bibliographic reference.”
  • <chapter-title> — is deprecated and should be replaced in citations by <part-title>.
New Parameter Entities in 1.3d2
The following parameter entities were added:
  • %extended-by-atts;
  • %extended-by-elements;
  • %issue-title-group-atts;
  • %issue-title-group-model;
  • %issue-subtitle-atts;
  • %issue-subtitle-model;
  • %processing-meta-atts;
  • %processing-meta-model;
  • %restricted-by-atts;
  • %restricted-by-elements;