18.1. index-see

Un élément <index-see> dans un élément <indexterm> redirige le lecteur vers une autre entrée d'index que celui-ci devrait citer au lieu de l'entrée courante.

Les éléments <index-see> et <index-see-also> permettent une forme de redirection vers une autre entrée d'index dans l'index généré. L'élément <index-see> se rapporte à une entrée d'index que le lecteur devrait utiliser au lieu de l'entrée courante, tandis que l'élément <index-see-also> se rapporte à une entrée d'index que le lecteur devrait utiliser en plus de l'entrée courante.

Les éléments <index-see> et <index-see-also> sont ignorés si leur élément <indexterm> parent contient des sous-éléments <indexterm>.

Puisque l'élément <index-see> indique une redirection au lieu d'utiliser l'entrée courante, c'est une condition d'erreur, pour un <index-see>, s'il y a aussi un <index-see-also> ou un <indexterm> pour la même entrée d'index (c'est-à-dire avec une clé de tri identique). Une mise en œuvre peut (mais n'est pas obligée) émettre un message d'erreur et peut (mais n'est pas obligée) récupérer de cette condition d'erreur en traitant l'élément <index-see> comme un <index-see-also>.

Ce n'est pas une condition d'erreur s'il y a plusieurs éléments <index-see> pour une seule entrée d'index.

L'exemple suivant illustre l'emploi d'un élément de redirection <index-see> dans un élément <indexterm> :

<indexterm>Carassius auratus
   <index-see>Goldfish</index-see>
</indexterm>

Cela générera typiquement une entrée d'index sans page de référence :

Carassius auratus, see Goldfish

L'exemple suivant illustre l'emploi d'un élément de redirection <index-see> vers un élément <indexterm> plus complexe (à plusieurs niveaux) :

<indexterm>Feeding goldfish
   <index-see>Goldfish <indexterm>feeding</indexterm></index-see>
</indexterm>

Cette partie du balisage d'indexation générerait des entrées d'index telles que :

Feeding goldfish
- see Goldfish feeding
Goldfish
- feeding, 56
- flushing, 128, 345

Contient :

Doctype	Modèle de contenu
ditabase, topic, task, reference, concept	( données textuelles ou keyword ou option ou parmname ou apiname ou cmdname ou msgnum ou varname ou wintitle ou term ou data ou data-about ou foreign ou unknown ou indexterm) (un nombre quelconque)
map, bookmap	( données textuelles ou keyword ou term ou data ou data-about ou foreign ou unknown ou indexterm) (un nombre quelconque)

Contenu par :

Doctype	Parents
bookmap, map, ditabase, topic, task, concept, reference, glossary	indexterm

Héritage :

+ topic/index-base indexing-d/index-see

Attributs :

Nom	Description	Type de donnée	Valeur par défaut	Obligatoire ?
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;)	Un ensemble d'attributs liés, décrit à la section 25.7. %univ-atts;	entité paramètre	sans objet pour une entité paramètre	sans objet
%global-atts; (`xtrf`, `xtrc`)	Un ensemble d'attributs liés, décrit à la section 25.2. %global-atts;	entité paramètre	sans objet pour une entité paramètre	sans objet
`class`, `keyref`	Attributs communs, décrit à la section 25.9. Autres attributs DITA communs

Section parente 18. Éléments de groupe d'indexation

Section suivante 18.2. index-see-also

Retour au sommaire.