4.3. refsyn

L'élément <refsyn> est une section spéciale dans un thème de référence. La section contient souvent de la syntaxe ou une signature (par exemple, la syntaxe d'appel d'un utilitaire en ligne de commande, ou la signature d'une interface de programmation API). L'élément <refsyn> contient une description brève éventuellement schématique de l'interface ou de la structure de niveau supérieur du sujet.

Exemple

Cf. la section 4.1. reference.

Contient :

Doctype Modèle de contenu
ditabase, reference ( données textuelles ou ph ou codeph ou synph ou filepath ou msgph ou userinput ou systemoutput ou b ou u ou i ou tt ou sup ou sub ou uicontrol ou menucascade ou term ou xref ou cite ou q ou boolean ou state ou keyword ou option ou parmname ou apiname ou cmdname ou msgnum ou varname ou wintitle ou tm ou p ou lq ou note ou dl ou parml ou ul ou ol ou sl ou pre ou codeblock ou msgblock ou screen ou lines ou fig ou syntaxdiagram ou imagemap ou image ou object ou table ou simpletable ou title ou draft-comment ou required-cleanup ou fn ou indextermref ou indexterm ou data ou data-about ou foreign ou unknown) (un nombre quelconque)

Contenu par :

Doctype Parents
ditabase, reference refbody

Héritage :

- topic/section reference/refsyn

Attributs :

Nom Description Type de donnée Valeur par défaut Obligatoire ?
spectitle L'attribut de titre spécialisé permet aux architectes de types spécialisés de définir un titre fixe ou par défaut pour un élément spécialisé. Non prévu pour une utilisation directe par les auteurs. CDATA #IMPLIED non
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;) Un ensemble d'attributs liés, décrit à la section 25.7. %univ-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