Reference
La rubrique DITA de type Reference décrit les fonctions standard d'un sujet ou d'un produit, telles que les commandes d'un langage de programmation ou d'une interface de programmation (API, Application Programming Interface). Les rubriques DITA de type Reference peuvent fournir des informations sur tout sujet qui possède un contenu régulier (recettes, catalogues, bibliographies et informations descriptives structurées similaires).
Une rubrique Reference contient les principales balises suivantes :
• reference : contient toutes les autres balises.
• title : sujet de la rubrique.
• shortdesc : brève description ou présentation de la rubrique.
• prolog : différents types de métadonnées sur la rubrique, tels que l'auteur, le copyright, les termes d'index, etc.
• refbody : contenu réel de la rubrique.
Une Référence est généralement structurée en un ou plusieurs tableaux, sections et listes que vous pouvez organiser dans l'ordre de votre choix. Les principales balises du corps d'une Référence sont les suivantes :
◦ section : conteneur du contenu que vous souhaitez regrouper dans une référence.
◦ refsyn : syntaxe ou informations similaires.
◦ properties : liste de propriétés associées au sujet de la référence, généralement présentée sous la forme d'un tableau.
◦ example : exemples illustrant ou étayant les informations de référence.
La balise refbody peut également contenir les tableaux DITA standard.
• related-links : contient des liens de référence croisée vers des informations connexes.
La plupart de ces balises étant facultatives, vous utilisez uniquement celles dont vous avez besoin pour créer la rubrique.