18.3. index-sort-as

L'élément <index-sort-as> spécifie une phrase de tri selon laquelle une entrée d'index devrait être triée.

Cet élément donne à l'auteur la possibilité d'avoir une entrée d'index triée différemment de la façon dont son texte l'aurait normalement été. On l'utilise couramment pour éliminer le texte en tête non significatif tel que la ponctuation ou des mots comme « le » ou « un ». Par exemple, l'auteur préférera ranger l'entrée « <data> » à la lettre « D » plutôt qu'au SIGNE INFÉRIEUR À « < ». L'auteur voudra peut-être inclure cette entrée à la fois à la rubrique ponctuation et à la lettre « D », auquel cas il peut y avoir deux directives d'entrée d'index différenciées seulement par l'ordre de tri.

Certaines langues ont des règles de tri spéciales. Par exemple, des entrées d'index en japonais pourraient s'écrire partiellement ou entièrement en caractères kanji mais pourront être triées phonétiquement selon leur interprétation hiragana/katakana. Il n'existe aucun moyen automatique d'associer un texte écrit à un texte phonétique : pour un texte kanji, il peut y avoir plusieurs possibilités phonétiques selon le contexte. La seule façon de trier correctement des entrées d'index en japonais est de conserver les contreparties phonétiques avec les formes écrites. Le texte phonétique se présenterait comme texte d'ordre de tri pour les besoins de l'indexation.

Le contenu de l'élément <index-sort-as> est logiquement augmenté par le contenu textuel de son élément <indexterm> parent afin de produire la clé de tri effective (c'est-à-dire que le contenu textuel se comporte comme un champs de tri secondaire), ainsi deux éléments <indexterm> avec un contenu différent mais la même valeur <index-sort-as> ne fusionneront pas en une seule entrée d'index..

Un élément <index-sort-as> fournit la clé de tri de l'élément <indexterm> qui est son parent ; de fait, dans un élément <indexterm> à plusieurs niveaux, l'élément <index-sort-as> n'affecte que le niveau où il apparaît.

C'est une condition d'erreur si un élément <indexterm> contient plus d'un sous-élément <index-sort-as>. Une implémentation 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 ignorant tous les <index-sort-as> hormis le dernier.

Voici l'exemple d'une entrée d'index pour « <data> » qui sera triée en tant que « data » :

<indexterm>&lt;data&gt;<index-sort-as>data</index-sort-as></indexterm>

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) (un nombre quelconque)
map, bookmap ( données textuelles ou keyword ou term ou data ou data-about ou foreign ou unknown) (un nombre quelconque)

Contenu par :

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

Héritage :

+ topic/index-base indexing-d/index-sort-as

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