SyntaxdiagramThe syntax diagram (<syntaxdiagram>) element
is the main container for all the syntax elements that make up a syntax definition.
The syntax diagram represents the syntax of a statement from a computer language,
or a command, function call or programming language statement. Traditionally,
the syntax diagram is formatted with "railroad tracks" that connect the
units of the syntax together, but this presentation may differ depending on
the output media. The syntax diagram element is part of the DITA programming
domain, a special set of DITA elements designed to document programming tasks,
concepts and reference information.
[edit] Example
<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>
[edit] Contains
[edit] Contained by
| 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
|
[edit] Inheritance:
+ topic/fig pr-d/syntaxdiagram
[edit] Attributes
| Name
| Description
| Data Type
| Default Value
| Required?
|
| %display-atts; (scale, frame, expanse)
| A set of related attributes, described at %display-atts;
| parameter entity
| PE not
applicable
| Not applicable
|
| %univ-atts; (%select-atts;, %id-atts;, %localization-atts;)
| A set of related attributes, described at %univ-atts;
| parameter entity
| PE not
applicable
| Not applicable
|
| %global-atts; (xtrf, xtrc)
| A set of related attributes, described at %global-atts;
| parameter entity
| PE not
applicable
| Not applicable
|
| class, outputclass
| Common attributes described in Other common DITA attributes
|
|
|
|
TOC: Language Specification 1.1
Parent topic: Programming elements
Previous topic: synph
Next topic: groupseq
|
|
