<glossUsage>

The <glossUsage> element provides information about how to use the term that is specified in the <glossterm> element. It also can be used to provide usage information for acronyms or synonyms.

Specialization hierarchy

The <glossUsage> element is specialized from <note>. It is defined in the glossary entry module.

Content model

(Text | <audio> | <dl> | <div> | <example> | <fig> | <image> | <lines> | <lq> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <q> | <term> | <text> | <tm> | <xref> | <data> | <foreign> | <draft-comment> | <fn> | <indexterm> | <required-cleanup>)*

Contained by

<glossAlt>, <glossBody>

Zero or more of the following
  • Text
  • <audio>
  • <cite>
  • <data>
  • <div>
  • <dl>
  • <draft-comment>
  • <example>
  • <fig>
  • <fn>
  • <foreign>
  • <image>
  • <include>
  • <indexterm>
  • <keyword>
  • <lines>
  • <lq>
  • <object>
  • <ol>
  • <p>
  • <ph>
  • <pre>
  • <q>
  • <required-cleanup>
  • <simpletable>
  • <sl>
  • <table>
  • <term>
  • <text>
  • <tm>
  • <ul>
  • <video>
  • <xref>

Contained by

Inheritance

- topic/note concept/note glossentry/glossUsage

The <glossUsage> element is specialized from <note>. It is defined in the glossentry module.

Attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target

The following attributes are available on this element: universal attributes and the attributes defined below.

@othertype
Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.
@type
Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:
  • attention
  • caution
  • danger
  • important
  • note
  • notice
  • other
  • remember
  • restriction
  • tip
  • trouble
  • warning
  • -dita-use-conref-target

Example

This section is non-normative.

The following code sample shows how the <glossUsage> element is used to provide additional information about possible variants for the term "soft drink:"

<glossentry id="softdrink">
  <glossterm>soft drink</glossterm>
  <glossdef>A nonalcoholic drink, especially one that is carbonated.</glossdef>
  <glossBody>
    <glossAlt>
      <glossSynonym>pop</glossSynonym>
      <glossUsage>Used primarily in the North and Midwest</glossUsage>
    </glossAlt>
    <glossAlt>
      <glossSynonym>soda</glossSynonym>  
      <glossUsage>Used primarily in the West and Northeast</glossUsage>
    </glossAlt>
    <glossAlt>
      <glossSynonym>Coke</glossSynonym>
      <glossUsage>Used primarily in the South</glossUsage>
    </glossAlt>
  </glossBody>
</glossentry>