14.11. syntaxdiagram

L'élément de diagramme de syntaxe (<syntaxdiagram>) est le conteneur principal de tous les éléments de syntaxe qui constituent une définition de syntaxe. Le diagramme de syntaxe représente la syntaxe d'une déclaration d'un langage informatique, ou une commande, un appel de fonction ou une déclaration de langage de programmation. Traditionnellement, le diagramme de syntaxe est formaté avec des « chemins de fer » qui relient les blocs de la syntaxe, mais cette présentation peut différer selon le média de sortie. L'élément de diagramme de syntaxe appartient au domaine programming DITA, un jeu spécial d'éléments DITA conçus pour documenter des tâches, concepts et informations de référence de programmation.

Exemple

<syntaxdiagram>
 <title>CopyFile</title>
 <groupseq><kwd>COPYF</kwd></groupseq>
 <groupcomp><var>input-filename</var><kwd>*INFILE</kwd></groupcomp>
 <groupseq><var>output-filename</var><kwd>*OUTFILE</kwd></groupseq>
 <groupchoice> <var>input-filename</var> <kwd>*INFILE</kwd></groupchoice>
 <groupchoice> <var>output-filename</var> <kwd>*OUTFILE</kwd></groupchoice>
</syntaxdiagram>

Contient :

Doctype Modèle de contenu
ditabase, topic, task, reference, concept, glossary ( ( title) (optionnel) puis ( groupseq ou groupchoice ou groupcomp ou fragref ou fragment ou synblk ou synnote ou synnoteref) (un nombre quelconque) )

Contenu par :

Doctype Parents
ditabase p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, conbody, prereq, context, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, glossdef, pd
topic p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, pd
task p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, prereq, context, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, pd
concept p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, conbody, pd
reference p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, refsyn, proptypehd, propvaluehd, propdeschd, pd
glossary p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, section, example, conbody, glossdef, pd

Héritage :

+ topic/fig pr-d/syntaxdiagram

Attributs :

Nom Description Type de donnée Valeur par défaut Obligatoire ?
%display-atts; (scale, frame, expanse) Un ensemble d'attributs liés, décrit à la section 25.1. %display-atts; entité paramètre sans objet pour une entité paramètre sans objet
%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