Créer des modèles

Lorsqu’un ouvrage de référence se compose de plusieurs rubriques – une pour chaque commande, appel de fonction ou autre élément en série – chacune des rubriques doit suivre la même organisation. Par exemple, chaque rubrique d’une référence de ligne de commande peut contenir une brève description, la syntaxe de la commande, une description des paramètres, une discussion approfondie, des exemples et des messages d’erreur potentiels. Cela permet aux lecteurs de trouver systématiquement le même type d’information dans la même zone de chaque rubrique.

Chacun de ces éléments doit être contenu dans l’élément <section> dans l’élément <refbody>, avec un élément <title> qui étiquette la section.

Si vous avez besoin de créer plusieurs de ces rubriques, envisagez de créer un modèle. Un modèle est une rubrique DITA autonome qui ne contient pas beaucoup de contenu, mais qui a la structure répétable nécessaire en place. Par exemple, vous pourriez créer une référence qui contient chacune des sections et l’élément <title>. Ajoutez du texte dans chaque section en indiquant qu’il s’agit d’une section prévue.

Remarque : Le modèle devra inclure un attribut id sur l’élément <reference> ; assurez-vous que les créateurs de contenu le sachent pour éviter de créer des ID en double. Une façon de le faire est d’utiliser une valeur de substitution explicite pour l’attribut id, comme id= »DUMMY », afin que les créateurs de contenu sachent qu’il faut le remplacer par une valeur valide.

Contributeurs