Version 1.2 to 1.3d1 Changes
The ANSI/NISO Z39.96-2019: JATS 1.2 version is the latest ANSI/NISO standard JATS. This draft JATS 1.3d1 version (JATS Committee Draft) is fully backward compatible with JATS 1.1 (2015) and JATS 1.2 (2019). Any document valid to JATS 1.1 or JATS 1.2 will be valid to the JATS 1.3d1 version of the same JATS Tag Set, if the @dtd-version attribute is updated. Changes to JATS 1.2 to produce JATS 1.3d1 were made in response to user comments on the previous versions.
This 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.
1.1 Catalog and Formal Public Identifiers
New catalog files (catalog-jats-v1-3d1-no-base.xml and
catalog-jats-v1-3d1-with-base.xml) were established, as version 1.3d1 catalogs,
with a publication date of August 2019. Each of the JATS-named files
(filenames unchanged) were given a new Formal Public Identifier
(fpi) in which JATS 1.2 became "v1.3d1 20190831", the
first JATS Standing Committee draft following the final ANSI/NISO vote on JATS 1.2.
1.2 New Elements Added
All changes apply to all Tag Sets unless specifically noted below.
- <block-alternatives> — [Not in Authoring] A container element used to hold a group of block-level processing alternatives, for example, the same figure, once in Spanish, once in English, and once in Portuguese. This element is a physical grouping to contain multiple logically equivalent (substitutable) versions of the same structural object, such as a figure, boxed-text, or table.In Publishing, <block-alternatives> is allowed everywhere <fig> is allowed: inside: <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <fig-group>, <floats-group>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, and <styled-content> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, and <question-preamble>.In Archiving, <abstract>, <ack>, <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <fig-group>, <floats-group>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, and <trans-abstract> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, and <question-preamble>.
1.2.1 New Question/Answer Models Added from BITS
BITS has contained a model for questions and answers (not for full quizzes, but quizzes might be constructed from them) since BITS 2.0. That model was rolled into JATS. For more information concerning how to use these new models, See Questions and Answers.
- Question/Answer elements added:
- <answer> — The answer to a question.In Publishing, an <answer> may be contained in: <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, and <th> as well as in the following Question/Answer elements: <answer>, <answer-set>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.In Archiving, an <answer> may be contained in: <abstract>, <ack>, <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, <th>, <trans-abstract> as well as in the following Question/Answer elements: <answer>, <answer-set>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.In Authoring, an <answer> may be contained in: <app>, <bio>, <body>, <boxed-text>, <license-p>, <named-content>, <p>, <sec>, <styled-content>, <td>, <th> as well as in the following Question/Answer elements: <answer>, <answer-set>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.
- <answer-set> — A series of answers, typically in response to a question.In Publishing, an <answer-set> may be contained in: <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, <th> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.In Archiving, an <answer-set> may be contained in: <abstract>, <ack>, <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, <th>, <trans-abstract> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.In Authoring, an <answer-set> may be contained in: <app>, <bio>, <body>, <boxed-text>, <license-p>, <named-content>, <p>, <sec>, <styled-content>, <td>, <th> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.
- <explanation> — A description of a question/answer or of just an answer or answer set. The explanation may describe, for example, why this particular answer is incorrect, or where in the text the material for this question can be found, et al.In Publishing, an <explanation> may be contained in: <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, and <th> as well as in the following Question/Answer elements: <answer>, <answer-set>, <option>, <question>, <question-preamble>, and <question-wrap>.In Archiving, an <explanation> may be contained in: <abstract>, <ack>, <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, <th>, <trans-abstract> as well as in the following Question/Answer elements: <answer>, <answer-set>, <option>, <question>, <question-preamble>, and <question-wrap>.In Authoring, an <explanation> may be contained in: <app>, <bio>, <body>, <boxed-text>, <license-p>, <named-content>, <p>, <sec>, <styled-content>, <td>, <th> as well as in the following Question/Answer elements: <answer>, <answer-set>, <option>, <question>, <question-preamble>, and <question-wrap>.
- <option> — One of the possible answer-choices for a multiple-choice question. An attribute can be used to identify options which are correct. An <option> may be used only inside a <question>.
- <question> — A question (request for an answer) used in the text or as part of a quiz, exam, etc.In Publishing, a <question> may be contained in: <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, <th> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.In Archiving, a <question> may be contained in: <abstract>, <ack>, <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, <th>, <trans-abstract> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.In Authoring, a <question> may be contained in: <app>, <bio>, <body>, <boxed-text>, license-p>, <named-content>, <p>, <sec>, <styled-content>, <td>, <th> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.
- <question-preamble> — A container element to hold setup/preamble information when the setup is shared by several questions, for example, a diagram is shown and the questions are similar to “What is angle a?”. A <question-preamble> may be used only inside <question-wrap-group>.
- <question-wrap> — Used to model a Question/Answer scheme. These questions may be used, for example, for the Continuing Medical Education articles. The model allows for simple questions followed by their corresponding answers or for a multiple choice setup, where questions are followed by multiple alternative answers (<option> elements), along with the correct answer and an explanation.In Publishing, the element <question-wrap> may be used inside <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, <th> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.In Archiving, the element <question-wrap> may be used inside <abstract>, <ack>, <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, <th>, <trans-abstract> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.In Authoring, the element <question-wrap> may be used inside <app>, <bio>, <body>, <boxed-text>, <license-p>, <named-content>, <p>, <sec>, <styled-content>, <td>, <th> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap>.
- <question-wrap-group> — A container element used to hold a group of <question-wrap> elements, for example, when all the questions share a common preamble (setup).In Publishing, the element <question-wrap-group> may be used inside <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, <th> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, and <question-preamble>.In Archiving, the element <question-wrap-group> may be used inside <abstract>, <ack>, <app>, <app-group>, <bio>, <body>, <boxed-text>, <disp-quote>, <glossary>, <license-p>, <named-content>, <notes>, <p>, <ref-list>, <sec>, <styled-content>, <td>, <th>, <trans-abstract> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, and <question-preamble>.In Authoring, the element <question-wrap-group> may be used inside <app>, <bio>, <body>, <boxed-text>, <license-p>, <named-content>, <p>, <sec>, <styled-content>, <td>, <th> as well as in the following Question/Answer elements: <answer>, <explanation>, <option>, <question>, and <question-preamble>.
- <answer> — The answer to a question.
1.2.2 Differences in Authoring Because of Questions
When Questions and Answers were added to Authoring,
they used some elements and attributes that had long been in Archiving and Publishing,
but which Authoring did not contain. In order to keep the Question/Answer models the same in each of the three tag sets, these elements and attributes were added to Authoring, for use inside question elements only.
New Elements in Authoring: Authoring added the following elements because they were used in questions and answers. These elements had never been used in Authoring before:
- <alt-title> (used in <answer>, <answer-set>, <explanation>, <option>, <question>, <question-preamble>, and <question-wrap-group>)
- <compound-subject> (Used in <subj-group>)
- <compound-subject-part> (Used in <compound-subject>)
- <sec-meta> (Used in <question>)
- <subject> (Used in <subj-group>)
- <subj-group> (Used in <sec-meta> and <subj-group>)
New Attributes for Authoring:
Authoring added the following attributes because they were used in questions and answers. These attributes had never been used in Authoring before:
- @alt-title-type (Used on <alt-title>)
- @subj-group-type (Used on <subj-group>)
- @vocab (Used on <compound-subject>, <subject>, <subj-group>)
- @vocab-identifier (Used on <compound-subject>, <subject>, <subj-group>)
- @vocab-term (Used on <compound-subject>, <subject>)
- @vocab-term-id (Used on <compound-subject>, <subject>)
Changes in Attributes for Authoring:
In addition to the question/answer element attributes, Authoring added the following attributes to the new question-only additional elements:
- @assigning-authority
- <compound-kwd>
- <compound-subject>
- <subject>
- <subj-group>
- @content-type
- <compound-subject>
- <compound-subject-part>
- <subject>
- @id and @xml:base
- <alt-title>
- <compound-subject>
- <compound-subject-part>
- <subject>
- <sec-meta>
- <subject>
- <subj-group>
- @specific-use
- <alt-title>
- <subj-group>
- @subj-group-type
- <subj-group>
- @xml:lang
- <alt-title>
- <subj-group>
New Parameter Entities for Authoring: Authoring added the following Parameter Entities to be able to tag questions:
- %alt-title-atts;
- %alt-title-elements;
- %compound-subject-atts;
- %compound-subject-model;
- %compound-subject-part-atts;
- %compound-subject-part-elements;
- %sec-back-matter-mix;
- %sec-meta-atts;
- %sec-meta-model;
- %subject-atts;
- %subject-elements;
- %subj-group-atts;
- %subj-group.class;
- %subj-group-model;
1.3 Changes to Elements
The following element models were changed (in all tag sets unless specifically noted):
- <label> and <caption> — [Not in Authoring] Label and Caption were allowed to repeat inside the following elements, to take care of the case when the label and caption are presented in more than one language, one label or caption for each language.
- <fig>
- <fig-group>
- <table-wrap>
- <table-wrap-group>
- <size> — [In Archiving only] All face markup was added to the <size> element.
- <subj-group> — In Archiving and Publishing, subject groups (<subj-group>) were added to wherever keyword groups (<kwd-group>) were already allowed. Thus <subj-group> can now be used inside the following elements:
- <ack> (through <sec-meta> in Archiving)
- <app-group>
- <article-categories>
- <chem-struct-wrap>
- <disp-formula>
- <disp-formula-group>
- <fig>
- <fig-group>
- <graphic>
- <media>
- <sec-meta> And through <sec-meta> to elements:
- <abstract> [Archiving only]
- <app>
- <bio>
- <boxed-text>
- <notes>
- <question>
- <sec>
- <trans-abstract> [Archiving only]
- <statement>
- <subj-group>
- <supplementary-material>
- <table-wrap>
- <table-wrap-group>
In Authoring, subject groups (<subj-group>) are allowed inside the following elements:- <question> (through <sec-meta>
- <subj-group>
- <xref> — Added to the models of the following elements, to allow linking the element to a <supplementary-material> element. Thus the <xref> can be used to point to the data behind the figure, table, etc., when that data has been described in a <supplementary-material> element. Multiple cross references allow a structure to point to more than one supplemental object. In all tag sets except Authoring, a <ext-link> can be used to point to an external data source directly rather than to its description through a <supplementary-material> element.
- <fig>
- <fig-group> [Not in Authoring]
- <graphic>
- <media>
- <table-wrap>
- <table-wrap-group> [Not in Authoring]
1.4 New Attributes
The following new attributes were added (in all tag sets unless specifically noted):
- @award-id-type — This attribute does not record the type of award; it records the type of the award identifier for the element <award-id>. Thus, for example, an @award-id-type attribute can identify the award ID as a DOI from the Crossref’s DOI-based Grant Identifier system. @award-id-type is available only on the <award-id> element.
- @hreflang — Language of the target to which a link is pointing. A processor following the link would expect to find a document in the language named. Note: The @hreflang is not the language of the link itself or of the article or structural object in which the link is embedded. @hreflang is available on the following elements:
- <related-article>
- <related-object>
Attributes Used in the New Question/Answer Model
- @audience — Names the perspective audience for the question(s), Values are not restricted. @audience is available on the following elements:
- <question-wrap>
- <question-wrap>
- @correct — Marks a multiple-choice option as correct or incorrect, using the values “yes” and “no”. The attribute @correct is available only on the <option> element.
- @pointer-to-explained — Used in an <explanation> to point to the <question>, <answer>, or <option> that is being explained. Values are one or more @ids of the elements being pointed to (using IDREF). @pointer-to-explained is available only on the <explanation> element.
- @pointer-to-question — Used in an <answer> to point to the <question>(s) for which it supplies correct answer(s). @pointer-to-question is available only on the <answer> element.
- @question-response-type — Used to mark a question as taking a particular type of answer or set of answers, for example, “multiple-choice” or “essay”. Values are restricted to “essay”, “fill-in-the-blank”, “multi-select”, “multiple-choice”e, “short-answer”, and “true-false”. @question-response-type is available only on the <question> element.
- @content-type, @id, @specific-use, @xml:base, and @xml:lang — Added to the following elements:
- <answer>
- <answer-set>
- <explanation>
- <option>
- <question>
- <question-preamble>
- <question-wrap>
- <question-wrap-group>
1.5 Changes to Attributes
There were the following attribute modifications (in all tag sets unless specifically noted):
- @dtd-version — On the element <article>, the attribute @dtd-version became “FIXED '1.3d1'” replacing the value “FIXED '1.2'”.
- @assigning-authority — Added to the following elements:
- <article-version>
- <award-id>
- <compound-kwd>
- <compound-subject>
- <kwd>
- <kwd-group>
- <nested-kwd>
- <resource-id>
- <subject>
- <subj-group>
- <unstructured-kwd-group> [Archiving only]
The attribute @assigning-authority was already available on many other elements. - @id and @xml:base — Added to the <block-alternatives> element. [Not in Authoring]
1.6 New Parameter Entities
The following parameter entities, were added:
- %block-alternatives-atts;
- %block-alternatives.class; (Holds the elements that may be included inside a Block Alternatives elements: boxed-text | fig | fig-group | table-wrap | table-wrap-group.)
- %block-alternatives-model;
- %subj-group.class; (Holds just <subj-group>)
PEs Added for Question/Answer
The following parameter entities, were added:
- %answer-atts;
- %answer-model;
- %answer-para-level;
- %answer-set-atts;
- %answer-set-model;
- %answer-types;
- %block-display-minus-explanation.class;
- %explanation-atts;
- %explanation-model;
- %option-atts;
- %option.class;
- %option-model;
- %question-answer.class;
- %question-answer.ent;
- %question-atts;
- %question-model;
- %question-preamble-atts;
- %question-preamble-model;
- %question-wrap-atts;
- %question-wrap.class;
- %question-wrap-group-atts;
- %question-wrap-group-model;
- %question-wrap-model;