<glossref>

The <glossref> element is a convenience element in maps for creating a reference to a glossary topic. It has a required @keys attribute, which forces the author to create a key by which inline terms can reference their definition. For example, when <glossentry> topics are used to define acronyms, this reminds authors to create a key which <abbreviated-form> elements can use to reference the short and expanded versions of that acronym.

Usage information

Note that the key value does not need to match the target term or acronym. In fact, using a more qualified value for the @keyref will reduce conflicts in situations where the same term or acronym might resolve in many ways. For example, an information set could use cars.abs as the key for the term Anti-lock Braking System, and ship.abs to refer to the term American Bureau of Shipping.

Specialization hierarchy

The <glossref> element is specialized from <topicref>. It is defined in the glossary reference domain module.

Attributes

The following attributes are available on this element: link-relationship attributes, universal attributes, @chunk, @collection-type, @keyref, @linking, @processing-role, @search, and @toc.

For this element:
  • The @href attribute is a reference to a glossary definigion, typically a <glossentry> topic.
  • The @keys attribute is required.
  • The @linking attribute has a default value of none.
  • The @toc attribute has a default value of no.

Example

<map>
  <!-- ... -->
  <topicref href="car-maintenance.dita"/>
  <!-- ... -->
  <glossref keys="cars.abs" href="antiLockBrake.dita"/>
  <!-- ... key declarations for other referenced acronyms ... -->
</map>