Définir une clé
Pour définir une clé contenant un chemin vers un fichier ou une URL, ajoutez l’élément <keydef> à votre carte. Vous pouvez ensuite ajouter les attributs suivant à <keydef> :
- keys : le nom de la clé
- href : la cible de la clé
- format : le type de fichier auquel la clé va faire référence
Par exemple :
<keydef keys="image_produit" href="images/produit_B.png" format="png"/>
Bien qu’il est possible d’insérer des caractères spéciaux dans le nom de la clé, il fait partie des bonnes pratiques de n’utiliser seulement que des lettres, des chiffres et des traits de soulignement. Si vous avez besoin d’aide pour utiliser des caractères spéciaux, veuillez consulter le lien suivant (en anglais) : Spécification DITA 1.2
Une autre bonne pratique consiste à définir le format utilisé avec la clé. Dans les valeurs possibles sont inclues « dita », « ditamap », « pdf », « html » et les formats graphiques comme « png » ou « svg ».
Si vous définissez une clé pointant vers une ressource externe comme une URL, vous devez utiliser l’attribut scope= »external » avec l’élément <keydef> :
<keydef keys="mon_url" href="http://www.scriptorium.com" scope="external" format="html"/>
L’attribut scope empêche DITA Open Toolkit (ou d’autres transformateurs) d’essayer de résoudre la cible de l’attribut href comme étant une partie de la définition de la clé. Comme l’attribut href pointe vers une page web, alors l’attribut format doit contenir la valeur html.
Utiliser les clés
Pour utiliser une clé pointant vers un chemin de fichier ou une URL, vous devez utiliser l’attribut keyref plutôt que href :
<image keyref="image_produit"/>
- <image>
- <xref>
- <link>
- <coderef>
- <topicref>
- <mapref>
Contributors
- Simon Bate
- Jake Campbell
- Gretyl Kinsey
- Decarnelle Rémi (traducteur)