L'élément xref

L'élément de référence croisée est utilisé pour lier ou pour faire le référencement croisé d'un texte au sein d'une rubrique à d'autres rubriques, lier des éléments au sein d'une rubrique, ou lier des ressources externes à une collection DITA.

L'élément xref (référence croisée) vous permet de lier du texte contenu dans le corps d'une rubrique DITA à différentes ressources cibles. Même si vous pouvez renseigner le texte manuellement pour les références croisées ou les liens eux-mêmes, vous devriez plutôt laisser DITA calculer le texte en fonction du type de ressource que vous souhaitez lier. Pour préciser que vous souhaitez que DITA calcule le texte de référence croisée, laissez l'élément vide. Par exemple, si vous créez une référence croisée pour un élément fig (figure), le texte de la référence croisée peut être automatiquement généré ainsi : Figure 15. Si vous insérez du texte au sein de l'élément xref, ce texte sera utilisé comme texte de la référence croisée.

De même, si vous créez une référence croisée vers une rubrique et que vous laissez l'élément xref vide, le titre de la rubrique cible sera utilisé comme texte de la référence croisée. Vous trouverez des exemples de texte de référence croisée générés automatiquement dans la section Exemple de rubrique : les références croisées.

L'élément xref (référence croisée) contient les attributs suivants :
href
désigne l'adresse de la ressource à référencer (rubrique, bloc au sein d'une rubrique, fichier PDF, ressource Web externe, adresse électronique, etc.).
type
décrit le type de la ressource référencée : concept pour une rubrique de concept DITA, li pour un élément de liste dans la liste d'une rubrique, fn pour une note de bas de page dans une rubrique, fig pour une figure dans une rubrique ou table pour un tableau dans une rubrique.
format
décrit le format de fichier de la ressource référencée : dita pour une rubrique DITA, pdf pour un fichier PDF et html pour une ressource Web.
scope
indique si la ressource référencée se trouve dans le même document que la rubrique (local) ou si elle est externe au document (external).
La syntaxe de l'attribut href est illustrée dans les exemples suivants :
  • Référence à une rubrique (ou la première rubrique dans une rubrique d'assemblage (ditabase)) : "fichier.dita"
  • Référence à une rubrique spécifique dans une rubrique d'assemblage (ditabase) : "fichier.dita#idtopic"
  • Référence à un élément dans une rubrique DITA : "fichier.dita#idtopic/idelement"
  • Référence à un élément dans une carte DITA : "collection.ditamap#map-branch"
  • Référence à une image : "exemple.png"
  • Référence à une ressource externe : "http://www.exemple.org"