Les rubriques Reference

Une rubrique référence répond à la question « Qu’est-ce ? ». Une rubrique référence contient généralement des faits descriptifs, tels que la syntaxe d’une commande ou de l’appel à une fonction API, un tableau répertoriant les caractéristiques opérationnelles et les tolérances d’un périphérique, ou un tableau identifiant les éléments d’un écran du logiciel.

Les rubriques référence n’incluent pas d’étapes ou d’informations de fond. Les rubriques référence sont similaires à des entrées du dictionnaire ou fournissent uniquement des faits.

Les éléments courants utilisé dans une rubrique référence comprennent :

  • <refbody> (le corps de la rubrique référence)
  • <section> (une subdivision dans la rubrique référence, avec un titre optionnel)
  • <table> (une table)
  • <fig> (une figure, y compris un titre optionnel)
  • <properties> (une liste de propriétés)
  • <refsyn> (un diagramme de syntaxe)

Vidéo : Aperçu du code d’une rubrique référence DITA

Contributeurs