The Suite was created to allow a multiplicity of tag sets, based on the needs of the intended use. The Journal Publishing Tag Set (JATS-journalpublishing1.dtd) and its specific customization modules (%journalpubcustom-classes.ent;, %journalpubcustom-mixes.ent;, %journalpubcustom-models.ent;, and %journalpubcustom-modules.ent;) define an archival repository tag set focused on consistent processing and searching capability. The following modules are critical for the customization process that creates that Tag Set:
Journal Publishing DTD | (File name JATS-journalpublishing1.dtd) The top-level Journal Publishing Tag Set Module that declares the document element (<article>) and the other top-level elements that define a journal article (front matter, back matter, and sub-articles or responses). All elements but these few are declared in the modules of the Suite. The DTD invokes all the other modules it uses, by reference, as external parameter entities: first the Journal Publishing Tag-Set-specific Module of Modules is called to name all Journal Publishing-specific customized modules, then the Suite Module of Modules is called to name all the potential modules from the Suite, then customized and default modules are called (for parameter entities naming element classes, mixes, and models), then the Common Module for shared elements and attribute lists is called, and finally all the other modules are called as needed, including the Tag-Set-specific element module, %nlmcitation.ent;. |
Module to Name Journal Publishing Tag-Set-specific Modules | (parameter entity %journalpubcustom-modules.ent;) Defines all the external modules that are specific to the Journal Publishing Tag Set (except itself, so this module must be both named and called inside a DTD). A Tag Set selects from these modules by referencing the module names through external parameter entities. The entities are declared in the Journal Publishing Tag-Set-specific Module of Modules (%journalpubcustom-modules.ent;), but referenced (or not) in the DTD proper. To include a set of elements (such as all the lists or all the MathML elements), a DTD references the external parameter entity of the module that contains these declarations. Implementor’s Note: The Journal Publishing Tag-Set-specific Module of Modules and the Suite Module to Name the Modules need to be the first two external modules called by the Journal Publishing Tag Set. Customization modules for classes, mixes, and models will typically be called following the Journal Publishing Tag-Set-specific Modules and the Module to Name the Modules. |
Suite Module to Name the Modules | (parameter entity %modules.ent;) Defines all the external modules that are part of the modular JATS DTD Suite (except itself, which must be both named and called inside a DTD). A Tag Set selects from these modules by referencing the module names through external parameter entities. The entities are declared in the Module to Name the Modules (%modules.ent;), but referenced (or not) in the DTD proper. To include a set of elements (such as all the article metadata or all the display elements) a DTD references the external parameter entity of the module that contains these declarations. Implementor’s Note: The Journal Publishing Tag-Set-specific Modules and the Suite Module to Name the Modules need to be the first two external modules called by the Journal Publishing Tag Set. Customization modules for classes, mixes, and models will typically be called following the Journal Publishing Tag-Set-specific Modules and the Module to Name the Modules. |
Journal Publishing Tag Set Class Customizations Module | (parameter entity %journalpubcustom-classes.ent;) Sets up parameter entities that will be used to override default classes prescribed by the %default-classes.ent; module Implementor’s Note: This module must be called after the Journal Publishing Tag-Set-specific Modules (%journalpubcustom-modules.ent;) and the Suite Module to Name the Modules (%modules.ent;) but before any other module, including specifically the %default-classes.ent; module (which this module overrides) and the %journalpubcustom-mixes.ent; and %journalpubcustom-models.ent; modules (which build on this module). |
Suite Default Element Classes Module | (parameter entity %default-classes.ent;) Sets up the parameter entities that name the element members of each class that will be used to establish the content models Implementor’s Note: This module must be called before the Journal Publishing Customize Mixes Module (%journalpubcustom-mixes.ent;) and the Default Element Mixes Module (%default-mixes.ent;), as well as the Journal Publishing Customize Models Module, %journalpubcustom-models.ent; (which builds on those modules). |
Journal Publishing Tag Set Mix Customizations Module | (parameter entity %journalpubcustom-mixes.ent;) Sets up parameter entities that will be used to override default mixes (groupings made of “classes”) prescribed by the %default-mixes.ent; module Implementor’s Note: This module must be called after the Journal Publishing Customize Classes Module (%journalpubcustom-classes.ent;) and the Default Classes Module (%default-classes.ent;) but before any other module, including specifically the %default-mixes.ent; module (which this module overrides) and the %journalpubcustom-models.ent; module (which builds on this module). |
Suite Default Element Mixes Module | (parameter entity %default-mixes.ent;) Sets up the parameter entities that name mixes (groupings made of “classes”) that will be used to establish the content models Implementor’s Note: This module must be called before the Journal Publishing Customize Models Module (%journalpubcustom-models.ent;) or any “base” module of the interchange Suite. |
Journal Publishing Tag Set Models/Attributes Customizations Module | (parameter entity %journalpubcustom-models.ent;) Sets up parameter entities that will be used to override default content model parameter entities set elsewhere in the Suite. Also defines customizable attribute Declared Values and attribute lists for this Tag Set being defined. Implementor’s Note: This module must be called after the Journal Publishing Tag Set Customize Mixes Module (%journalpubcustom-mixes.ent;) and Default Mixes Module (%default-mixes.ent;) but before any “base” module of the interchange Suite. |
The NISO JATS common modules, which are overridden by the customizations, include the following:
Suite Module to Name the Modules | (parameter entity %modules.ent;) Defines all the external modules that are part of the modular NISO JATS DTD Suite (except the module itself, which must be both named and called inside a DTD). A Tag Set selects from the Suite modules by referencing the module names through external parameter entities. The entities are declared in the Module to Name the Modules (%modules.ent;), but referenced (or not) in the DTD proper. To include a set of elements (such as all the article metadata or all the display elements) a DTD references the external parameter entity of the module that contains these declarations. Implementor’s Note: The Publishing Tag-Set-specific Module of Modules and the Suite Module to Name the Modules need to be the first two external modules called by the Publishing DTD. Customization modules for classes, mixes, and models will typically be called next, following these two. |
Suite Default Element Classes Module | (parameter entity %default-classes.ent;) Sets up the parameter entities that name the element members of each class that will be used to establish the content models Implementor’s Note: This module must be called before the Publishing Customize Mixes Module (%journalpubcustom-mixes.ent;) and the Default Element Mixes Module (%default-mixes.ent;), as well as the Publishing Customize Models Module, %journalpubcustom-models.ent; (which builds on those modules). |
Suite Default Element Mixes Module | (parameter entity %default-mixes.ent;) Sets up the parameter entities that name mixes (groupings made of “classes”) that will be used to establish the content models Implementor’s Note: This module must be called before the Publishing Customize Models Module (%journalpubcustom-models.ent;) or any “base” module of the NISO JATS DTD Suite. |
Common (Shared) Elements Module | (parameter entity %common.ent;) Declarations for elements, attributes, entities, and notations that are shared by more than one class module Implementor’s Note: This module must be called before any of the modules comprising the interchange Suite. |
The modules that define the elements and attributes that make up the Suite are defined by the following modules. These too may be overridden by the customization modules of the Archiving DTD.
Article Metadata Elements Module | (parameter entity %articlemeta.ent;) Declares the metadata elements (issue elements and article header elements) used to describe a journal article Design Note: Metadata elements that describe the journal are in the Journal Metadata Module, %journalmeta.ent;. |
Back Matter Elements Module | (parameter entity %backmatter.ent;) Declares elements that are not part of the main textual flow of a work, but are considered to be ancillary material such as appendices, glossaries, and bibliographic reference lists |
Display Class Elements Module | (parameter entity %display.ent;) Declares the display-related elements, such as figures, graphics, math, chemical expressions and structures, tables, etc. |
Format Class Elements Module | (parameter entity %format.ent;) Declares elements concerned with rendition of output, for example, printing on a page or display on a screen. This module includes the elements in the Appearance Class, the Break Class, and the Emphasis Class. |
Funding Elements Module | (parameter entity %funding.ent;) Declares elements that model open access, grant, sponsorship, or other funding information, for example, the grant number (<award-id>) and the grant holder (<principal-award-recipient>) |
Journal Metadata Elements Module | (parameter entity %journalmeta.ent;) Declares the elements used to describe the journal in which a journal article is published Design Note: The issue and article metadata is defined in the Article Metadata module, %articlemeta.ent;. |
Link Class Elements Module | (parameter entity %link.ent;) Declares elements that are links (internal or external) by definition, such as URLs (<uri>) and internal cross references (<xref>) |
List Class Elements Module | (parameter entity %list.ent;) Declares the elements in the List Class; these are all lists except the lists of bibliographic references (citations). Lists are considered to be composed of items. |
Math Class Elements Module | (parameter entity %math.ent;) Declares the elements in the math classes such as display equations |
NLM Citation Module | (parameter entity %nlmcitation.ent;) Adds the model for the NLM structured bibliographic citation element (<nlm-citation>). This element is now obsolete and should be replaced by either the <element-citation> or the <element-citation> element. |
Paragraph-Like Elements Module | (parameter entity %para.ent;) Declares structural, non-display elements that may appear in the same places as a paragraph. These elements are named in the various paragraph class parameter entities. |
Subject Phrase Class Elements Module | (parameter entity %phrase.ent;) Declares the Phrase Class elements, that is, names the inline, subject-specific elements |
Bibliographic Reference (Citation) Class Elements Module | (parameter entity %references.ent;) Declares the bibliographic reference elements |
Related Object Elements Module | (parameter entity %related-object.ent;) Defines the container element <related-object>, used as a container for text links to a related object, possibly accompanied by a very brief description of the object |
Section Class Elements Module | (parameter entity %section.ent;) Declares the elements of the Section Class, that is, declares all section-level elements in the Journal Publishing Tag Set |
The modules that define the MathML elements and attributes:
MathML Setup Module | (parameter entity %mathmlsetup.ent;) Invokes the MathML modules Implementor’s Note:: To include the MathML elements, a DTD must reference this module. This module sets up all parameter entities needed to use the MathML Tag Set and references (invokes) the MathML 2.0 Tag Set Module, which, in turn, invokes all the other MathML modules. |
MathML 2.0 Tag Set Module | (parameter entity %mathml.dtd;) Mathematical Markup Language (MathML) 2.0, an XML application for describing mathematical notation and capturing both its structure and content |
MathML 2.0 Qualified Names 1.0 | (parameter entity %mathml-qname.mod;) Declares parameter entities to support namespace-qualified names, namespace declarations, and name prefixing for MathML, as well as declares the parameter entities used to provide namespace-qualified names for all MathML element types |
Extra Entities for MathML 2.0 | (parameter entity %ent-mmlextra;) Used for MathML processing |
Aliases for MathML 2.0 | (parameter entity %ent-mmlalias;) Used for MathML processing |
The modules that define the NISO JATS XHTML-inspired table model are:
NISO JATS XHTML-inspired Table Setup Module | (parameter entity %XHTMLtablesetup.ent;) Sets all parameter entities needed by the NISO JATS XHTML-inspired Table Module, and then invokes the module containing that model To include the NISO JATS XHTML-inspired table model in a tag set, a DTD must reference this module. This module sets up all parameter entities needed to use the XHTML-inspired Table Module and references (invokes) the NISO JATS XHTML-inspired Table Module. (See next item.) |
NISO JATS XHTML-inspired Table Module | (parameter entity %xhtml-table-1.mod;) The public XML DTD version of the XHTML-inspired Table Module. This module is invoked from the module %XHTMLtablesetup.ent;. (See previous item.) This is the default table model for this Tag Set. |
NISO JATS XHTML-inspired Table Style Module | (parameter entity %xhtml-inlstyle-1.mod;) Declares the @style attribute, which supports inline style markup for elements such as <td> and <tr> within XHTML-inspired Table. |
The modules that define character entities and notations (all optional):
XML Special Characters Module | (parameter entity %xmlspecchars.ent;) Standard ISO XML special character entities used in this Tag Set |
Custom Special Characters Module | (parameter entity %chars.ent;) Custom special character entities created specifically for use in this Tag Set |
Notation Declarations Module | (parameter entity %notat.ent;) Container module for the Notation Declarations to be used with this Suite. These notations have been placed in their own module for easy expansion or replacement. |