glossStatus
Identifies the usage status of a preferred or alternate
term. If the status isn't specified, the <glossterm> provides a
preferred term and an alternate term provides an allowed term.
Note
The values provided by the glossStatus element
are extensible using DITA's Controlled Values mechanism. If validation
is required, they should be validated using that mechanism rather
than by encoding values directly within the XML declaration.
Should
this include a link to the controlled values information?
Contains
Note
These models represent only the default document types distributed by OASIS.
Actual content models will differ with each new document type.
| Doctype | Content model |
|---|---|
| ditabase, glossary, glossentry, glossgroup | no content |
Contained by
| Doctype | Content model |
|---|---|
| ditabase, glossary, glossentry, glossgroup | glossBody, glossAlt |
Inheritance
- topic/data concept/data glossentry/glossStatus
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? |
|---|---|---|---|---|
| name | Defines a unique name for the object. | CDATA | #IMPLIED | No |
| datatype | Describes the type of data contained in the value attribute or within the data element. A typical use of datatype will be the identifying URI for an XML Schema datatype. | CDATA | #IMPLIED | No |
| value | Specifies the status of an alternate form of a glossary term. For example, it may indicate that an alternate form is obsolete. | CDATA | #IMPLIED | No |
| href | Provides a reference to a resource. See The href attribute for detailed information on supported values and processing implications. | CDATA | #IMPLIED | No |
| format | The format attribute identifies the format of the resource being referenced. See The format attribute for details on supported values. | CDATA | #IMPLIED | No |
| type | Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications. | CDATA | #IMPLIED | No |
| scope | The scope attribute identifies the closeness of the relationship between the current document and the target resource. See The scope attribute for more information on values. | (local | peer | external | -dita-use-conref-target) | #IMPLIED | No |
| univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | A set of related attributes, described in univ-atts attribute group | |||
| global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
| class, outputclass | Common attributes described in Other common DITA attributes |