Supplementary Material

Supplementary material can take many different forms and can be cited within a publication in many different ways. As such, there are many different ways to style and tag supplementary material with eXtyles.

If the entire supplement has a title, this should be styled as "Supplementary_Material_Head." The caption for each individual supplementary file should be styled using "Supplementary_Material_Caption." The caption for each supplementary file may be followed by file details to be pulled into the XML, such as mimetype or ID. The "Supplementary_Material_File_Information" paragraph style should be applied to a single paragraph containing one or more file details, each separated by a soft return. These file details are automatically pulled into the XML as attributes and values of the supplementary item.

If you have some text in the supplement that is not associated with a specific supplementary file, it should be styled as "Supplementary_Material."

In the following example, the Supplementary_Material_Head style is applied to the title of the supplement, while the Supplementary_Material_Caption is applied to the caption or description of the supplementary file. The Supplementary_Material_File_Information style is applied to the paragraph containing multiple details for that file, each detail separate by a soft return:

Note that the file information is formatted according to the following format:

attribute: attribute value

When the document is exported to XML, eXtyles uses this format to parse the specific file details and convert them into the correct attribute and value in the XML.

The above example yields the following XML:

<title>Supplementary Material</title>
<supplementary-material position="anchor" id="su1">
<caption><p>This article has a Continuing Professional Development activity for pharmacists available.</p></caption>
<media xlink:href="testpdf.pdf" mimetype="application/pdf" mime-subtype="application/pdf" content-type="application/pdf">
<object-id pub-id-type="doi">10.1234/5678</object-id></media>
<graphic xlink:href="image.png"/>

Note that different attributes defined in the Word document are automatically tagged according to the type of information. The text "mime-type: application/pdf" is converted to an attribute in the media element, while the text "doi: 10.1234/5678" is tagged as an <object-id>.

Note: The Supplementary_Material_Caption and _File_Information styles are designed to be used together. While either style can be used without the other, they each require the presence of the Supplementary_Material_Head style to enable the correct placement of uncited supplements in the XML.

Supplementary material is generally placed in a section element <sec sec-type="supplementary-materials"> at the end of the <body> section. However, supplementary material may also be placed in the <app> or <notes> element in the <back> section of the exported XML. Supplements may also be cited in the body of the document. In that case, supplements can be placed after the point at which the supplement is first cited in the XML instead of being anchored, just like a cited table or figure.

Note: Supplements may be both cited in the document and placed in the <back> section of the exported XML. Please contact if you would like supplementary material to always be placed in the <back> content of your XML.

In the following example, a supplementary video has been cited in the body of the article, and the file information has been included:

This results in the following XML:

<title>Acute Phase</title>
<p>Based on the evaluation findings (<xref ref-type="supplementary-material" rid="J123-vid31.01">Video 31.1</xref>), the physical therapist can develop goals and a plan of care specific to each patient&rsquo;s needs and limitations.<xref ref-type="bibr" rid="J123-r3"><sup>3</sup></xref><sup>,</sup><xref ref-type="bibr" rid="J123-r4"><sup>4</sup></xref></p>
<media id="J123-vid31.01" xlink:href="" xlink:role="media-player-id" content-type="play-in-place" mimetype="video" mime-subtype="mp4"><label>Video 31.1</label><caption><p>Ferkel RD: Subtalar Arthroscopy, in Tasto JP: Video: Surgical Techniques in Orthopaedics: Principles in Arthroscopy. Rosemont, IL, American Academy of Orthopaedic Surgeons, 2003.</p></caption>
<object-id pub-id-type="other" content-type="media-stream-id">AOE-01-031-13-vid01.mp4</object-id>

The destination URL in this example (xlink:href="")is not included in the Word document. File information may be defined in your export filter as default information that is always included in the supplementary material XML. Please contact if you would like to define default values for supplementary files.

Further Reading

For more information on how to handle Supplementary Material, please see NISO RP-15-2013, Recommended Practices for Online Supplemental Journal Article Materials.

© 2021 Atypon Systems. All Rights Reserved.

Icons made by Freepik from Flaticon are licensed under CC 3.0 BY