synopsis
synopsis — A general-purpose element for representing the syntax of commands or functions.
Synopsis
synopsis ::=
- Sequence of:
info
? (db.titleforbidden.info)- One of:
- Zero or more of:
- text
lineannotation
- Bibliography inlines
- Computer-output inlines
abbrev
acronym
alt
anchor
annotation
biblioref
co
code
command
computeroutput
constant
coref
date
email
emphasis
(db._emphasis)envar
filename
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
literal
markup
nonterminal
olink
option
optional
package
parameter
phrase
(db._phrase)prompt
property
quote
(db._quote)remark
replaceable
subscript
superscript
symbol
systemitem
tag
termdef
token
trademark
uri
userinput
wordasword
xref
- Error inlines
- Graphic inlines
- GUI inlines
- Indexing inlines
- Keyboard inlines
- Linking inlines
- Markup inlines
- Math inlines
- Object-oriented programming inlines
- Operating system inlines
- Product inlines
- Programming inlines
- Publishing inlines
abbrev
acronym
coref
date
emphasis
(db.emphasis)firstterm
(db._firstterm)firstterm
(db.firstterm)footnote
footnoteref
foreignphrase
(db.foreignphrase)glossterm
(db._glossterm)glossterm
(db.glossterm)phrase
(db.phrase)quote
(db.quote)revnumber
subscript
superscript
wordasword
- Technical 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
- User-input inlines
abbrev
accel
acronym
alt
anchor
annotation
biblioref
co
code
command
computeroutput
constant
coref
date
email
emphasis
(db._emphasis)envar
filename
firstterm
(db._firstterm)footnote
footnoteref
foreignphrase
(db._foreignphrase)glossterm
(db._glossterm)guibutton
guiicon
guilabel
guimenu
guimenuitem
guisubmenu
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
keycap
keycode
keycombo
keysym
link
literal
markup
menuchoice
mousebutton
nonterminal
olink
option
optional
package
parameter
phrase
(db._phrase)prompt
property
quote
(db._quote)remark
replaceable
shortcut
subscript
superscript
symbol
systemitem
tag
termdef
token
trademark
uri
userinput
wordasword
xref
textobject
- Zero or more of:
Attributes
Common attributes and common linking attributes.
Additional attributes:
- All of:
- continuation (enumeration)
- “continues”
- “restarts”
- linenumbering (enumeration)
- “numbered”
- “unnumbered”
- startinglinenumber (integer)
- xml:space (enumeration)
- “preserve”
- language
- continuation (enumeration)
- label
Additional Constraints
- If this element is the root element, it must have a version attribute.
Description
A synopsis
is a verbatim environment for
displaying command, function, and other syntax summaries.
Unlike cmdsynopsis
and
funcsynopsis
which have a complex interior structure,
synopsis
is simply a verbatim environment.
Processing expectations
This element is displayed “verbatim”; whitespace and line breaks
within this element are significant. A synopsis
element is usually displayed in a fixed-width font.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
- continuation
Determines whether line numbering continues from the previous element or restarts
Enumerated values: “continues” Line numbering continues from the immediately preceding element with the same name.
“restarts” Line numbering restarts (begins at 1, usually).
- label
Specifies an identifying string for presentation purposes
- language
Identifies the language (i.e. programming language) of the verbatim content
- linenumbering
Determines whether lines are numbered
Enumerated values: “numbered” Lines are numbered.
“unnumbered” Lines are not numbered.
- startinglinenumber
Specifies the initial line number
- xml:space
Can be used to indicate explicitly that whitespace in the verbatim environment is preserved. Whitespace must always be preserved in verbatim environments whether this attribute is specified or not
Enumerated values: “preserve” Whitespace must be preserved.
Parents
These elements contain synopsis
: abstract
, acknowledgements
, annotation
, answer
, appendix
, article
, bibliodiv
, bibliography
, bibliolist
, blockquote
, callout
, calloutlist
, caption
(db.caption), caution
, chapter
, colophon
, constraintdef
, cover
, danger
, dedication
, entry
, example
, figure
, footnote
, glossary
, glossdef
, glossdiv
, glosslist
, important
, index
, indexdiv
, informalexample
, informalfigure
, itemizedlist
, legalnotice
, listitem
, meta
(db.meta.content), msgexplan
, msgtext
, note
, orderedlist
, para
, partintro
, preface
, procedure
, qandadiv
, qandaset
, question
, refsect1
, refsect2
, refsect3
, refsection
, refsynopsisdiv
, result
, revdescription
, sect1
, sect2
, sect3
, sect4
, sect5
, section
, setindex
, sidebar
, simplesect
, step
, taskprerequisites
, taskrelated
, tasksummary
, td
, textobject
, th
, tip
, toc
, tocdiv
, topic
, variablelist
, warning
.
Children
The following elements occur in synopsis
: text, abbrev
, accel
, acronym
, alt
, anchor
, annotation
, application
, author
, biblioref
, buildtarget
, citation
, citebiblioid
, citerefentry
, citetitle
, classname
, co
, code
, command
, computeroutput
, constant
, coref
, database
, date
, editor
, email
, emphasis
(db._emphasis), emphasis
(db.emphasis), enumidentifier
, enumname
, enumvalue
, envar
, errorcode
, errorname
, errortext
, errortype
, exceptionname
, filename
, firstterm
(db._firstterm), firstterm
(db.firstterm), footnote
, footnoteref
, foreignphrase
(db._foreignphrase), foreignphrase
(db.foreignphrase), function
, glossterm
(db._glossterm), glossterm
(db.glossterm), guibutton
, guiicon
, guilabel
, guimenu
, guimenuitem
, guisubmenu
, hardware
, indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), info
(db.titleforbidden.info), initializer
, inlineequation
, inlinemediaobject
, interfacename
, jobtitle
, keycap
, keycode
, keycombo
, keysym
, lineannotation
, link
, literal
, macroname
, markup
, menuchoice
, methodname
, modifier
, mousebutton
, nonterminal
, olink
, ooclass
, ooexception
, oointerface
, option
, optional
, org
, orgname
, package
, parameter
, person
, personname
, phrase
(db._phrase), phrase
(db.phrase), productname
, productnumber
, prompt
, property
, quote
(db._quote), quote
(db.quote), remark
, replaceable
, returnvalue
, revnumber
, shortcut
, subscript
, superscript
, symbol
, systemitem
, tag
, templatename
, termdef
, textobject
, token
, trademark
, type
, typedefname
, unionname
, uri
, userinput
, varname
, wordasword
, xref
.
See Also
Related elements: cmdsynopsis
, computeroutput
, funcsynopsis
, lineannotation
, literallayout
, programlisting
, screen
, screenshot
, userinput
.
Examples
1 |<article xmlns='http://docbook.org/ns/docbook'>
|<title>Example synopsis</title>
||
<synopsis>chgrp [-R [-H | -L | -P]] [-f] group file...</synopsis>
5 ||
</article>
|chgrp [-R [-H | -L | -P]] [-f] group file...
1 |<article xmlns='http://docbook.org/ns/docbook'>
|<title>Example synopsis</title>
||
<synopsis>int max(int int1, int int2);</synopsis>
5 ||
</article>
|int max(int int1, int int2);