10.3. linkpool

L'élément <linkpool> définit un groupe de liens qui ont des caractéristiques communes telles que le type, le public ou la source. Lorsque les liens ne sont pas dans un élément <linklist> (c'est-à-dire qu'ils se trouvent dans des éléments <related-links> ou <linkpool>), l'organisation des liens est déterminée par le processus de sortie, pas selon l'ordre dans lequel les liens apparaissent réellement dans le thème DITA.

Il y a deux façons d'organiser des liens d'information apparentée : les ajouter tous sans ordre particulier, en utilisant les éléments <linkpool> ou <related-links>, et laisser le processeur de formatage de sortie les trier, ou les regrouper au préalable en utilisant un ou plusieurs éléments <linklist>. Si on les groupe au préalable, l'ordre des liens tel qu'il a été créé est conservé pendant le traitement de formatage en sortie.

Les attributs définis sur l'élément <linkpool> sont hérités par ses descendants. Par exemple, si vous avez une liste <linkpool> qui contient tous les liens externes, vous pouvez indiquer scope="external" sur cet élément <linkpool> extérieur sans le définir sur les liens contenus.

Exemple

<related-links>
<linkpool type="task">
<link href="generalfaq.html#installing" role="parent" />
<link href="register.html#newuser" role="sibling" />
</linkpool>
</related-links>

Contient :

Doctype Modèle de contenu
ditabase, topic, task, reference, concept, glossary ( linkpool ou link) (un nombre quelconque)

Contenu par :

Doctype Parents
ditabase, topic, task, concept, reference, glossary related-links, linkpool

Héritage :

- topic/linkpool

Attributs :

Nom Description Type de donnée Valeur par défaut Obligatoire ?
collection-type Les types de collection décrivent comment les liens sont liés les uns aux autres. Une collection de type "family" représente un regroupement étroit dans lequel chacun des thèmes référencés non seulement est lié au thème courant mais aussi aux autres. La valeur "sequence" indique que l'ordre des sous-thèmes importe ; les processeurs de sortie établiront typiquement des liens entre eux dans l'ordre. La valeur "unordered" indique que l'ordre n'importe pas. La valeur "choice" indique que l'un des sous-thèmes devrait être sélectionné. Si aucune valeur n'est spécifiée, les processeurs devrait adopter par défaut la valeur "unordered", quoique la DTD ne définisse aucune valeur par défaut. Cf. la section 25.10.1.1. Utilisation de la valeur "-dita-use-conref-target" pour plus d'informations sur l'attribut conref.

L'utilisation de l'attribut collection-type sur les éléments <reltable> et <relcolspec> n'est pas définie pour l'instant, et réservée à plus tard.

(unordered | sequence | choice | family | -dita-use-conref-target) #IMPLIED non
duplicates Spécifie si les liens en double seront écartés ou non d'un élément <linklist>. Les valeurs admissibles sont : "yes" (autorise les liens en double) ou "no" (écarte les liens en double). En général, les liens en double dans les éléments <linklist> sont préservés. Notez que les liens sont considérés des copies seulement si leur contenu plus tous leurs attributs concordent. #IMPLIED La valeur de l'attribut est ignorée pour l'instant mais devrait être "yes" par défaut pour les liens dans les éléments <linklist> et "no" pour tous les autres liens. non
mapkeyref Identifie la carte, le cas échéant, à partir de laquelle les liens contenus sont dérivés. Cette valeur est générée automatiquement par le même processus qui crée les liens à partir de la carte, comme une façon d'identifier de quelle carte les liens proviennent. Si les listes <linklist> ou <linkpool> sont créées manuellement par l'auteur, il n'est pas nécessaire d'utiliser cet attribut. CDATA #IMPLIED non
type Décrit la cible d'une référence croisée. Cf. la section 25.10.2. L'attribut type pour des informations détaillées sur les valeurs gérées et les implications de traitement. CDATA #IMPLIED (traité comme si la cible était de type "topic", ou hérité d'un ancêtre) non
role L'attribut role définit le rôle joué par le thème cible dans la relation avec le thème courant. Par exemple, dans une relation parent/enfant, le rôle serait "parent" si la cible était le parent du thème courant, et "child" si la cible était l'enfant du thème courant. On pourrait utiliser cette structure pour trier et classer les liens lors de l'affichage. Cf. la section 25.10.4. L'attribut role pour des informations sur les valeurs gérées. (parent | child | sibling | friend | next | previous | cousin | ancestor | descendant | sample (à éviter) | external (à éviter) | other | -dita-use-conref-target) #IMPLIED non
otherrole Indique un autre rôle. Cette valeur est utilisée lorsque l'attribut role="other". CDATA #IMPLIED non
format L'attribut format identifie le format de la ressource référencée. Cf. la section 25.10.3. L'attribut format pour des détails sur les valeurs gérées. CDATA #IMPLIED non
scope L'attribut scope identife l'étroitesse de la relation entre le document courant et la ressource cible.
  • Mettez scope="local" si la ressource fait partie de l'ensemble de contenu courant ;
  • Mettez scope="peer" si la ressource fait partie de l'ensemble de contenu courant mais n'est pas accessible lors de la construction ;
  • Mettez scope="external" si la ressource ne fait pas partie de l'ensemble d'information courant et devrait s'ouvrir dans une nouvelle fenêtre de navigateur ;
  • Cf. la section 25.10.1.1. Utilisation de la valeur "-dita-use-conref-target" pour plus d'informations sur la valeur "-dita-use-conref-target".
La valeur de traitement par défaut est "local". Si aucune valeur n'est spécifiée, mais que l'attribut est défini sur un ancêtre dans une carte ou dans la section <related-links>, la valeur sera héritée de l'ancêtre le plus proche.
(local | peer | external | -dita-use-conref-target) #IMPLIED non
%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, outputclass Attributs communs, décrit à la section 25.9. Autres attributs DITA communs