◇◆

<supplementary-material> Supplementary Material Metadata

Container element for metadata concerning external resources that support an article, but which are not considered integral to the article (such metadata might include a title, description, and possibly a pointer to such an external resource).

Usage/Remarks

Attribute @supplemental for Included Objects

For best practice, the element <supplementary-material> element should not be used to describe supplemental objects that can be tagged as regular JATS elements (graphic, figure, table, section, etc.). Instead, these elements should be tagged as ordinary JATS objects and be marked as supplementary using the @supplemental flag attribute. For example, if the supplementary object is a figure, it should be tagged using a JATS <fig> element (<fig supplemental="yes"...>).
Similarly, links to external non-textual supplementary material (tagged with <graphic>, <media>, or <ext-link>) can also be marked as supplementary, rather than integral to an article, using the @supplemental flag attribute.
Historical Note
Historically, the <supplementary-material> element has been used within the metadata (in <article-meta>) to describe and point to supplemental items that are external to the JATS article. The <supplementary-material> element can still do that, especially for very large objects such as datasets that cannot be incorporated into the XML file. But increasingly, some publishers find it useful to place supplemental objects such as figures and tables in the same file as the XML article, marked to indicate that they are supplemental and not integral to the content. The attribute @supplemental marks elements inside the article, such as graphical and tabular material, as supplementary.
Related Elements
Basic Non-text Elements — This Suite contains several elements that can describe and point to non-textual content: <graphic>, <inline-graphic>, <media>, and <inline-media>. These elements appear in the flow of the document, and the material they describe and point to is assumed to be integral to the document, unless flagged with the @supplemental attribute. “Integral” means that the object is logically necessary to the content of the document, although stored as an external file.
The elements <graphic> and <inline-graphic> contain a pointer to a still image (such as a photograph, diagram, line drawing, etc.). The elements <media> and <inline-media> contain a pointer to a non-textual object (typically a binary such as an audio clip, dataset, or animation that cannot be displayed in print).
Supplementary Material — In contrast to the four non-textual elements, <supplementary-material> and <inline-supplementary-material> always describe and point to objects that are considered to be “supplementary” (non-integral) to the content of the article. Such material may be XML material (tagged textual material such as figures, tables, and sections) or non-textual material (such as graphics, films, audio clips, datasets, or other resources). Best practice is to use <supplementary-material> descriptions only for describing objects that are too large or otherwise of a format that does not fit into an XML file. Objects that could properly be incorporated into an XML file (such as text fragments, tables, figures, and intext graphics) should be tagged using the ordinary JATS elements (such as <fig>, <table>, or <sec>) and flagged as supplementary using the @supplemental attribute.
The elements <supplementary-material> and <inline-supplementary-material> (like the <graphic>, <inline-graphic>, <inline-media>, and <media> elements) never contain the object they describe, even if it is an XML object such as a figure. They provide metadata concerning the external object and may point to it.
The element <inline-supplementary-material> is used to mark up a reference to additional material, where the reference appears within the line of the text and does not have a preview image or separate caption. The <supplementary-material> element is used to describe a more complicated reference, where the description of the supplementary object resembles a figure in that it can be positioned as a floating or anchored object, may take a caption, and may use graphics or tables in the description of the object.
Attributes
content-type
hreflang
mime-subtype
mimetype
orientation (default = portrait)
position (default = float)
specific-use

Multi-lang Attributes

lang-focus
lang-focus-custom
lang-group
lang-source
lang-source-custom
lang-translate
lang-variant
lang-variant-custom

Base Attributes

id
xml:base
xml:lang

Linking Attributes

xlink:actuate
xlink:href
xlink:role
xlink:show
xlink:title
xlink:type

Namespaces

xmlns:xlink
Models and Context
May be contained in
<abstract>, <ack>, <alternatives>, <answer>, <app>, <app-group>, <article-meta>, <bio>, <body>, <boxed-text>, <disp-quote>, <explanation>, <floats-group>, <front-stub>, <glossary>, <license-p>, <named-content>, <notes>, <option>, <p>, <question>, <question-preamble>, <ref-list>, <sec>, <styled-content>, <trans-abstract>
Description
The following, in order:
Content Model
<!ELEMENT  supplementary-material
                        %supplementary-material-model;               >
Expanded Content Model
((object-id)*, (label)*, (caption)*, (abstract)*, (kwd-group)*,
(subj-group)*, (alt-text | long-desc | email | ext-link | uri)*, (disp-formula | disp-formula-group
| chem-struct-wrap | disp-quote | speech | statement | verse-group | table-wrap | p | def-list |
list | alternatives | array | code | graphic | media | preformat | xref)*, (attrib |
permissions)*)
Tagged Samples
A supplementary resource in text
(<media> used instead of deprecated <inline-supplementary-material>) 
<article dtd-version="1.4">
<front>...
  <p>Supplementary PDF file supplied by authors.</p>
  <media id="S1" supplemental="yes" 
    xmlns:xlink="http://www.w3.org/1999/xlink"
    xlink:title="local_file" 
    xlink:href="1471-2105-1-1-s1.pdf"
    mimetype="application/pdf"/>
  <p>RNAPs seem to have arisen twice in evolution
  (see the <ext-link supplemental="yes"  
   xmlns:xlink="http://www.w3.org/1999/xlink"
   xlink:title="local_file" xlink:href="timeline">
   Timeline</ext-link>). The large family of multisubunit 
   RNAPs includes bacterial enzymes and archeal enzymes  
   ...
  </p>...
Supplementary material section
Supplementary material descriptions gathered into a section with links from figures, tables, etc. in the text 
...
<sec><title>...</title>
...
<fig id="fig1">
 <label>Figure 1</label>
 <caption id="fig1-caption">
  <title>Orthogroup clustering analysis</title>
  <p id="fig1-caption-p1">Lorem ipsum dolor sit amet</p>
 </caption>
 <graphic id="fig1-graphic" 
   mimetype="image/jpeg" xlink:href="fig1.jpg" />
 <xref ref-type="supplementary-material" rid="source-data-1" />
</fig>
</sec>

<sec sec-type="supplementary-files">
 <title>Supplementary Files</title>
 <media id="source-data-1" mimetype="text/csv"
    content-type="sdata" 
    xlink:href="source-data-1.csv">
  <label>Supplementary File 1</label>
  <caption>
   <title>Orthogroup clustering analysis</title>
  </caption>
 </media>
 <media id="source-data-3" 
    mimetype="application/vnd.ms-excel"
    content-type="sdata" xlink:href="source-data-3.xlsx">
  <label>Supplementary File 3</label>
  <caption>
   <title>Representative curves of steady-state kinetic 
    analyses for each IGF1R protein characterized</title>
   <p>Each data point was performed in duplicate and is 
    shown separately.</p>
  </caption>
 </media>
</sec>...
Related Resources