<supplementmaterial> (
Supplementary Material)
Description
Description
This element should be used to describe supplementary material that accompanies an article. Supplementary material may include video files, audio files, datasets, expanded images, large tables, appendixes, web resources, etc.
The content of the
<supplementfile> or
<webaddress> element should be a name or short description that can be used to form a clickable link to download or access the material.
<supplementmaterial contenttype="document" id="SUP0001">
<supplementfile fileref="VJAM_A_445261_SUP_12028632.doc">The Art of Engagement: US Cultural
and Public Diplomacy Timeline, October 1999–September 2009</supplementfile>
</supplementmaterial>
In addition or alternatively, the
authorfilename attribute of <supplementfile> or url attribute of
<webaddress> may be used to display a clickable link.
<supplementmaterial id="SUP0001" contenttype="software" doi="10.1080/14772010903461099-SUP0001">
<supplementfile authorfilename="analyzer.pl" fileref="UINM_A_546470_SUP_22683343.zip" />
</supplementmaterial>
Some supplementary material may include a
<label>, title, and
<caption>, similar to a figure.
The title (which may form a clickable link when presented online) should be placed with within
<supplementfile>.
In addition, the
<graphic> element may be used to include a graphic to display with the supplementary material and to display in mediums that do not allow file downloads or moving audio/video.
Callouts to supplementary material from within text should be tagged using
<suppmatref>.
<supplementmaterial id="SUP0001" contenttype="video" articleid="417095" productid="GMFW"
doi="10.1080/10236240903169222-SUP0001">
<label>Video 1</label>
<supplementfile fileref="GMFW_A_417095_SUP_11151877.mpg"
authorfilename="Video 1 Use of stomatopod antennules as aggressive visual signal.mpg"
mimetype="video" mimesubtype="mpeg">
Use of stomatopod antennules as aggressive visual signal</supplementfile>
<graphic fileref="GMFW_A_417095_O_XML_IMAGES/GMFW_A_417095_O_GSUP0001t.jpg"/>
<caption>Dorsal view of G. smithii (within a PVC domicile in an aquarium) performing
aggressive antennular flicking prior to striking at a conspecific separated by plexiglass
(seen at top of screen). Aggressive/visual movements of the antennules occur as the
antennules are rapidly brought together horizontally and usually precede other
aggressive behaviours.</caption>
</supplementmaterial>
In some cases, supplementary material may be a link to an external website instead of a file attached to the article. For example:
<supplementmaterial id="SUP0001" contenttype="simulation" articleid="461901" productid="VECE">
<webaddress url="http://www.goldsimulations.com">www.goldsimulations.com</webaddress>
<caption>Beat The Market ONLINE is an interactive set of simulation games and exercises for
active learning and teaching of economics in a new and exciting way. For simulation games
students compete in making decisions to maximize profits utilizing economic concepts in
different market structures including perfect competition, monopoly, monopolistic
competition, and oligopoly.</caption>
</supplementmaterial>
Parent Elements
The elements listed below may directly contain this element.
They are "parent" elements. Elements in referenced groups are included, up to two levels of group nesting.
Model Diagram
The DTD model for this element:
--+(sequence)
|
label (optional) -- TEXT
|
|--+(choice)
| |
| |-- supplementfile -- (TEXT and elements)
| |
| |-- webaddress -- (TEXT and elements)
|
graphic (optional)
|
caption (optional) -- (TEXT and elements)
|
comment (optional and repeatable) -- TEXT
DTD Definition
The DTD contains the following element and attribute definitions
(note that embedded links are to definitions within the DTD page of this guide):
<!ELEMENT supplementmaterial (label?, (supplementfile | webaddress), graphic?, caption?, comment*)>
<!ATTLIST supplementmaterial
contenttype (video | audio | simulation | document |
appendix | table | dataset | software |
image) #REQUIRED
freedownload (yes | no) "no"
attachtoissue (yes | no) "no"
articleid CDATA #IMPLIED
productid CDATA #IMPLIED
doi CDATA #IMPLIED
%a-group-YearOfPubAttrs;
%a-group-CommonIDAttrs;>
.
Defined in DTD section
Multimedia
General Attributes (shared with other elements)
Local Attributes (defined for this element alone)
Description
This attribute describes the type of content held in the supplementary file, which may be important for searching or display styling. The list of allowed values may be expanded over time if needed.
Specification
This attribute is required. The allowed values are "video", "audio", "simulation", "document", "appendix", "table", "dataset", "software" and "image".
DTD Definition
contenttype (video | audio | simulation | document |
appendix | table | dataset | software |
image) #REQUIRED .
Description
This attribute may be used to indicate that the supplementary material should always be available for free.
Specification
This attribute is required but has a default value of "no". The allowed values are "yes" and "no".
DTD Definition
freedownload (yes | no) "no"
.
Description
This attribute may be used to indicate that the supplementary material should be displayed outside of the article, for example on an issue table of contents page.
Specification
This attribute is required but has a default value of "no". The allowed values are "yes" and "no".
DTD Definition
attachtoissue (yes | no) "no"
.
Description
This attribute holds the identifier of the article this supplementary material appears in (see
articleid). It should only be needed if the supplementary material is physically extracted from the rest of the article and then allows this information to be carried with the object. See also the
productid attribute.
<article articleid="120027636" ...>
...
<supplementmaterial ... articleid="120027636">...</supplementmaterial>
...
</article>
Specification
This attribute is not required. It has text content.
DTD Definition
articleid CDATA #IMPLIED
.
Description
This attribute holds a copy of the value from the same attribute in the
<meta> element, and is only needed if a supplementary material is extracted from the rest of the article.
Specification
This attribute is not required. It has text content.
DTD Definition
productid CDATA #IMPLIED
.
Attribute:
doi (
Digital Object Identifier)
Description
This attribute holds a Digital Object Identifier for the supplementary material , which will be the same as the DOI for the article, but with a suffix that conists of the supplementary material identifier, as in "10.1080/10236240903169222-SUP0001".
Specification
This attribute is not required. It has text content.
DTD Definition
doi CDATA #IMPLIED
.