csp logo

Instructions for using this documentation

Article XML Requirements

Article Objects

ID Syntaxes

File-Naming Conventions

Full-text Examples

DTD

Article object

Lists, symbol and abbreviation (glossaries)

Element or context:

<glossary>

NOTE: A 'glossary' may take many forms. Abbreviation lists, symbol lists, and variable lists are all examples.

Requirements:

  1. Place the glossary object within a <sec> in <back>, just before acknowledgements (see the order of elements in the example, below)
  2. If the glossary is part of an appendix, then place it directly within <app>, just before any <ref-list> if one exists
  3. If the glossary is an abbreviation list, then set attribute 'content-type' on <glossary> to "abbrev-list"
  4. If the glossary is a list of symbols, then set attribute 'content-type' on <glossary> to "symbol-list"; note that if an abbreviation list also exists, the abbreviation list goes first, within the same <sec>
  5. Put the title of the glossary within <title> tags
  6. Set the terms and definitions of the glossary inside a <def-list>; see the example
  7. If the list contains headings, then use the <title> element within <def-list>; see Example 2, below

Example:

<back>
<sec>
 <glossary content-type="symbol-list">
             <title>List of symbols</title>
        <def-list><title>Civil engineering symbols</title>
             <def-item><term><italic>A</italic></term><def><p>droplet cross-sectional area (m<sup>2</sup>)</p></def>/def-item>
             <def-item><term><italic>C</italic><sub>d</sub></term><def><p>drag coefficient</p></def></def-item>
             <def-item><term><italic>c</italic><sub>p</sub></term><def><p>fluctuating velocity (m/s)</p></def></def-item>
             <def-item><term><italic>C</italic><sub>s</sub></term>
        </def-list>
<def-list><title>Mechanical engineering symbols</title>
             <def-item><term><italic>A</italic></term><def><p>droplet cross-sectional area (m<sup>2</sup>)</p></def>/def-item>
             <def-item><term><italic>C</italic><sub>d</sub></term><def><p>drag coefficient</p></def></def-item>
             <def-item><term><italic>c</italic><sub>p</sub></term><def><p>fluctuating velocity (m/s)</p></def></def-item>
             <def-item><term><italic>C</italic><sub>s</sub></term>
        </def-list>
 </glossary>
  </sec>
<ack>
<title>Acknowledgements</title>
<p>The research was supported by the Innovative Research Groups of the National Natural Science Foundation of China (Grant No. 51321065), the Natural Science Foundation of China (Grant No. 51339003), and the Specialized Research Fund for the Doctoral Program of Higher Education of China (Grant No. 20120032110045). The authors gratefully acknowledge the helpful comments of the editor and referees of this manuscript.</p>
</ack> <sec sec-type="data-accessibility-statement"> <title>Data accessibility statement</title> <p>All relevant data are within the paper.</p> </sec> <sec sec-type="supplementary-material">
<title>Supplementary material</title>
<p specific-use="print">The following Supplementary Material is available with the article through the journal website at doi:<ext-link ext-link-type="doi" xlink:href="10.1139/facets-2016-0048">10.1139/facets-2016-0048</ext-link>.</p>
<supplementary-material id="sm1" xlink:href="facets-2016-0048_supplement1.pdf" xlink:title="local-file">
<label>Supplementary Material 1 (PDF / 117 KB).</label>
<caption>
<p>Detailed list of hardware for housing, product numbers for an online hardware retailer, and price at time of writing.</p>
</caption>
</supplementary-material>
<supplementary-material id="sm2" xlink:href="https://dx.doi.org/10.6084/m9.figshare.4042932">
<label>Supplementary Material 2 (URL).</label>
<caption>
<p>In this video we demonstrate all steps necessary to construct the underwater camera housing described in the note. Step numbers in the video correspond to each step in the supplementary material. Component labels correspond with labeling in <xref ref-type="fig" rid="f2">Fig.&#x00A0;2</xref>.</p> </caption>
</supplementary-material>
<supplementary-material id="sm3" xlink:href="facets-2016-0048_supplement2.docx" xlink:title="local-file">
<label>Supplementary Material 3 (DOCX / 18.471 MB):</label>
<caption>
<p>
Fully annotated construction guide, including photos demonstrating each step.</p>
</caption>
</supplementary-material>
</sec> <ref-list>....