À propos des tables des relations

Les tables des relations précisent les relations entre les rubriques DITA dans une carte. Elles peuvent également définir des associations entre des rubriques DITA et des ressources non-DITA.

Les informations contenues dans la table des relations sont le plus souvent utilisées par un processeur DITA pour générer des listes de liens connexes. Toutefois, les informations peuvent être utilisées de nombreuses autres façons, en fonction des capacités du processeur de sortie et du format de sortie cible.

Remarque :

Bien que les informations soient gérées dans un format tabulaire et que les conteneurs soient appelés « tables des relations », le tableau lui-même n’est jamais affiché en sortie.

  • Le fait de conserver les associations de rubrique dans une table des relations (plutôt que d’utiliser des références croisées intégrées) garantit que les rubriques sont réutilisables. Si une rubrique contient des références croisées intégrées, la rubrique cible de chaque référence croisée doit également être disponible dans la carte, que la rubrique soit pertinente ou non pour la carte. (Ensuite, bien sûr, si cette rubrique a des dépendances de références croisées, elles doivent également être présentes, et ainsi de suite). Une table des relations élimine ces dépendances.
  • Un réseau de liens entre des rubriques connexes peut être maintenu en un seul endroit (la table des relations), plutôt que d’être réparti sur l’ensemble des rubriques. Cela facilite grandement la maintenance des réseaux ou des réseaux de liens.

Les tables de relations sont contenus dans les cartes et les bookmaps DITA. Une carte ou une bookmap peut contenir un certain nombre de tables des relations.

Chaque ligne dans une table des relations contient un ensemble de contenus connexes. Par exemple, une ligne peut contenir des références à toutes les rubriques qui se rapportent à un composant spécifique du système, ou à toutes les rubriques qui sont liées à une opération particulière.

Chaque colonne de la table des relations contient un type similaire d’informations. L’utilisation la plus courante des colonnes consiste à séparer les types de rubriques concept, tâche et référence. Si vous utilisez d’autres types de rubriques, vous pouvez définir des colonnes séparées pour celles-ci. Dans certains cas, une autre colonne peut contenir des liens vers des informations externes, telles que des sites internet.

Remarque : L’ordre des colonnes ou la position relative n’a aucune signification dans les tables des relations.

Chaque cellule de la table des relations contient un ou plusieurs éléments <topicref> qui indiquent les rubriques liées dans la carte.

Voici un bref exemple de table des relations.

Les en-têtes de colonne indiquent les types d’informations qui se trouvent dans chaque colonne. La première ligne du corps contient des références à des rubriques liées à l’alimentation ; la deuxième ligne du corps se réfère à des rubriques liées au logement. Deux choses supplémentaires à noter à propos de cet exemple :

  • Un élément <topicref> peut apparaître sur plusieurs lignes. Par exemple, l’élément topicref de r_mangeoires.dita apparaît sur deux lignes différentes parce qu’il concerne à la fois l’alimentation et le logement.
  • Les cellules de la table des relations peuvent contenir un certain nombre d’éléments <topicref> (y compris aucun).

Lorsqu’un générateur de sortie crée des sorties à partir de vos rubriques DITA, il utilise la table des relations pour créer des liens vers des informations connexes.

  • Pour toutes les rubriques référencés dans une ligne, le générateur de sortie crée des liens entre ces rubriques. En général, cela prend la forme d’une liste de liens à la fin de la sortie d’une rubrique.
  • Si nécessaire (et si le générateur de sortie le permet), la liste des liens peut être groupée et étiquetée par les colonnes définies dans la table des relations.

Remarque :

Pour plus d’informations sur l’élément <reltable> et les éléments qu’il contient, se référer à la norme OASIS DITA version 1.2.

Contributeurs