Vous pouvez utiliser les clés comme des variables pour du texte dans vos rubriques. Les clés sont typiquement utilisées comme des variables dans les cas suivants :
- nom de produit
- numéro de référence du produit
- nom de l’entreprise
- numéros de téléphone
- titres d’ouvrages
Bien que qu’il n’y ait pas de limite de taille de chaîne de caractères définie par une clé, la longueur de ces dernières est souvent plutôt courte.
Note: Le cours précédent (Introduction à la réutilisation dans DITA) insistait sur ne pas réutiliser du contenu à l’échelle plus petite qu’une phrase. Cet argument reste valable dans la majeure partie du temps. Néanmoins, si vous devez utiliser les clés comme variable pour un nom d’entreprise ou de produit dans une situation où ces noms pourrait venir à changer, le niveau de confort et de cohérence apporté par les clés peut convaincre de déroger à la règle.
Pour définir une clé qui va contenir du texte, utiliser l’élément <keydef> avec l’attribut keys. L’attribut keys sert à nommer la clé. Ensuite, imbriquer l’élement <topicmeta> au sein de <keydef> :
<keydef keys="nom_produit"> <topicmeta> <keywords> <keyword>Base de données canards</keyword> </keywords> </topicmeta> </keydef>
La syntaxe est plutôt verbeuse, mais une fois la structure établie, il n’est plus nécessaire d’y toucher.
Veuillez noter que que la chaîne de caractères est limitée au contenu de l’élément <keyword>, c’est-à-dire du texte non formaté avec l’élément <text> et des marques déposées avec l’élément <tm>. Vous ne pouvez pas utiliser d’autres éléments pour ajouter du formatage ou du contenu en référence croisée. Si les restrictions de l’élément <keyword> ne vous conviennent pas, veuillez réfléchir à utiliser plutôt un conref.
Utiliser les clés
Pour utiliser une clé avec une chaîne de caractère, ajoutez l’attribut keyref à ces éléments (ou tout élément héritant de ces derniers) :
- <ph>
- <term>
- <keyword>
Cet exemple montre comment une clé peut être utilisée avec l’élément <ph> (phrase) :
Félicitations pour votre achat de la <ph keyref="nom_produit"/> !
Lorsque la carte DITA inclut l’élément <keydef> montré ci-dessus, la publication devrait être résolu de cette manière :
Félicitations pour votre achat de la Base de données canards !
Contributors
- Simon Bate
- Jake Campbell
- Gretyl Kinsey
- Decarnelle Rémi (traducteur)