Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. 



Panel
bgColor#b5b8bc

Back to the Style Guide



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,

Panel

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

Code Block
<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>



Panel
titleOn This Page

Table of Contents


Supplement Content in the Document

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

Panel
Image RemovedImage Added

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 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

Code Block
languagexml
<para style="last-para" type="flush"><supp-text><title-group><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> <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; <emphasis type="italic">See National Fed&#x2019;n of Indep. Businesses v. Perez</emphasis>, No. 5:16-cv-00066, 2016 WL 8193279 (N.D. Tex. Sept. 8, 2016) (unpublished). The lawsuit seeks a declaratory judgment that OSHA acted &#x201C;arbitrarily and capriciously&#x201D; in issuing the rule and did not afford the public an opportunity to comment on the rule before its promulgation. NFIB also sought to enjoin OSHA from enforcing the rule.</para></instruction-content>

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:

Code Block
languagexml

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.). For example, the above Word example exports as:


Note

Supplement Start and Supplement End paragraphs must contain text. The start and end paragraphs are dropped during XML export, so they do not appear in the XML.


Code Block
languagexml
<para type="flush" style="last-para"><supp-text><instruction-content><para type="flush" style="last-para">However, the law excludes, as employees for minimum-wage purposes, ...</para></instruction-content></supp-text>Special minimum rates may be paid to golf caddies, ....</para>

Notice that the supplement content is contained within the primary text paragraph, and the start and end supplement paragraphs are not present.