3.2.4.1.5 glossAcronym

The <glossAcronym> element defines an acronym as an alternate form for the term defined in the <glossterm> element.

This element may be used together with the <abbreviated-form> element to display an expanded version of an acronym the first time that acronym appears in a set of text. See <abbreviated-form> for information on how the two elements interact.

Several issues arise when acronyms are translated into other languages. For example, an acronym in one language may not have an equivalent in another language. When acronyms are first displayed, some languages will display the expanded form first followed by the acronym in parenthesis, while other languages do the reverse. For some acronyms, a translation may need to render both the original and the translated version of the acronym. For all of these reasons, DITA allows an author or translator to control what is presented to a reader by using the <glossSurfaceForm> element, which will often accompany the <glossAcronym>. The <abbreviated-form> topic contains information on how the <glossSurfaceForm> and <glossAcronym> elements affect references to the primary term.

Contains

Doctype

Content model

ditabase, glossary, glossentry, glossgroup

( text data or keyword or apiname or option or parmname or cmdname or msgnum or varname or wintitle or term or abbreviated-form or tm) (any number)

Contained by

Doctype

Content model

ditabase, glossary, glossentry, glossgroup

glossAlt

Inheritance

- topic/title concept/title glossentry/glossAcronym

Example

The glossary term "USB flash drive" with additional information

<glossentry id="usbfd">
  <glossterm>USB flash drive</glossterm>
  <glossdef>A small portable drive.</glossdef>
  <glossBody>
    <glossPartOfSpeech value="noun"/>
    <glossUsage>Do not provide in upper case (as in "USB Flash
Drive") because that suggests a trademark.</glossUsage>
    <glossAlt>
      <glossAcronym>UFD</glossAcronym>
      <glossUsage>Explain the acronym on first occurrence.</glossUsage>
    </glossAlt>
    <glossAlt id="memoryStick">
      <glossSynonym>memory stick</glossSynonym>
      <glossUsage>This is a colloquial term.</glossUsage>
    </glossAlt>
    <glossAlt>
      <glossAbbreviation>stick</glossAbbreviation>
      <glossStatus value="prohibited"/>
      <glossUsage>This is too colloquial.</glossUsage>
      <glossAlternateFor href="#usbfd/memoryStick"/>
    </glossAlt>
    <glossAlt>
      <glossAbbreviation>flash</glossAbbreviation>
      <glossStatus value="prohibited"/>
      <glossUsage>This short form is ambiguous.</glossUsage>
    </glossAlt>
  </glossBody>
</glossentry>
Attributes

Name

Description

Data Type

Default Value

Required?

base

A generic attribute that has no specific purpose. It is intended to act as a base for specialized attributes that have a simple value syntax like the conditional processing attributes (one or more alphanumeric values separated by whitespace), but is not itself a filtering or flagging attribute.

CDATA

#IMPLIED

No

id-atts attribute group (id, conref, conrefend, conaction, conkeyref)

A set of related attributes, described in 3.4.1.4 id-atts attribute group

     

localization-atts attribute group (translate, xml:lang, dir)

A set of related attributes, described in 3.4.1.6 localization-atts attribute group.

     

global-atts attribute group (xtrf, xtrc)

A set of related attributes, described in 3.4.1.2 global-atts attribute group

     

class, outputclass

Common attributes described in 3.4.1.9 Other common DITA attributes

     

Previous Topic:  3.2.4.1.4 glossAbbreviation

Next Topic:  3.2.4.1.6 glossAlt

Parent Topic:  3.2.4.1 Glossentry elements

Sibling Topics:

3.2.4.1.1 glossentry

3.2.4.1.2 glossterm

3.2.4.1.3 glossdef

3.2.4.1.4 glossAbbreviation

3.2.4.1.6 glossAlt

3.2.4.1.7 glossAlternateFor

3.2.4.1.8 glossBody

3.2.4.1.9 glossPartOfSpeech

3.2.4.1.10 glossProperty

3.2.4.1.11 glossScopeNote

3.2.4.1.12 glossShortForm

3.2.4.1.13 glossStatus

3.2.4.1.14 glossSurfaceForm

3.2.4.1.15 glossSymbol

3.2.4.1.16 glossSynonym

3.2.4.1.17 glossUsage