optional
optional — Optional information.
Synopsis
optional ::= × ⏵
- Zero or more of:
- text
optional
- Graphic inlines ⏵
- Indexing inlines ⏵
- Linking inlines ⏵
- Ubiquitous inlines ⏵
Attributes
Common attributes and common linking attributes.
No additional attributes.
Description
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
being documented.
Processing expectations
Formatted inline.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
Parents
34 elements contain optional
. × ⏵
Children
28 elements occur in optional
. × ⏵
See Also
Related elements: literal
.
Examples
1 |<article xmlns='http://docbook.org/ns/docbook'>
|<title>Example optional</title>
||
<synopsis>
5 |ls <option>-abcCdfFgilLmnopqrRstux1</option>
|<optional>names</optional>
|</synopsis>
||
</article>
||
ls
|-abcCdfFgilLmnopqrRstux1
names