3.2.4.1.3 glossdef

The <glossdef> element specifies the definition of one sense of a term. If a term has multiple senses, create a separate <glossentry> topic to define each sense.

Contains

Doctype

Content model

ditabase, glossary, glossentry, glossgroup

( text data or dl or parml or fig or syntaxdiagram or imagemap or image or lines or lq or note or hazardstatement or object or ol or p or pre or codeblock or msgblock or screen or simpletable or sl or table or ul or boolean or cite or keyword or apiname or option or parmname or cmdname or msgnum or varname or wintitle or ph or b or i or sup or sub or tt or u or codeph or synph or filepath or msgph or systemoutput or userinput or menucascade or uicontrol or q or term or abbreviated-form or tm or xref or state or data or data-about or foreign or unknown or shortdesc or draft-comment or fn or indextermref or indexterm or required-cleanup) (any number)

Contained by

Doctype

Content model

ditabase, glossary, glossentry, glossgroup

glossentry

Inheritance

- topic/abstract concept/abstract glossentry/glossdef

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?

univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)

A set of related attributes, described in 3.4.1.3 univ-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.2 glossterm

Next Topic:  3.2.4.1.4 glossAbbreviation

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.4 glossAbbreviation

3.2.4.1.5 glossAcronym

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