3.2.3. Attributs et métadonnées de carte DITA communs

Les cartes DITA ont beaucoup d'attributs en commun avec le contenu DITA mais en ont aussi d'autres pour contrôler la façon dont les relations sont interprétées pour des objectifs de sortie différents.

Puisque les cartes DITA peuvent coder des structures qui sont spécifiques, entièrement ou partiellement, à un média ou un type de sortie particuliers (par exemple, des pages web hyperliées ou un des livres imprimés), les cartes DITA contiennent des attributs pour aider les processeurs à interpréter la carte pour chaque type de sortie. Ces attributs (tels que print et toc) ne sont pas disponibles dans le contenu DITA : les thèmes individuels, une fois séparés des structures et dépendances de niveau supérieur associées à un type particulier de sortie, devraient être entièrement réutilisables à travers plusieurs médias.

Attributs de liaison

Les attributs collection-type et linking affectent la façon dont les liens apparentés (related links) sont générés pour les thèmes décrits dans la carte.

Attribut collection-type

L'attribut collection-type indique comment un ensemble particulier d'éléments <topicref> frères (siblings) sont liés entre eux. L'attribut collection-type se place sur l'élément conteneur des éléments <topicref> frères. La valeur de collection-type peut indiquer s'il faut générer des liens entre les frères et quels types de lien générer (par exemple, des liens suivants et précédents pour une séquence ou des liens frères pour une famille. L'attribut collection-type peut également indiquer comment le thème parent devrait être lié à ses sous-thèmes (children), par exemple en montrant les liens de sous-thème comme une liste numérotée pour l'attribut collection-type="sequence". Lorsque l'attribut collection-type se trouve sur des éléments qui ne peuvent pas contenir directement d'éléments <topicref> (tels que les éléments <reltable> et <relcolspec>), le comportement de l'attribut est réservé pour une utilisation future.

Attribut linking

Par défaut, les relations entre les thèmes d'une carte sont réciproques : les sous-thèmes sont liés aux parents et vice versa ; les thèmes suivants et précédents dans une séquence sont liés les uns aux autres ; les thèmes dans une famille sont liés à leurs frères ; les thèmes dans les cellules de table de la même rangée d'une table de relation sont liés les uns aux autres. On peut modifier ce comportement par défaut avec l'attribut linking, lequel permet à un thème de modifier sa participation dans une relation :

On peut également créer des liens directement dans un thème avec les éléments <xref> ou <linkagt;, mais dans beaucoup de cas une liaison fondée sur une carte est préférable, car les liens au sein des thèmes créent des dépendances entre les thèmes qui peuvent empêcher leur réutilisation.

Figure 1. Exemple de liaison simple
<topicref href="A.dita" collection-type="sequence">
  <topicref href="A1.dita"/>
  <topicref href="A2.dita"/>
</topicref>
<reltable>
  <relrow>
    <relcell>A.dita</relcell>
    <relcell>B.dita</relcell>
  </relrow>
</reltable>
A
lie à A1, A2 en tant que sous-thèmes
lie à B en tant qu'apparenté
A1
lie à A en tant que parent
lien à A2 en tant que suivant dans la séquence
A2
lie à A en tant que parent
lien à A1 en tant que précédent dans la séquence
B
lie à A en tant qu'apparenté
Figure 2. Exemple de liaison avec l'attribut linking
<topicref href="A.dita" collection-type="sequence">
  <topicref href="B.dita" linking="none"/>
  <topicref href="A1.dita"/>
  <topicref href="A2.dita"/>
</topicref>
<reltable>
  <relrow>
    <relcell>A.dita</relcell>
    <relcell linking="sourceonly">B.dita</relcell>
  </relrow>
</reltable>
A
lie à A1, A2 en tant que sous-thèmes
(pas de lien à B en tant que sous-thème, pas de lien à B en tant qu'apparenté)
A1
lie à A en tant que parent
lie à A2 en tant que suivant dans la séquence
(pas de lien à B en tant que précédent)
A2
lie à A en tant que parent
lie à A1 en tant que précédent dans la séquence
B
lie à A en tant qu'apparenté

Attributs de navigation, de média et de composition

Il existe des attributs normalisés pour identifier un contenu spécifique d'un média de sortie et pour recomposer (rechunking) les thèmes.

Attributs toc, navtitle et locktitle

Les auteurs peuvent exclure des entrées de la sortie de navigation (navigation output), telle qu'une table des matières en ligne ou un plan de site web, avec l'attribut toc. Par défaut, les hiérarchies sont incluses dans la sortie de navigation, et les tables exclues.

Les auteurs peuvent fournir une version raccourcie du titre à utiliser dans la navigation avec l'attribut navtitle. Par défaut, l'attribut navtitle est ignoré et ne sert qu'à aider l'auteur à garder une trace du titre du thème cible. L'attribut locktitle peut être paramétré afin d'assurer que l'attribut navtitle prenne effet et remplace toutes les valeurs de titre dans le thème cible ou définies ailleurs dans les métadonnées de référence du thème.

Attributs print et search

On peut définir des attributs sur un thème pour indiquer si celui-ci devrait être inclus dans une sortie imprimée ou les résultats d'une recherche (search indexes).

Attribut chunk

Lorqu'un ensemble de thèmes est transformé en utilisant une carte, on peut découper les fichiers à plusieurs thèmes en fichiers plus petits, et réunir plusieurs thèmes individuels en un seul fichier plus grand avec l'attribut chunk. L'attribut chunk n'a pas de valeur par défaut, mais on peut établir un défaut pour une carte entière en définissant l'attribut chunk sur l'élément <map> ou une spécialisation. Pour une description détaillée de l'attribut chunk et son utilisation, cf. la section 4.5. Composition.

Attribut copy-to

Lorsqu'un ensemble de thèmes est transformé en utilisant une carte, des versions de thème en double peuvent être crées avec l'attribut copy-to. Le thème copié aura un nouveau nom de fichier ou une nouvelle adresse, comme fournis dans l'attribut copy-to, et la carte peut remplacer le titre et la description courte par défaut de cette copie particulière en leur fournissant des valeurs avec les attributs navtitle et shortdesc de l'élément <topicref>. Pour des informations sur la façon dont on peut utiliser l'attribut copy-to avec l'attribut chunk, cf. la section 4.5. Composition.

Attributs partagés

Les cartes DITA utilisent les mêmes métadonnées et attributs que les thèmes DITA.

Les cartes DITA emploient également nombre d'attributs identiques utilisés avec les éléments <link> et <xref> dans le contenu DITA :

Lorsque de nouveaux attributs sont spécialisés à partir des attributs props ou base en tant que domaine, ils peuvent être incorporés aux types structuraux des cartes et des thèmes.