arg

arg — An argument in a CmdSynopsis

Synopsis

arg ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • choice (enumeration) [default=“opt”]
    • “opt”
    • “plain”
    • “req”
  • rep (enumeration) [default=“norepeat”]
    • “norepeat”
    • “repeat”

Description

See cmdsynopsis for more information.

Processing expectations

May be formatted inline or as a displayed block, depending on context.

Attributes

Common attributes and common linking attributes.

choice

Indicates optionality.

Enumerated values:
“opt”

Formatted to indicate that it is optional.

“plain”

Formatted without indication.

“req”

Formatted to indicate that it is required.

rep

Indicates whether or not repetition is possible.

Enumerated values:
“norepeat”

Can not be repeated.

“repeat”

Can be repeated.

Parents

These elements contain arg: arg, cmdsynopsis, group, synopfragment.

Children

The following elements occur in arg: text, alt, anchor, annotation, arg, biblioref, group, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, option, phrase (db._phrase), remark, replaceable, sbr, subscript, superscript, synopfragmentref, xref.

See Also

cmdsynopsis, group, refsynopsisdiv, sbr, synopfragment, synopfragmentref

ChangeLog

This alpha reference page is $Revision: 7120 $ published Sun, 22 Jul 2007.