Structure de la section related-links

La section related-links d'une rubrique contient les éléments link qui peuvent éventuellement être regroupés dans des éléments conteneurs linklist et linkpool. La structure de ces éléments influence la manière dont les liens sont affichés dans le document de sortie et la manière dont les attributs metadata des liens sont gérés.

Pour définir les liens dans les contenus DITA, vous pouvez insérer une section related-links à la fin d'une rubrique, en dehors du corps de la rubrique.

La structure de la section related-links est la suivante : 

<topic>
  <title>...</title>
  <body>
  ...
  </body>
  <related-links>
    <link href="URL de la rubrique ou de la ressource référencée">
      <linktext>Texte du lien</linktext>
    </link>
    <link>...</link>
    .
    .
    .
  </related-links>
</topic>

Pour mieux organiser les liens, les éléments links peuvent être regroupés dans des éléments conteneurs linklist et linkpool. Ces éléments conteneurs permettent d'appliquer les attributs metadata à un ensemble de liens.

Par exemple, si vous souhaitez spécifier que tous les liens d'un élément linklist ont un attribut product de valeur lite, vous pouvez baliser votre texte ainsi : 
<related-links>
  <linklist product="lite">
    <link>...</link>
    <link>...</link>
    .
    .
  </linklist>

Le conteneur linklist est utilisé lorsque l'ordre des liens est important. Cet ordre sera conservé lors de l'édition du contenu dans le format de sortie. Le conteneur linkpool n'implique aucun ordre particulier. Ainsi, l'élément linklist est semblable à une liste numérotée tandis que l'élément linkpool est semblable à une liste à puces.

Lorsqu'ils sont contenus dans un élément conteneur linklist, les liens dans le document de sortie seront généralement affichés sans titre et dans le même ordre que celui des liens dans l'élément linklist. Par contre, lorsqu'ils sont contenus dans un élément linkpool, ou lorsqu'ils ne sont pas contenus (comme des éléments links simples dans la section related-links), les liens dans le document de sortie seront regroupés selon leur type d'information (par exemple, sous les titres Concepts associés, Tâches associées, Références associées, et Informations associées).

Dans la structure links, l'élément linktext, qui définit le texte du lien, est optionnel. Lorsqu'aucun élément linktext n'est défini, le titre de la rubrique DITA référencée sera utilisé comme texte du lien.

Lorsque vous créez des liens vers des rubriques DITA, évitez d'inclure un élément linktext. En effet, le titre de la cible sera ainsi utilisé comme texte du lien, et garantira que le texte du lien correspond bien au titre de la rubrique cible. Cependant, pour les liens vers des ressources ne provenant pas de DITA (sites Web, documents PDF, etc.) vous devez définir le texte des liens.

Remarque :
Vous trouverez quelques exemples de liens dans la section related-links située tout à la fin de cette rubrique. Ces liens apparaîtront uniquement dans la version hypertexte du Guide de Style DITA. Le code pour ces exemples de liens est le suivant :
Type de lien Code
Lien vers une autre rubrique DITA sans élément linktext 
<link href="c_Scope_Attribute.dita">
</link>
Lien vers une autre rubrique DITA avec un élément linktext 
<link href="c_Scope_Attribute.dita>
  <linktext>Lien alternatif pour l'attribut Scope
  </linktext>
</link>
Lien vers un site Web externe 
<link format="html" scope="external" 
href="http://www.hyperwrite.com/">
  <linktext>Site Web HyperWrite</linktext>
</link>
Les trois exemples de liens sont insérés à deux reprises dans la section related-links : la première série de liens n'est pas incluse dans un élément conteneur, alors que la seconde série de liens est incluse dans un élément linklist.