<abbrev> Abbreviation or Acronym
Abbreviation, acronym, or emoticon used in the text of a document, possibly including an expansion of the acronym.
The <abbrev> element is intended for marking abbreviations in running text, and not for the documentation of common abbreviations in a list of symbols and abbreviated terms.
Although an abbreviation is typically a few capitalized letters (“NIH”, “WHO”, “UN”, or “GAO”), emoticons (“;-)”) can also be tagged as abbreviations (“smile-wink”).
Internal links to an abbreviation %mdash; The <xref> element can be used to point to an abbreviation from within the narrative text of a standard. For this use, the @ref-type attribute should be set to “abbreviation”:
..<xref ref-type="abbreviation" rid="abbr-rat" >...</xref>..
External links from an abbreviation %mdash; The XLink linking attributes on the <abbrev> element can be used to provide a live link to an external expansion, definition, or additional explanation of the abbreviation.
Sometimes an <abbrev> needs to be pronounced in a way that is not reflected in its content or its tagging. The @alt attribute can be used to record the pronunciation for screen readers and other accessibility devices. For example, the abbreviation “WHO” might be better pronounced as “World Health Organization” or as “W.H.O.” than as “who”as the word would normally be. The @alt attribute can also be used to provide the textual interpretation of a symbol such as an emoticon (for “;-)” use “alt="smile-wink"”).
xlink:type (fixed value = simple)
xmlns:xlink (fixed value = http://www.w3.org/1999/xlink)
Models and Context
May be contained in
<addr-line>, <alt-title>, <article-title>, <attrib>, <award-id>, <bold>, <chapter-title>, <code>, <collab>, <comment>, <compl>, <def-head>, <element-citation>, <fixed-case>, <full>, <funding-source>, <inline-code>, <intro>, <italic>, <license-p>, <main>, <meta-value>, <mixed-citation>, <monospace>, <named-content>, <overline>, <p>, <part-title>, <preformat>, <roman>, <sans-serif>, <sc>, <see>, <see-also>, <see-also-entry>, <see-entry>, <source>, <strike>, <styled-content>, <sub>, <subtitle>, <sup>, <supplement>, <td>, <term>, <term-head>, <th>, <title>, <trans-source>, <trans-subtitle>, <trans-title>, <underline>, <verse-line>
<!ELEMENT abbrev (#PCDATA %abbrev-elements;)* >
Expanded Content Model
(#PCDATA | def)*
... <p>... The first time an abbreviation is used in text, it shall be placed in parentheses and shall be preceded by the word or term spelled out in full (for example, circuit (<abbrev>ckt</abbrev>), frequency converter (<abbrev>freq conv</abbrev>), and maximum working pressure (<abbrev>mwp</abbrev>)). ...</p> ...
... <list-item> <label>f.</label> <p>Replacement of the DoD Index of Specifications and Standards (<abbrev>DoDISS</abbrev>) with the Acquisition Streamlining and Standardization Information System (<abbrev alt="A.S.S.I.S.T.">ASSIST</abbrev>) database.</p> </list-item> ...