L’entrée de glossaire doit contenir au moins un élément racine (avec un attribut id) de type <glossentry> (entrée de glossaire) qui contient un élément de type <glossterm> (terme de glossaire).
L’élément <glossterm> est une spécialisation de l’élément <title>. L’élément <glossterm> peut contenir n’importe quel élément qu’un élément <title> peut contenir.
L’élément <glossdef> doit suivre l’élément <glossterm> et contient la définition. L’élément <glossdef> peut contenir n’importe quel élément autorisé dans l’élément <section>, sauf un élément <title>.
L’élément <glossbody> (corps du glossaire) peut éventuellement suivre l’élément glossdef, et peut contenir une série d’éléments spécialisés qui peuvent être utilisés pour fournir des détails supplémentaires sur le terme du glossaire. L’élément <glossbody> dépasse le cadre de cet exercice, et sera traité dans une leçon ultérieure.
Vidéo : Créer une entrée de glossaire DITA
Remarque :
En général, il est préférable de faire précéder le nom de fichier des entrées de votre glossaire de « g_ » afin de faciliter leur recherche dans une structure de fichier. Cependant, conformément à nos autres supports pédagogiques, nous utilisons « l_ ».
Pratique
- Faites une copie du fichier l_debut_glossentree.dita et ouvrez-le dans votre éditeur.
Remarque : Si vous utilisez un éditeur DITA, assurez-vous que vous êtes en mode texte plutôt qu’en mode auteur ou visuel.
Vous devriez voir ceci :
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
<glossentry id="canard">
<glossterm></glossterm>
</glossentry>
La première ligne (qui commence par <?xml) est une déclaration XML, qui est une partie standard de tous les fichiers XML.
La deuxième ligne est la déclaration DOCTYPE, qui indique aux éditeurs ou aux générateurs de sortie DITA qu’il s’agit d’un glossaire DITA. Les programmes utilisent ensuite cette information pour valider le contenu de la rubrique. Le DOCTYPE sera spécifique à chaque type de rubrique que vous créez.
La troisième ligne contient la balise d’ouverture de l’élément <glossentry>. L’attribut id associé à l’élément <glossentry> est obligatoire.
La quatrième ligne contient l’élément <glossterm>.
- À l’intérieur de l’élément <glossterm>, insérez le terme de glossaire à définir.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE glossentry PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
<glossentry id="canard">
<glossterm>canard</glossterm>
</glossentry>
- Après le terme <glossterm>, ajoutez un élément <glossdef>.
Dans la mesure du possible, l’attribut id associé à l’attribut <glossentry> doit être lisible par l’homme pour faciliter le référencement ultérieur, de préférence aussi proche que possible du terme du glossaire.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Glossary//EN" "glossary.dtd">
<glossentry id="canard">
<glossterm>Canard</glossterm>
<glossdef><p>Type d'oiseau nageur caractérisé par des pieds palmés,
un bec large et plat et un cancanement</p></glossdef>
</glossentry>
Contributeurs
