<varname>

The <varname> element specifies a variable that must be supplied to a software application. The variable name element is very similar to the <var> element, but <varname> is available outside of syntax diagrams. This element is part of the DITA software domain, a special set of DITA elements designed to document software tasks, concepts and reference information.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

+ topic/keyword sw-d/varname

Example

This section is non-normative.

<filepath>
  <varname>install-dir</varname>\projects\working\<varname>project-dir</varname>
       \source\<varname>filename</varname>.java
</filepath>

Content model

(Text | <text>)*

Not contained by any element.

Zero or more of the following
  • Text
  • <text>

Not contained by any element.

Inheritance

+ topic/keyword sw-d/varname

The <varname> element is specialized from <keyword>. It is defined in the sw-domain module.

Attributes

The following attributes are available on this element: Universal attribute group, outputclass, and @keyref.