Element: Supplementary Material

Journal Publishing Tag Library Proposed NISO JATS Version 1.0

Container element for description of and pointer to additional data files that contain information directly supportive of the document (for example, audio clip, applet, raw research data).

Supplementary material has been defined to include all of the following:

Voluminous material (such as a genomic database or the multiple data sets behind a work that abstracts the highlights of those datasets) that supports the conclusions of the narrative but can never accompany a document based on sheer mass.
“Extra” tables that do not display with the work, but that record the measurements on which the document is based, for example, that need to be available so the peer reviewers can check the document content.
Material added to the work for enhancement purposes, such as a quiz, an instructional video, the 3-minute version of the reaction that was described in the work with narrative and a few still images, a form that can be filled out or copied, etc.
A preview image (for example, the first frame of a movie, tagged as a <graphic> or <media>), with the caption/preview placed in a manner similar to a <fig> and a cross-reference made to the material from the text.
The last 5 figures of the work.

Usage: The element is used in two contexts:

Inside the document metadata as an alert to the existence of supplementary material so that such material can be accessed from the document; and
As part of the textual narrative flow, where it is similar to a <fig>, in that it can be positioned as a floating or anchored object and may take a caption.
For this usage, the @position attribute may be used to indicate whether the element must be anchored at its exact location within the text or whether it may float, for example, to the top of the next page, into the next column, to the end of a logical file, or within a separate window.

Typing: The @mimetype attribute may be used to identify a file type for a <supplementary-material> element.

Relation to Other Tag Sets: The <supplementary-material> element has a similar function to the <audiovisual> element in some XML tag sets and the <unprinted-item> element (used only for electronic files) in other tag sets.

This Suite contains several elements to describe non-XML material: <graphic>, <inline-graphic>, <media>, and <supplementary-material>. The elements <graphic> and <inline-graphic> are used for still images, i.e., photographs, diagrams, etc. The distinction between the two other elements is more subtle. The element <media> should be used for video, audio clips, time-dependent graphic types, and all moving images in other media formats where the material is intrinsic to the content, that is, the media object is discussed within the text or is essential to the message of the text. The element <supplementary-material> should be used for films, audio clips, other moving material, and non-XML formats or even other XML material that enhances or supplements a document, but that is not discussed as part of the document or is not essential to the conclusions of the text. Such supplementary material could include the datasets or spreadsheets on which the textual conclusions are based.

See <inline-supplementary-material> for a simpler form that can be used to mark up text references to supplementary material where the reference appears in the regular flow of the text and does not have a preview image or separate caption.

<!ELEMENT  supplementary-material
                        %supplementary-material-model;               >

The following, in order:

<object-id> Object Identifier, zero or more
<label> Label (of an Equation, Figure, Reference, etc.), zero or one
<caption> Caption of a Figure, Table, etc., zero or one
Any combination of:
Any combination of:
Any combination of:
- <attrib> Attribution
- <permissions> Permissions

<article>
<front>...</front>
<body>
<p>...</p>
<fig id="F1">...</fig>
<supplementary-material id="S1" xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:title="local_file" xlink:href="1471-2105-1-1-s1.pdf"
mimetype="application/pdf">
<label>Additional material</label>
<caption>
<p>Supplementary PDF file supplied by authors.</p>
</caption>
</supplementary-material>
<p>RNAPs seem to have arisen twice in evolution
(see the <inline-supplementary-material
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:title="local_file" xlink:href="timeline">
Timeline</inline-supplementary-material>. A large
family of multisubunit RNAPs includes bacterial
enzymes, archeal enzymes, eukaryotic nuclear RNAPs,
plastid-encoded chloroplast RNAPs, and RNAPs from
some eukaryotic viruses. ...</p>
...
</body>
<back>...</back>
</article>

JATS-display1.ent

Journal Publishing Tag Library Proposed NISO JATS Version 1.0

<supplementary-material>

Supplementary Material

Remarks

Attributes

content-type Type of Content

id Identifier

mime-subtype Mime Subtype

mimetype Mime Type

orientation Orientation

position Position

specific-use Specific Use

xlink:actuate Actuating the Link

xlink:href Href (Linking Mechanism)

xlink:role Role of the Link

xlink:show Showing the Link

xlink:title Title of the Link

xlink:type Type of Link

xmlns:xlink XLink Namespace Declaration

xml:lang Language

Related Elements

Content Model

Expanded Content Model

Description

This element may be contained in:

Example

Module

Journal Publishing Tag Library Proposed NISO JATS Version 1.0

Version of May 2012

Journal Publishing Tag Library Proposed NISO JATS Version 1.0

National Center for Biotechnology Information (NCBI) National Library of Medicine (NLM)

<supplementary-material>

Supplementary Material

Remarks

Attributes

Related Elements

Content Model

Expanded Content Model

Description

This element may be contained in:

Example

Module

Journal Publishing Tag Library Proposed NISO JATS Version 1.0

Version of May 2012

National Center for Biotechnology Information (NCBI)
National Library of Medicine (NLM)