Version 1.2 Change Report
Changes between JATS 1.1 and 1.2
The ANSI/NISO Z39.96-2019: JATS 1.2 version of the Journal Archiving and Interchange Tag Set is fully backward compatible with JATS version 1.1. Any document valid to JATS 1.1 will be valid to the 1.2 version of the same JATS Tag Set, if the @dtd-version attribute is updated. Changes were made in response to user comments on previous versions.
Changes to Elements
All changes apply to all Tag Sets unless specifically noted below.
- <array> — [Authoring only] Added <array> to Authoring, but only for use inside embedded index terms. Model for <array> is the reduced one from Publishing.
- <article-meta>
- Article Version (<article-version>) — Added new element <article-version> inside <article-meta> to hold one version number for the article. Optional in all three Tag Sets. In Publishing and Archiving, the <article-version> element may repeat inside <article-version-alternatives> to hold version numbers for the same article that were assigned by different systems.
- Publication Date Alternative (<pub-date-not-available>) —
- [Publishing only] A new element <pub-date-not-available> (a flag for use when there is no available <pub-date>) was added to <article-meta>. The element <pub-date> is still required and repeatable, unless it is replaced by a <pub-date-not-available> element.
- [Archiving only] A new element <pub-date-not-available> (a flag for use when there is no available <pub-date>) was added to <article-meta>. The element <pub-date> is still optional and repeatable, unless it is replaced by a <pub-date-not-available> element.
- Publication History (<pub-history>) — [Publishing and Archiving only] Added an optional <pub-history> to hold one or more of <event>s. New elements: <event>, <event-desc>.
- <chapter-title> — [Publishing and Authoring only] In Archiving, the model for
<chapter-title> includes all phrase-level elements. In Publishing and Authoring, added the following elements to <chapter-title> to more closely mirror the model of <article-title>:
- <abbrev>
- <alternatives>, <inline-graphic>, <private-char>
- <chem-struct>, <inline-formula>
- <mml:math>, <tex-math> [Authoring: mml:math only]
- <named-content>, <styled-content> [Authoring only]
- <fn>, <target>, <xref>
- <code> — Both <inline-graphic> and <private-char> added to elements allowed in <code>.
- <conf-date> — [Archiving only] Allow face markup inside <conf-date>.
- <contrib> — Added <string-name> as an alternative to <name> in Publishing and Authoring. All Tag Sets are now the same.
- <date-in-citation> — [Archiving only] Allow <sub> and <sup> inside <date-in-citation>.
- <data-title> — Both <inline-graphic> and <private-char> allowed inside <data-title>.
- <front-stub> [Publishing and Archiving only]
- Added new element <article-version> inside <front-stub> to hold one version number for the sub-article or response. In Publishing and Archiving, the <article-version> element may repeat inside <article-version-alternatives> to hold version numbers for the same article that were assigned by different systems.
- Publication Date Alternative (<pub-date-not-available>) — A new element <pub-date-not-available> (a flag for use when there is no available <pub-date>) was added to <front-stub>. The element <pub-date> is still optional and repeatable, unless it is replaced by a <pub-date-not-available> element.
- Publication History (<pub-history>) — Added an optional <pub-history> to <front-stub> to hold one or more of <event>s. New elements: <event>, <event-desc>.
- Index Elements — Added the inline index terms from BITS, which are embedded in narrative text and used to automatically generate one or more indices. Elements added: <index-term>, <index-term-range-end>, <see>, and <see-also>.
- <index-term> — See Index Elements above.
- <index-term-range-end> — See Index Elements above.
- <inline-formula> — Added accessibility elements <alt-text> and <long-desc> to the model of inline formula.
- <inline-graphic> — Added <long-desc> to <inline-graphic>, where it joins <alt-text>.
- <inline-media> — Added new element<inline-media>, which relates to <media> as <inline-graphic> does to <graphic>. The new element is allowed anywhere <inline-graphic> is allowed.
- Non-Monetary Support — Previous support descriptions in JATS used the
<funding-group> element, which could only be used to describe monetary support for the research described in the article.Added new element <contributed-resource-group> to hold descriptions of non-monetary support (such as data, facilities, or any in-kind support) for the research described in the article. This changed the JATS models in several ways:
- Inside <article-meta>, added a new element <support-group> to hold both <funding-group> and <contributed-resource-group>. For backwards compatibility, <support-group> is a peer to <funding-group> inside <article-meta>, and (as the path going forward) <support-group> also contains <funding-group>.
- New elements inside <contributed-resource-group> (as its children or descendants) include:
- <support-description>
- <resource-group>
- <resource-wrap>
- <resource-name>
- <resource-id>
- Inside <award-group>, added a new element <support-source> to describe the source of a non-monetary award. The element <support-source> is an alternative to <funding-source> (which describes the source of a monetary award).
- <part-title> — [Publishing and Authoring only] In Archiving, the model for <part-title> includes all phrase-level elements. In Publishing and Authoring, added the following elements to <part-title> to more closely mirror the model of <article-title>:
- <abbrev>
- <alternatives>, <inline-graphic>, <private-char>
- <chem-struct>, <inline-formula>
- <mml:math>, <tex-math> [Authoring: mml:math only]
- <named-content>, <styled-content> [Authoring only]
- <fn>, <target>, <xref>
- <pub-history> — Added <pub-history> to hold <event>s. Unlike in BITS, <pub-history> will contain ONLY <event> elements.
- Added <event>, which may occur only inside <pub-history>. Adopted model from BITS.
- Adopted <event> attributes from BITS: @id, @xml:base, @event-type, @specific-use, and @xml:lang.
- Added <article-version> and <article-version-alternatives> to JATS model of <event>.
- <role> — Added new attribute for Degree of Contribution (@degree-contribution). The value for this attribute shall be uncontrolled. Documentation will suggest three values: ‘Lead’, ‘Supporting’, or ‘Equal’. The documentation will suggest that users of CRediT may wish to restrict their instances to these values.
- <see> — See Index Elements above.
- <see-also> — See Index Elements above.
- <source> — [Publishing and Authoring only] In Archiving, the model for <source> includes all phrase-level elements. In Publishing and Authoring, added the following elements to <source> to more closely mirror the model of <article-title>:
- <abbrev>
- <alternatives>, <inline-graphic>, <private-char>
- <chem-struct>, <inline-formula>
- <mml:math>, <tex-math> [Authoring: mml:math only]
- <named-content>, <styled-content> [Authoring only]
- <fn>, <target>, <xref>
- <std> — Both <inline-graphic> and <private-char> added to elements allowed inside Standard <std>.
- <table-wrap> — Added <disp-formula> as a sibling to <graphic>, <list>, etc. as the content of a <table-wrap> that does not contain a <table>.
- <x> — [Archiving Only] Both <inline-graphic> and <private-char> allowed inside <x>.
Changes to Attributes
The base JATS attributes (@id, @xml:lang), were added to all the new elements. In addition, there were attribute modifications to existing elements.
Article Attributes (on <article>)
- @dtd-version becomes “FIXED '1.2'” replacing the value “FIXED '1.1'”.
- Pseudo-attribute xsi:noNamespaceSchemaLocation added to attribute list of <article>, so that it can be edited in XML software. Most modern processors do not require this, but a user with an older processor requested it, so the JATS Standing Committee acquiesced. There are two issues with this pseudo-attribute being defined as an attribute:
- The pseudo-attribute “xsi:noNamespaceSchemaLocation” cannot be used at the same time as a DOCTYPE declaration. It is the pseudo-attribute many processors use to determine the location of the XSD schema, and is for the use of XSD schema processing only.
- The pseudo-attribute xsi:noNamespaceSchemaLocation cannot be declared as an attribute in a W3C XSD schema, and many processors will fail to validate a schema that contains it. So when JATS DTDs are converted to XSDs, this is removed as an attribute.
Other Attribute Changes
- @assigning-authority — Added to the following elements:
- <article-id>
- <contrib-id>
- <institution-id>
- <issue-id>
- <journal-id>
- <object-id>
- <volume-id>
(Note: <ext-link> and <pub-id> already took the @assigning-authority attribute.) - <article-version> Attributes — Attributes defined for this element are @article-version-type, @designator, @specific-use, @content-type, @iso-8601-date, the four vocabulary attributes, the two JATS base attributes (@id and @xml:base), and all the XLink linking attributes (@xmlns:xlink, @xlink:type, @xlink:href, @xlink:role, @xlink:title, @xlink:show, and @xlink:actuate).
- <award-id> Attributes — Made the attributes for <award-id> like those of BITS (@id, @xml:base, @rid, @specific-use, @xml:lang, @award-type, and the XLink linking attributes: @xmlns:xlink, @xlink:type, @xlink:href, @xlink:role, @xlink:title, @xlink:show, and @xlink:actuate).
- @person-group-type — Authoring and Publishing use a restricted list of values. Added the values “illustrator” and “research-assistant” to this value list. Archiving uses an unrestricted CDATA list of values. Added values “illustrator” and “research-assistant” to Archiving’s suggested value list in the non-normative documentation.
- @pub-id-type — The attribute @pub-id-type for <article-id> and <pub-id> in Publishing and Authoring is a fixed list of values which mixes types and authorities. Although these value lists will not change, the non-normative documentation will specify that for Best Practice, the attribute @pub-id-type should describe the type values and the attribute @assigning-authority should name the responsible agency.In Archiving, @pub-id-type is a CDATA attribute instead of as an explicit value list on both <article-id> and <pub-id>.Note: The following elements used @pub-id-type as unrestricted CDATA values in version 1.1 in all three tag sets, and are unchanged in version 1.2:
- <issue-id>
- <object-id>
- <volume-id>
- @style-detail — Added to <styled-content>, <verse-line>, and <verse-group>.
- <term> Attributes — Added attributes @term-type, @term-status, and the four Vocabulary/Taxonomy attributes described below.
- @use-type — Added optional CDATA attribute to <mixed-citation> and <element-citation>. The first use-case documented describes cited data usage as “analyzed”, “generated”, etc.
- Verse Attributes —
- Added @indent-level, @style, @style-detail, and @style-type to <verse-line>.
- Added @style, @style-detail, and @style-type to <verse-group>.
- Vocabulary/Taxonomy Attributes — Added four new attributes for naming (and possibly linking to) a general or controlled taxonomy, ontology, vocabulary, index, database, or other source of terms. The four attributes are: @vocab, @vocab-identifier, @vocab-term, and @vocab-term-identifier.
- Attributes @vocab and @vocab-identifier were added to the elements:
- <article-version>
- <compound-kwd>
- <compound-subject>
- <inline-media>
- <institution-id>
- <kwd>
- <kwd-group>
- <named-content>
- <nested-kwd>
- <role>
- <subject>
- <subj-group>
- <term>
- <unstructured-kwd-group>
- Attributes @vocab-term and @vocab-term-identifier were added to the elements:
- <article-version>
- <compound-kwd>
- <compound-subject>
- <inline-media>
- <kwd>
- <named-content>
- <nested-kwd>
- <role>
- <subject>
- <term>
- Attributes @vocab and @vocab-identifier were added to the elements:
Element/Parameter Entity Changes Made to Authoring/Publishing
- <person-group> Parameter Entities — Removed %string-name.class PE from PE %person-group-elements because <string-name> was added to PE %name.class, which the PE %person-group-elements already used. No model change was made in either tag set.