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. 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.
<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>
Doctype | Content model |
---|---|
ditabase, topic, task, reference, concept, glossary | ( ( title) (optional) then ( groupseq or groupchoice or groupcomp or fragref or fragment or synblk or synnote or synnoteref) (any number) ) |
+ topic/fig pr-d/syntaxdiagram
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 |
Return to main page.
OASIS DITA Language Specification v1.1 -- Committee Draft 02, 8 May 2007
Copyright © OASIS Open 2005, 2007. All Rights Reserved.