var
The var element defines a variable within a syntax diagram for which the user must supply content, such as their user name or password. Processors typically represent the var element in output in an italic font, but are not required to do so. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts, and reference information.
Content models
See appendix for information about this element in OASIS document type shells.
Inheritance
+ topic/ph pr-d/var
Example 397. Example
<syntaxdiagram frame="bottom">
<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
The following attributes are available on this element:
Universal attribute group (with a narrowed definition of
importance, given below) and
outputclass.
importance
The attribute indicates whether this item in a syntax diagram is optional, required, or default. Output processors can indicate this designation in a generated diagram. Allowable values are:
optional
This section of the syntax is optional.
required
This section of the syntax is required.
default
This section of the syntax is used by default or has this default value.
-dita-use-conref-target
Parent topic