optional — Optional information
optional ::=
alt
anchor
annotation
biblioref
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
olink
phrase
(db._phrase)remark
replaceable
subscript
superscript
xref
The Optional
element indicates that a specified argument,
option, or other text is optional. The precise meaning of
“optional” varies according to the application or process
begin documented.
Formatted inline.
Optional arguments in a Synopsis
are usually given special
typographic treatment, often they are surrounded by square brackets. The
Optional
tag is expected to generate the brackets.
Outside a Synopsis
, the typographic treatment of
Optional
is application-specific.
These elements contain optional
: bridgehead
, citation
, citetitle
, classsynopsisinfo
, computeroutput
, emphasis
(db.emphasis), entry
, firstterm
, funcsynopsisinfo
, glosssee
, glossseealso
, glossterm
, html:button
, html:label
, html:legend
, link
, literallayout
, member
, olink
, orgdiv
, para
, phrase
(db.phrase), primary
, primaryie
, programlisting
, quote
, refdescriptor
, refentrytitle
, refname
, refpurpose
, screen
, secondary
, secondaryie
, see
, seealso
, seealsoie
, seeie
, seg
, segtitle
, simpara
, subtitle
, synopsis
, td
, term
, termdef
, tertiary
, tertiaryie
, th
, title
, titleabbrev
, tocentry
, userinput
.
The following elements occur in optional: text, alt
, anchor
, annotation
, biblioref
, indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), inlinemediaobject
, link
, olink
, phrase
(db._phrase), remark
, replaceable
, subscript
, superscript
, xref
.
computeroutput
, constant
, literal
, markup
, option
, parameter
, prompt
, replaceable
, tag
, userinput
, varname