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 :

Doctype Modèle de contenu
ditabase ( ( title) puis ( titlealts) (optionnel) puis ( shortdesc ou abstract) (optionnel) puis ( prolog) (optionnel) puis ( refbody) (optionnel) puis ( related-links) (optionnel) puis ( topic ou concept ou task ou reference ou glossentry) (un nombre quelconque) )
reference ( ( title) puis ( titlealts) (optionnel) puis ( shortdesc ou abstract) (optionnel) puis ( prolog) (optionnel) puis ( refbody) (optionnel) puis ( related-links) (optionnel) puis ( reference) (un nombre quelconque) )

Contenu par :

Doctype Parents
ditabase dita, topic, concept, task, reference
reference reference

Héritage :

- topic/topic reference/reference

Attributs :

Nom Description Type de donnée Valeur par défaut Obligatoire ?
id Cet identificateur permet aux éléments <topicref> de référencer de manière unique les thèmes dans les cartes DITA. ID   oui
conref Cet attribut sert à référencer un identificateur sur un thème réutilisable. Cf. la section 25.10.1. L'attribut conref pour des exemples et des détails à propos de la syntaxe. CDATA #IMPLIED non
xmlns:ditaarch Déclare l'espace de noms DITA par défaut. CDATA #FIXED "http://dita.oasis-open.org/architecture/2005/"  
DITAArchVersion Désigne la version de l'architecture en vigueur. CDATA "1.1" (dépend de la version ; ira en augmentant) non
domains Indique les domaines spécialisés inclus dans la définition DTD ou le schéma. CDATA (topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic indexing-d) non
%select-atts; (props, base, platform, product, audience, otherprops, importance, rev, status) Un ensemble d'attributs liés, décrit à la section 25.5. %select-atts; entité paramètre sans objet pour une entité paramètre sans objet
%localization-atts; (translate, xml:lang, dir) Un ensemble d'attributs liés, décrit à la section 25.6. %localization-atts;. entité paramètre sans objet pour une entité paramètre sans objet
%global-atts; (xtrf, xtrc) Un ensemble d'attributs liés, décrit à la section 25.2. %global-atts; entité paramètre sans objet pour une entité paramètre sans objet
class, outputclass Attributs communs, décrit à la section 25.9. Autres attributs DITA communs