arg
arg — An argument in a cmdsynopsis.
Synopsis
arg ::=
- Zero or more of:
- text
arg
group
(db.group)option
replaceable
sbr
synopfragmentref
- Graphic inlines
- Indexing inlines
- Linking inlines
- Ubiquitous inlines
abbrev
acronym
alt
anchor
annotation
biblioref
coref
date
emphasis
(db._emphasis)firstterm
(db._firstterm)footnote
footnoteref
foreignphrase
(db._foreignphrase)glossterm
(db._glossterm)indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
olink
phrase
(db._phrase)quote
(db._quote)remark
subscript
superscript
trademark
wordasword
xref
Attributes
Common attributes and common linking attributes.
Additional attributes:
- choice (enumeration) [default=“opt”]
- “opt”
- “plain”
- “req”
- rep (enumeration) [default=“norepeat”]
- “norepeat”
- “repeat”
Description
Used in cmdsynopsis
for command arguments. See
cmdsynopsis
for more information and examples.
Processing expectations
May be formatted inline or as a displayed block, depending on context.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
- 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
(db.group), synopfragment
.
Children
The following elements occur in arg
: text, abbrev
, acronym
, alt
, anchor
, annotation
, arg
, biblioref
, coref
, date
, emphasis
(db._emphasis), firstterm
(db._firstterm), footnote
, footnoteref
, foreignphrase
(db._foreignphrase), glossterm
(db._glossterm), group
(db.group), indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), inlinemediaobject
, link
, olink
, option
, phrase
(db._phrase), quote
(db._quote), remark
, replaceable
, sbr
, subscript
, superscript
, synopfragmentref
, trademark
, wordasword
, xref
.
See Also
Related elements: cmdsynopsis
, group
, refsynopsisdiv
, sbr
, synopfragment
, synopfragmentref
.