Lists for Standards XML
- Jo Ripoll
In this section
Example 1: Multilevel Labeled List
In eXtyles STS a group of contiguous list paragraphs will be exported as a single XML list.
Nested lists should be styled carefully to ensure that the nesting is reflected in the paragraph styles used.
The following example shows a properly styled multilevel labeled list.
Word Sample
XML Sample
Note that the level-1 list L1 is not closed when the first of the level-2 list starts.
Multilevel Labeled List
<sec id="sec_5.2.2"><label>5.2.2</label>
<p>The fundamental system configuration decisions and major components for a post-combustion NOx treatment system include the following.</p>
<list id="L1" list-type="alpha-lower">
<list-item><label>a)</label><p>Type of post-combustion NOx treatment:</p>
<list id="L2" list-type="order">
<list-item><label>1)</label><p>SNCR;</p></list-item>
<list-item><label>2)</label><p>SCR; or</p></list-item>
<list-item><label>3)</label><p>combination of SNCR and SC.</p></list-item></list>
</list-item>
<list-item><label>b)</label><p>Type of Ammonia or Urea Flow Control Unit (AFCU):</p></list-item>
<list-item><label>c)</label><p>SNCR with one of the following reactant and carrier streams:</p>
<list id="L3" list-type="order">
<list-item><label>1)</label><p>aqueous ammonia based with one of the following reactant charge methods:</p>
<list id="L4" list-type="roman-lower">
<list-item><label>i)</label><p>mixed with a heated air stream in an ammonia vaporizer/mixer, or directly vaporized in a once through vaporizer before mixing with one of the following carriers:</p>
<list id="L5" list-type="roman-upper">
<list-item><label>I)</label><p>air, or</p></list-item>
<list-item><label>II)</label><p>steam.</p></list-item></list>
</list-item></list>
</list-item>
<list-item><label>2)</label><p>anhydrous ammonia based with the following reactant charge method:</p>
<list id="L6" list-type="roman-lower">
<list-item><label>i)</label><p>vapor mixed directly with one of the following carriers:</p>
<list id="L7" list-type="roman-upper">
<list-item><label>I)</label><p>air, or</p></list-item>
<list-item><label>II)</label><p>steam.</p></list-item></list>
</list-item>
<list-item><label>ii)</label><p>urea based with the following reactant charge method:</p></list-item></list>
</list-item></list>
</list-item></list>
...
Example 2: Unlabeled List and List Title
The following example shows the proper styling of an unlabeled (or, unnumbered) list that is introduced by a list title.
Although List Title is applied to the title of these lists, a heading or numbered paragraph style (e.g., Head 1 or P2) should be applied to the numbered heading of the list, as appropriate.
Word Sample
XML Sample
Unlabeled List with List Titles
<list id="L9" list-type="simple">
<title>Type A - For panel mounted toggle switches and circuit breakers.</title>
<list-item><p>Style 1 - One-hole mounting, enclosed.</p></list-item>
<list-item><p>Style 3 - One-hole mounting, through.</p></list-item>
<list-item><p>Style 4 - Three-hole mounting, through.</p></list-item>
<list-item><p>Style 6 - One-hole mounting, miniature, enclosed.</p></list-item>
<list-item><p>Style 7 - One-hole mounting, subminiature, enclosed.</p></list-item>
<list-item><p>Style 8 - One-hole mounting, subminiature, through.</p></list-item>
<list-item><p>Style 9 - Five-hole mounting, through.</p></list-item>
<list-item><p>Style 10 - Panel bushing seal only.</p></list-item></list>
<list id="L10" list-type="simple">
<title>Type B - For bushing mounted pushbutton switches.</title>
<list-item><p>Style 1 - One-hole mounting adapter type.</p></list-item>
<list-item><p>Style 2 - One-hole mounting drilled panel.</p></list-item>
<list-item><p>Style 3 - One-hole mounting through.</p></list-item>
<list-item><p>Style 4 - One-hole mounting miniature, drilled panel.</p></list-item>
<list-item><p>Style 5 - Three-hole mounting (for telephone handset switches).</p></list-item></list>
Example 3: Complex Lists
If a single item in the list is made up of more than one paragraph, a List Continued style must be used for the continuation paragraphs; otherwise, the subsequent paragraphs will be exported as separate list items.
Also, it may be necessary to interrupt a list with an object, such as an image. eXtyles STS Export can support this format gracefully, so long as the object has an associated caption.
Word Sample
Contact Inera if your content will include other types of content that may interrupt a list. You may need specific paragraph styles to support that structure.
XML Sample
Object in a List and List Continued
<list id="L2" list-type="order">
<list-item><label>1.</label><p>Expanded metallization is metallization that increases in area (example, metal line to bond pad area): <fig id="fig_1" position="anchor" fig-type="figure"><label>Figure 1</label><caption><title>Example of expanded metallization</title></caption><graphic xlink:href="jms10-fig_1"/></fig></p>
<p>Failure analysis (FA) is the discipline incorporating all techniques of physical, chemical and electro-magnetic (EM) characterization of product and materials to isolate the mode of failure and define the mechanism of occurrence. </p></list-item>
<list-item><label>2.</label><p>FA is used as an integral tool in root cause determination and process-segment targeting in the corrective action procedure </p></list-item></list>
Example 4: Term and Definition List Item
For the purposes of eXtyles, an abbreviations or glossary paragraph is a list of two or more term–definition pairs in a single paragraph. The Term and Definition List Item paragraph style should be used to style abbreviations and other similar content.
Similar to keywords, for parsing of abbreviations eXtyles uses strong and weak characters in turn to attempt to separate the paragraph into its elements.
Strong characters are:
tabs,
(semi)colons
em dashes.
Weak characters are:
en dashes
commas.
Additionally, terms formatted in bold will also produce correct XML.
Consistent use of strong separator characters or bold formatting is crucial to obtaining accurate XML.
The following example shows the proper styling of a term and definition list. This example is of an Abbreviations list.
Word Sample
In general, a character that is used within an abbreviation or definition cannot be used to separate and abbreviation and its definition in an abbreviation-definition pair.
Example:
This abbreviations list would not be parsed correctly because a comma appears in the first definition:
ExPEC, extra-intestinal, pathogenic Escherichia coli
UTI, urinary tract infection
XML Sample
The use of tabs in the Word document between the term and definition enables eXtyles to parse the <term> from the <definition> in the XML. Other such separators include periods, colons, em dashes, and bold formatting of the term.
Abbreviations Term and Definition List
Copyright © 2022 Atypon Systems, LLC. All Rights Reserved.