Placement des éléments indexterm

L'élément indexterm n'est composé que de métadonnées et son contenu ne s'affiche pas. Placez les entrées d'index dans la section prolog des rubriques, ou dans la section topicmeta des éléments topicref au sein des cartes DITA seulement si le terme est spécifique à une publication en particulier.

L'index alphabétique d'une publication est créé lors du processus de publication grâce aux mots-clés d'index placés dans les différentes rubriques du document par le rédacteur. Les mots-clés d'index sont définis au sein de l'élément indexterm.

DITA autorise la présence d'éléments indexterm dans  :
  • la section topicref des cartes DITA ;
  • la section prolog des rubriques ;
  • la section shortdesc (et abstract) des rubriques ;
  • les sections body des rubriques.

Cependant, des entrées d'index disséminées à travers le texte peuvent provoquer des problèmes de maintenance, donc des problèmes de traduction et de traitement.

Dans la mesure du possible, les éléments indexterm doivent être placés dans la section prolog, hors du corps des rubriques. Dans cette section, les entrées d'index doivent être définies au sein de l'élément keywords.

Lorsqu'ils concernent une publication (et ne concernent donc pas les rubriques), les éléments indexterm doivent être placés dans la section topicmeta d'un élément topicref au sein d'une carte DITA. Un exemple serait un terme spécifiquement utilisé par une organisation mais pas par les autres, nécessitant ainsi des cartes DITA différentes pour définir des documents de sortie adaptés aux différentes organisations.

Les termes d'indexation peuvent se trouver dans le corps du texte, mais uniquement si les rubriques sont relativement longues. Dans ce cas, les entrées d'index dans le document de sortie doivent pointer vers le début du contenu de la rubrique concernée, plutôt que de pointer vers l'emplacement où le terme est mentionné.

Lorsque vous devez placer une entrée d'index au sein du corps d'une rubrique, respectez les directives suivantes :
  • Pour les éléments de blocs (paragraphes), placez l'entrée d'index tout de suite après la balise ouvrante de l'élément qui contiendra l'entrée.
  • Au niveau d'une phrase, placez l'entrée d'index avant le début de la phrase.
  • Au niveau d'un mot ou d'une phrase, placez l'entrée d'index avant le début du texte.
Remarque : Le contenu des éléments indexterm n'apparaissent jamais dans le document de sortie, même si les éléments sont compris au sein du corps du texte. Ainsi, le balisage suivant : <p>EJ25 <indexterm>turbocompresseur</indexterm> à induction forcée...</p> apparaîtra donc comme suit EJ25 à induction forcée....

Vous pouvez parfois ressentir le besoin d'utiliser un élément indexterm à un endroit du document où l'élément indexterm n'est pas autorisé. Bien qu'il soit possible de contourner le problème en insérant un élément phrase (ph) puis en y imbriquant l'élément indexterm, ne le faites pas. N'insérez des éléments indexterm qu'à des emplacements valides.