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.


+ topic/ph pr-d/var


<syntaxdiagram frame="bottom">


The following attributes are available on this element: Universal attribute group (with a narrowed definition of @importance, given below) and @outputclass.

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:
This section of the syntax is optional.
This section of the syntax is required.
This section of the syntax is used by default or has this default value.
See Using the -dita-use-conref-target value for more information.

Was this helpful?