Shaun McCance
shaunm@gnome.org 2007-2009
Mark up placeholder text that should be replaced by the user.

# Variable Text

    mal_inline_var = element var {
      mal_attr_link ?,
      attribute style { xsd:NMTOKENS } ?,
      attribute * - (mal:* | local:*) { text } *,

      mal_inline
    }

Use the `var` element to mark up placeholder text that should be replaced by the user. This is typically used inside a `cmd` or `code` element to indicate a replaceable argument, or within running prose to refer to an indicated argument.

# Notas

The `var` element can contain a mixture of text and any general inline elements.

The `var` element can occur in any general inline context, including inside most inline elements, some basic block elements, and certain informational elements.

The `var` element can link to other pages or documents. See for more information.

The `style` attribute takes a space-separated list of style hints. Processing tools should adjust their behavior according to those style hints they understand.

The `var` element can have attributes from external namespaces. See for more information on external-namespace attributes.

See and for examples using `var`.

# Processing Expectations

Variable text is typically displayed in an italic or oblique font. When used inside a fixed-width element such as `cmd` or `code`, it will inherit the fixed-width font. In running prose, however, the `var` element does not cause its contents to be displayed in a fixed-width font.

# Comparison to Other Formats

The `var` element is similar to the `replaceable` element in DocBook.