4.1. reference

L'élément <reference> définit le conteneur de niveau supérieur d'un thème de référence. Les thèmes de référence documentent des structures de programmation ou des faits à propos d'un produit. Des exemples comprennent les éléments de langage, les descriptions de classe, les commandes, les fonctions, les déclarations, les protocoles, les types, les déclarateurs, les opérandes et les informations d'interface de programmation (API), qui fournissent un accès rapide aux faits mais aucune explication des concepts ou des procédures. Les thèmes de référence ont la même structure de niveau supérieur que tout autre type de thème, avec un titre, une description courte et un corps. Pour le corps, les thèmes de référence sont typiquement organisés en une ou plusieurs sections, listes de propriétés et tables. Le type de thème reference fournit des règles générales qui s'appliquent à toutes sortes d'informations de référence, en utilisant des éléments tels que <refsyn> pour la syntaxe ou les signatures, et <properties> pour les listes et les valeurs.

Exemple

<reference id="refexample">
 <title>A reference topic/title>
 <refbody>
  <refsyn>Describe command or api syntax here, possibly
  using &lt;synph> or &lt;syntax> markup for explicit 
  definition of syntax or prototype construction.
  </refsyn>
  <section>
   <title>Some section title</title>
  </section>
  <properties>
   <property>
    <proptype>type</proptype>
    <propvalue>value</propvalue>
    <propdesc>description</propdesc>
   </property>
  </properties>
 </refbody>
</reference>

Contient :

Contenu par :

Héritage :

- topic/topic reference/reference

Attributs :

OASIS DITA Version 1.1 Language Specification — OASIS Standard, 1 August 2007
Copyright © OASIS Open 2005, 2007. All Rights Reserved.