Dans DITA, vous utilisez un conref pour réutiliser des éléments de contenu. Ces éléments de contenu peuvent être des avertissements (notes, mises en garde et alertes), du texte passe-partout (tel que l’adresse de votre entreprise), etc. Par exemple, la description d’un produit peut être configurée en tant que référence, de sorte qu’elle soit identique pour tous vos documents.
Si vous connaissez d’autres outils de création, les conrefs sont à peu près équivalents à :
- Les snippets de Flare
- Les rubriques embarquées de RoboHelp
- Les encarts de texte et variables FrameMaker
- Les inclusions côté serveur HTML
Supposons que vous ayez la note suivante dans une rubrique appelée lieu.dita :
<topic id="topicid"> ... <note id="cequaimentlescanards">Les canards préfèrent les lacs aux déserts.</note> ... </topic>
Pour réutiliser cette note dans une autre rubrique, le code conref est le suivant :
<note conref="lieu.dita#topicid/cequaimentlescanards"/>
La plupart des outils de création DITA rationalisent le processus d’insertion de code conref. Par conséquent, vous ne taperez probablement pas le chemin du fichier, l’id de la rubrique, etc., comme indiqué dans l’exemple.
Remarque : L’élément cible doit être du même type que l’élément contenant l’attribut conref. Ainsi, vous ne pouvez utiliser l’attribut conref d’un élément <note> qu’à partir d’un autre élément <note> ; vous ne pouvez utiliser l’attribut conref d’un élément <li> qu’à partir d’un autre élément <li>, etc.
Vidéo : exemple de code conref DITA
Conseil : Il est recommandé de créer des rubriques séparées contenant des éléments réutilisables, au lieu de simplement choisir une rubrique au hasard et de faire pointer une référence vers cette rubrique. Cela vous permet de mieux suivre le contenu réutilisé et de contrôler son évolution.