Supplements

eXtyles can support the inclusion of supplement text by the use of the supplement styles on the Front tab of the style palette. Only a few styles specific to supplement content exist, because regular text paragraph styles can be used for supplement content that is contained between Supplement Start and Supplement End paragraphs. 



Supplement Author and Supplement Text

If a document has supplement information, the supplement authors and the description of the supplemented text should be added to the top of the document and styled with the Supplement Author and Supplement Text paragraph styles from the Front tab of the style palette. For example,

This text will be output to the <meta-data> block in the XML:

<meta-data>
. . .
<supp-info>
<supp-author>Eric E. Hobbs</supp-author>
<supp-author>Jesse R. Dill</supp-author>
<supplement-text>Book sections supplemented: 7.1, 7.54, 7.64, and 7.125</supplement-text>
</supp-info>
</meta-data>
On This Page

Supplement Content in the Document

Supplement content can be added to the original Word document in the appropriate location; for example,

Supplement Start and Supplement End Styles

These two paragraph styles must be used to indicate the beginning and end of the supplement content. This facilitates the use of regular paragraph styles for the content of the supplement; that is, the start and end styles tell eXtyles that the content within is supplement content, even though regular paragraph styles are used for the supplement content. 

The content within the start and end supplement paragraphs will be tagged in the XML as <supp-text><instruction-content>, and then whatever is appropriate for the actual content (e.g., <para>, <list-item>, <admon>, etc.).

The Supplement Start and Supplement End paragraph styles are dropped during XML export, so they will not be present in the XML. Note the following important information about the use of Supplement Start and Supplement End:

  1. Supplement Start and End paragraphs are required at the start and end of supplement content
  2. The paragraphs must contain content: in the above example a nonbreaking space is used, but any content will suffice
  3. The start and end paragraphs will be dropped from the XML; that is, the content in the paragraphs will not be present in the XML that is generated from eXtyles

Supplement Head and Instruction

The Supplement Head style should be used to style the heading that the supplement text pertains to. The Instruction style should be used to style the descriptive content of the supplement, as shown in the previous example. The resulting XML will be:

<supp-text><title-group><number>7.54</number> <title>[OSHAct and OSHA Standards and Regulations] [OSHAct&#x2019;s Requirements] [Safety and Health Standards–Generally] Interpretation</title></title-group>
<instruction-head>Pages 36&#x2013;37: Read in conjunction with section</instruction-head>
. . .

Supplement Content

As mentioned, text within the Supplement Start and End paragraphs can be styled using the regular paragraph styles in the eXtyles configuration. The content will be tagged as <instruction-content> within the <supp-text> block. For example, the text from the previous Word sample will produce the following XML:

<instruction-content><para style="last-para" type="flush">On September 8, 2016, the National Federation of Independent Business (NFIB) filed a federal court complaint in Dallas, Texas, seeking to strike down what has become known as OSHA&#x2019;s &#x201C;union walk-around rule.&#x201D; . . .</para></instruction-content>