Versions Compared
Version | Old Version 12 | New Version Current |
---|---|---|
Changes made by | ||
Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This section illustrates how paragraph styles should be used in standards documents processed with eXtyles STS. The paragraph styles included in this guide are named as they appear on the eXtyles Paragraph Style palette.
Info |
---|
The eXtyles STS Paragraph Style can be customized for your organization. If you don't see a paragraph style you think you need or would like to rename or reorganize a button on the palette, contact Inera for more information at extyles-support@inera.com. |
Panel | ||
---|---|---|
| ||
|
Navigation
In addition to facilitating the application of paragraph styles, the eXtyles style palette enables quick and flexible navigation through your document via the controls on the bottom of the palette. By using these controls to navigate through and manipulate your content, you can remain within the style palette, which allows you to move more efficiently through the document.
Tip |
---|
Underlined letters on the palette buttons designate hot keys. For example, when the style palette is active (i.e., you have clicked into it) you can type "x" on your keyboard to skip to the next paragraph, or "d" to delete a paragraph. If you don't see the underlined hot keys when you open the eXtyles style palette you may need to adjust your Windows Ease of Access settings. See Inera's FAQ, "Paragraph styling menu hotkeys are missing in Word 2013 and 2016" for instructions about how to adjust these settings. |
Button | Description |
---|---|
With prev | Click “With prev” to merge the selected paragraph with the previous one (the carriage return between them is replaced with a space). Use this function to merge an unwanted heading into the paragraph following it, for instance, or if two paragraphs are separate but should be one |
New pgraf | Click “New pgraf” to insert a return after the first sentence of the paragraph, creating two paragraphs from one. This feature is designed primarily to allow faster formatting of run-in heads. The new paragraph will be created after the first period, colon, question mark, hyphen, or en dash that is followed by a space, or an em dash (in this case, regardless of a following space). To format a two-sentence head, select “New pgraf,” apply the correct style for the heading, select “New pgraf” again, and then select “With prev.” If a paragraph does not have more than one sentence, selecting “New pgraf” will not do anything. |
Previous | Click “Previous” to move the highlight to the previous paragraph. |
Next | Click “Next” to advance to the next paragraph without changing the style of the selected paragraph. |
Delete | Click “Delete” to remove the selected paragraph from the document and advance to the next paragraph. |
Undo | Click “Undo” (as many times as necessary) to undo the last operations. |
Warning |
---|
The “Undo” history is cleared when you click into the Word document or close the palette. The Undo button will be greyed out when the Undo history is cleared, indicating that you can not Undo the previous action from the palette. |
Additional Actions
The behavior of the navigation buttons on the eXtyles style palette can be modified when used in combination with other keyboard items.
Tip |
---|
A cheat-sheet of eXtyles paragraph styling shortcuts is available in the eXtyles Tools, "eXtyles Shortcut Keys," section of this documentation. |
Button | Description |
---|---|
Shift + Next (x) | If you hold Shift while clicking “Next” (or, typing the hotkey “x”), eXtyles will skip all paragraphs tagged with the current paragraph’s style, stopping at the next new paragraph style. |
Shift + Table Body | If you hold Shift while clicking the Table Body style, eXtyles will apply the table body style to the entire table; that is, all of the content formatted within Word's table cells. |
Tab | Within the style palette, you can use the Tab (and Shift + Tab) keys on the keyboard to switch between the different style tabs on the palette. |
Esc | The Esc key will close the palette. |
The Paragraph Styles dialog closes automatically after the document is completely styled. If you need to close the dialog in the middle of processing, click the X box in the upper-right corner or press Esc. You can reopen this dialog at any time, and styling will continue with the paragraph where the cursor is currently located.
Tip |
---|
After you style a document, you can easily navigate through it by jumping from heading to heading using Word’s Document Map feature. To use Word’s Document Map feature, check the box in View > Navigation Pane. |
Style Palette Tabs
Title
Each document information element on the title page must have the correct corresponding paragraph style applied to it for the information to be successfully structured and labeled in the exported XML.
Info |
---|
See here for examples of the use of Title styles. |
Style Name | Description of Use |
---|---|
Measurement | The paragraph indicating the measurement units used throughout the standard* |
Document ID | The standard’s ID or designation string, usually how you would cite the document in your own content |
Edition | The edition information, if present |
Date | The specification date |
Supersedes | The text “SUPERSEDES,” if present |
Supersedes Designation | The designation (or ID) of the standard that is superseded by the document |
Supersedes Edition | The edition of the superseded document, if present |
Supersedes Date | The date of the superseded document |
Title Prefix | The prefix of the title, which usually indicates the type of document or specification |
Document Title | The primary title of the document |
Document Subtitle | The subtitle of the document |
Subject Group | Categorical information about the document |
Authorization | Name of the authorizing organization |
Standard Organization Role | Text such as "Developed by" or other indicators or what role an organization had in the creation of the document |
Standard Organization | Name of the organization publishing the document |
Accrediting Organization | Name of the agency that accredited the publisher of the standard |
Distribution Info | The paragraph describing the intended audience of the document |
Contact Info | The contact information associated with the document |
Publisher Location | The location of the publisher |
Copyright | The copyright information |
Permissions | Permissions information |
ISSN/ISBN | The ISSN or ISBN, if present |
Non-XML Text/Graphics | Text that should not appear in the XML (e.g., table of contents) |
* If a specified unit of measurement is not applicable to the document, then this style may be applied to the text “NOT MEASUREMENT SENSITIVE” or synonymous string.
Front
eXtyles STS includes paragraph styles for many specific parts of the front matter of standards documents.
Info |
---|
See here for examples of the use of Front styles. |
Style Name | Description of Use |
---|---|
Author | Paragraph containing the names of the authors of the standard |
Affiliation | Paragraph(s) that list the authors’ affiliations |
Meta-Note Title | The title of a note that applies to the entire standard |
Meta-Note Text | The text of a note that applies to the entire standard |
Abstract Head | The title “Abstract” |
Abstract | The text of the abstract |
Keywords | The list of keywords |
Acknowledgment Head | The title “Acknowledgment” |
Acknowledgment | The acknowledgment text |
Front Matter Head 1 | A front matter section level-1 heading that does not have its own specific style |
Front Matter Head 2 | A front matter section level-2 subheading |
Front Matter Head 3 | A front matter section level-3 subheading |
Front Matter Head 4 | A front matter section level-4 subheading |
Front Matter Text | The text of a front matter section |
Non-Normative Note | Non-normative notes that may appear in the front matter |
Committee Title | The title of a committee under which members and affiliations are listed |
Committee Member | The members of a committee |
Committee Member Affiliation | The affiliations of committee members |
Non-XML Text/Graphics | Text that should not appear in the XML (e.g., table of contents) |
Body
Styles on the Body tab should be used to style the content of the body of the standard.
Info |
---|
See here for examples of the use of Body styles. |
Style Name | Description of Use |
---|---|
Head 1 | The level-one heading that appears in stand-alone paragraphs |
Head 2 - Head 6 | The levels 2–6 headings that appear in stand-alone paragraphs |
P2 | First numbered paragraph following a Head 1; typically:
|
P3 - P6 | Third- through sixth-level numbered paragraphs; typically:
|
Paragraph | Regular body paragraphs, not those specified as a numbered or otherwise specialized paragraph |
Paragraph Continued | Body paragraphs that indicate the continuation of a specific level of paragraph |
TermNum | The term number in the Terms/Definitions section; stand-alone paragraph |
Term(s) | The term in the Terms/Definition section |
Definition | The definition of the term in the Terms/Definition section |
Applicable Documents Head | A heading that precedes a list of applicable documents. Not the same as Heading 1; e.g., “2 Normative References” |
Applicable Documents | The list of applicable documents (normative references) |
Block Quote | A display, or block, quote |
Equation | An equation that is on its own line (i.e., not in-line) |
Preformatted Text | Computer code or other monospace text |
Numbered/Bulleted List Level 1 | A level one numbered/bulleted list |
Figure Caption | The caption for an image; typically includes a label (e.g., “Figure 1”) |
Non-Normative Note | A non-normative note; typically includes a label (e.g., NOTE, WARNING, etc.) |
Non-XML Text | Text that should not appear in the XML |
List
Info |
---|
See here for examples of the use of List styles. |
Style Name | Description of Use |
---|---|
List Title | The title of a list, if present; semantically distinct from a section heading (e.g., Heading 1) |
Numbered/Bullet List Level 1 | The primary level of a bulleted or numbered list (labeled list) |
Numbered/Bullet List Level 2 | A second-level bulleted or numbered sublist (labeled list) |
Numbered/Bullet List Level 3 -5 | Third- through fifth-level bulleted or numbered sublist (labeled list) items |
Continued List Item Level 1 | A continuation paragraph of a level-one list item; typically does not include a label (e.g., 1., 2.) |
Continued List Item Level 2 - 5 | A continuation paragraph of a second- through fifth-level list item; ; typically does not include a label (e.g., 1., 2.) |
Unnumbered List | An unlabeled list; that is, a list item that does not include either a number or bullet |
Term and Definition List Item | A list item that is made up of a term/definition pair; e.g., an abbreviations list or glossary |
Definition List Item Continued | A continuation paragraph for a term/definition list item |
Non-Normative Note In List Item | A non-normative note paragraph that appears within either a labeled or unlabeled list |
Non-XML Text | Text that should not appear in the XML |
Warning |
---|
Term and Definition List Items must have the term and definition separated by either a tab, colon, or em dash. eXtyles will use these "separator" characters to parse the term from the definition during XML export. Absent a separator, XML export will most likely provide a warning indicating that a term and definition pair could not be determined when the Term and Definition List paragraph style has been used. |
Object
Styles on the Object tab should be used to style the components of the various object types that can appear in the standard; for example, figures, tables, and so on.
Info |
---|
See here for examples of the use of Object styles. |
Style Name | Description of Use |
---|---|
Table Title | The title of a table; typically contains a label (e.g., “Table 1”) |
Table Title Continued | The continuation paragraph of a table title, if present |
Table Accessibility Caption | The accessibility caption for a table, if present |
Table Head | The column head of a table |
Table Body | The body text of a table |
Table Footnote | The footnote(s) of a table |
Figure Caption | The caption of a figure; typically contains a label (e.g., “Figure 1”) |
Figure Accessibility Caption | The accessibility caption for a figure, if present |
Figure Captioned Continued | The continuation paragraph of a figure caption |
Figure Credit | The credit/source information for a figure; typically in a separate paragraph from the figure caption |
Figure Graphic | The image itself, if present in the document |
Footnote | Footnote text, if present; footnote numbers (e.g., 1., 2.) will be matched during eXtyles Citation Matching |
Non-XML Text | Text that should not appear in the XML |
Back
Styles on the Body tab should be used to style back matter content for the standard; for example, appendices and bibliographies.
Info |
---|
See here for examples of the use of Back styles. |
Style Name | Description of Use |
---|---|
Appendix Title | The title of an appendix; may or may not include the label “Appendix” or a label (e.g., “Appendix 1” or “Appendix A”) |
Appendix Head 1 | A level-one Appendix heading that appears in stand-alone paragraphs |
Appendix Head 2 | A level-two Appendix heading that appears in stand-alone paragraphs |
Appendix Head 3 | A level-three Appendix heading that appears in stand-alone paragraphs |
Appendix Text | The body text of an appendix |
Bibliography Head | The title of a bibliography that appears at the end of the standard |
Bibliography Reference | The bibliography items |
Non-Normative Note | A non-normative note; typically includes a label (e.g., NOTE, WARNING, etc.) |
Footnote | Footnote text, if present; footnote numbers (e.g., 1., 2.) will be matched during eXtyles Citation Matching |
Non-XML Text | Text that should not appear in the XML |