syntaxdiagram

The 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. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts, and reference information.

Contains

Note: These models represent only the default document types distributed by OASIS. Actual content models will differ with each new document type.

Doctype	Content model
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap	( (title) (optional) then (fragment or fragref or groupchoice or groupcomp or groupseq or synblk or synnote or synnoteref) (any number) )

Contained by

Doctype	Content model
topic (technical content)	p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, pd
map (technical content), bookmap	p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, pd
concept	p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, conbody, pd
ditabase	p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, conbody, prereq, context, steps-informal, stepsection, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, glossdef, glossUsage, glossScopeNote, pd
glossary, glossentry, glossgroup	p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, conbody, glossdef, glossUsage, glossScopeNote, pd
reference	p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, refsyn, proptypehd, propvaluehd, propdeschd, pd
task (strict), task (general)	p, note, lq, li, itemgroup, dd, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, prereq, context, steps-informal, stepsection, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, pd

Inheritance

+ topic/fig pr-d/syntaxdiagram

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>

Attributes

Name	Description	Data Type	Default Value	Required?
display-atts attribute group (scale, frame, expanse)	A set of related attributes, described in display-atts attribute group
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)	A set of related attributes, described in univ-atts attribute group
global-atts attribute group (xtrf, xtrc)	A set of related attributes, described in global-atts attribute group
class, outputclass	Common attributes described in Other common DITA attributes

3.2.6.2.12 syntaxdiagram

Contains

Contained by

Inheritance

Example

Attributes