Une clé DITA sert à générer un emplacement réservé pour un chemin vers un fichier ou du texte. Le nom et la définition de la clé sont à remplir dans la carte DITA. Pour se référer à la clé de votre choix, mentionnez le nom de la clé dans l’attribut keyref. Les attributs keyref sont résolus quand les rubriques et les cartes sont transformées pour générer une publication.
L’avantage de la clé est qu’elle est définie à un seul endroit, la carte, puis est réutilisée à volonté dans n’importe quelle rubrique. Si le chemin vers le fichier ou le texte change, vous avez seulement besoin de revoir la définition de la clé, et tous les keyrefs seront mis à jour automatiquement.
Les clés rendent la réutilisation de contenu plus facile. En effet, la définition d’une clé peut être différente pour chaque carte, et une rubrique réutilisable peut utiliser plusieurs clés qui renvoient vers différents fichiers ou fragments de texte en fonction de la carte dans laquelle est elle utilisée.
- La clé nom_produit contenant le nom du produit
- La clé image_produit contenant le chemin vers l’image du produit
Dans la carte DITA du Produit A, nom_produit peut être défini comme « Produit A » et image_produit comme « images/ProduitA.png ».
Dans la carte DITA du Produit B, nom_produit peut être défini comme « Produit B » et image_produit comme « images/ProduitB.png ».
Lorsque votre rubrique est référencée dans la carte du Produit A, le nom du produit devient « Produit A » et la bonne illustration de produit est affichée. Puis lorsque votre rubrique est référencée dans la carte du Produit B, le nom et l’illustration du produit seront affichés.
Les clés sont définies dans la carte DITA à l’aide de l’attribut <keydef> qui est une spécialisation de l’élément <topicref>.
Il existe quelques différences entre les clés utilisés pour les chemins de fichier et les clés utilisés pour des chaînes de caractères notamment au niveau de leur définition et de leur utilisation. Les deux façons d’utilser les clés seront expliquées au cours des deux prochaines leçons.
Note: La description de ces clés ne comprends pas les clés à portée variable qui est une nouveauté de DITA 1.3. Le concept des clés à portée variable fera l’objet d’un cours sur ApprendreDITA.
Note: Il existe une troisième façon d’utiliser les clés : elles peuvent être utilisé pour spécifier un chemin vers un conref. Ces conrefs particuliers seront abordés dans la prochaine leçon (« conref avancé »)
Contributors
- Simon Bate
- Jake Campbell
- Gretyl Kinsey
- Decarnelle Rémi (traducteur)