In an XML workflow it is important to ensure that sections of a document are organized in correct hierarchical order; for example, the Heading 2 style should never be used before Heading 1, because Heading 2 denotes a section that is subordinate to a main section (indicated with Heading 1).
Heading levels should therefore not be used because they “look right,” but, rather, because they reflect the correct structure of the document.
Section Title and Abstract
The Section Title style should be used when a report is separated into multiple parallel sections; for example, a report that has two sections each with their own reference list or appendices.
The use of Section Title in this case creates distinct “parts” in the XML, which ensures that section-level material remains in the correct location (e.g., appendices or reference lists).
Document Headings
Document subheadings should be used to impose correct structure on the document. For example, the first heading in the body of a document (that is not a Section Title) should always be Heading 1, followed by Heading 2, Heading 3, and so on, as appropriate.
Subheadings will “nest” into their parent section during XML export, which ensures that the proper document structure is maintained.
Numbered Headings 1-6
The paragraph styles Heading 1 through Heading 6 on the Body tab of the eXtyles palette are formatted to apply auto-numbering per the appropriate heading level and per the appropriate section. For example,
Word
XML
<body> <sec id="sec1"> <label>1</label><title>ECONOMIC ENVIRONMENT</title> <sec id="sec1.1"> <label>1.1</label><title>Main Features of the Economy</title> <p>1.1.  Switzerland is a high-income country whose wealth is highly dependent on international trade....</p> </sec> </sec> </body>
In the example, you can see that the Heading 2 section (<sec>) is “nested” within the Heading 1 section; that is, Heading 1’s <sec> does not close (</sec>) before Heading 2’s <sec> begins.
Note also that the heading numbers are automatically correctly tagged as <label> in the XML, and a section id is automatically added to the XML for each section; for example, heading 1.1 has id="sec1.1".
Headings 3-6 behave similarly, with appropriate auto-numbering applied in Word and correct section nesting and id’s assigned in the XML.
Unnumbered Headings 2-9
eXtyles also supports unnumbered headings that may appear in documents. Starting with heading level 2, you can use the Heading 2, 3, 4, 5, 6 Unnumbered options on the Body tab of the style palette to style unnumbered headings at the appropriate, semantically correct level. By default, the styles Heading 7, Heading 8, and Heading 9 are not numbered.
Word
XML
<sec id="sec1.2"> <label>1.2</label><title>Recent Economic Developments</title> <p>1.3.  The Swiss economy has shown resilience in a difficult environment, faced with headwinds from the economic problems in the euro zone and a strong Swiss franc. Since the last trade policy review in 2013, the economy has continued to grow (1.5% on average during the period 2013-15), accompanied by low unemployment (in the range of 4-4.5%, based on ILO methodology) (<xref ref-type="table" rid="t01.01">Table 1.1</xref>).</p> <sec> <title>Monetary policy</title> <p>1.4.  In the course of 2011, the debt crisis in the euro zone and a high degree of uncertainty in the financial markets triggered a flight to safe havens by investors, which prompted a strong appreciation of the Swiss franc (<italic>vis‑à‑vis</italic> the euro...</p> </sec> </sec>
Key Messages Title
Key Messages sections must begin with a title styled using the Key Messages Title paragraph style. This ensures that the content is uniquely tagged in the XML, which allows it to be rendered differently from the other body text.
For example,
Produces the following XML (note the sec-type="key-message" attribute, which uniquely identifies this section from other body text):
<sec sec-type="key-message" id="S2"> <title>Key Messages</title> <p>Following are key messages for this report.</p> <list id="L2" list-type="order"> <list-item><p>Here are some key messages</p></list-item> <list-item><p>Some more</p></list-item> <list-item><p>The last one</p></list-item></list> </sec>
Lists
All lists, regardless of the symbol or number that precedes them, should be styled with the appropriate list level paragraph style. During XML export, eXtyles will identify the list type, and assign the proper identifying attribute in the XML (e.g., ordered, bulleted, alpha).
List Level 1 should be used for all primary list items, and Levels 2-4 should be used as appropriate for sublist items. For example:
Which produces the following XML:
<p>The research questions for the review are the following:</p> <list id="L1" list-type="order"> <list-item><p>For adults with type 2 diabetes on metformin monotherapy with inadequate glycemic control, what is the comparative efficacy and safety of using a drug from one of the following classes as a second-line drug?</p> <list id="L2" list-type="alpha-lower"> <list-item><p>Sulfonylurea</p></list-item> <list-item><p>Insulin</p></list-item> <list-item><p>DPP-4 inhibitor</p></list-item> <list-item><p>GLP-1 analogue</p></list-item> <list-item><p>SGLT-2 inhibitor.</p></list-item> </list> </list-item> </list>
If a list item contains more than one paragraph, the List Continued styles of the appropriate level should be used. For example,
Produces the following XML:
<list id="L12" list-type="bullet"> <list-item><p>In BEAUTIFUL, 10,917 patients with stable coronary artery disease that met the inclusion criteria of LVEF < 40% were enrolled. The mean LVEF at baseline was 32.4% (SD 5.5) and 32.3% (SD 5.5). </p> <p>Ivabradine showed no significant improvement in cardiac outcomes compared with placebo. In a pre-specified subgroup of patients with a baseline heart rate of ≥70 beats per minute (bpm), ivabradine reduced the incidence ...</p> </list-item> <list-item><p>In SHIFT, 6,558 patients with symptomatic HF that met the inclusion criteria (LVEF of ≤ 35%, in sinus rhythm with a heart rate of ≥70 bpm, admitted to hospital for worsening HF within the previous 12 months, and on stable background treatment of a beta blocker) were enrolled.</p> </list-item> </list>
Add Comment