Créer un glossaire

Un glossaire est défini dans une carte DITA soit en utilisant topicref soit des éléments standards dans les rubriques d'entrée du glossaire, soit en ayant recours à des éléments glossref (introduits dans DITA 1.2).

Un glossaire est constitué de plusieurs petites rubriques glossentry, qui comprennent chacune un élément terme (glossterm) suivi d'un élément définition (glossdef). Le glossaire est constitué grâce au référencement de toutes les rubriques glossentry dans une carte DITA.

Dans DITA 1.2, au lieu d'utiliser l'élément topicref pour référencer les rubriques glossentry, vous pouvez utiliser l'élément glossref. L'élément glossref est spécialisé à partir de l'élément topicref, à ceci près qu'il possède un attribut keys obligatoire.

L'attribut keys est utilisé pour générer automatiquement des liens à partir des termes d'une rubrique vers la définition correspondante dans le glossaire. Les liens sont des liens indirects : un terme dans la rubrique est associé à une clé, et la cible de cette clé est définie dans la carte DITA. Cette méthode est appelée indirection.

L'échantillon de code ci-après permet de comparer les éléments topicref et glossref :
<topicref href="mechanical/g_abs_brake_system.dita" />

<glossref  href="mechanical/g_brake_system.dita" keys="abs" />

Pour préciser qu'un lien doit être généré à partir d'un terme vers une définition dans le glossaire lors de la publication, vous devez utiliser un élément term, ou la forme spécialisée de l'élément term, nommé abbreviated-form. Les éléments term et abbreviated-form possèdent tous deux un attribut keyref, qui constitue la référence à la clé correspondante à l'élément glossref de la carte DITA. L'attribut keyref a été introduit dans DITA 1.2.

Par exemple, pour créer un lien à partir de l'acronyme ABS vers la définition du glossaire se rapportant à système de freinage ABS, il faut utiliser le code suivant :
<p>Votre voiture est munie d'un <abbreviated-form keyref="abs"/>.

Pour faciliter la gestion de l'architecture, il est préférable d'utiliser une carte DITA séparée pour le glossaire, puis d'imbriquer la carte DITA du glossaire dans la carte DITA principale de la collection, sauf s'il s'agit de petits documents.