refsynopsisdiv — A syntactic synopsis of the subject of the reference page
refsynopsisdiv ::=
address
anchor
annotation
bibliolist
blockquote
bridgehead
calloutlist
caution
classsynopsis
cmdsynopsis
constraintdef
constructorsynopsis
destructorsynopsis
epigraph
equation
example
fieldsynopsis
figure
formalpara
funcsynopsis
glosslist
html:form
important
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)informalequation
informalexample
informalfigure
informaltable
(db.cals.informaltable)informaltable
(db.html.informaltable)itemizedlist
literallayout
mediaobject
methodsynopsis
msgset
note
orderedlist
para
procedure
productionset
programlisting
programlistingco
qandaset
remark
revhistory
screen
screenco
screenshot
segmentedlist
sidebar
simpara
simplelist
synopsis
table
(db.cals.table)table
(db.html.table)task
tip
variablelist
warning
RefSynopsisDiv
contains a syntactic synopsis of
the function or command described by the RefEntry
. When
RefEntry
s are used to describe other sorts of things,
RefSynopsisDiv
should be used for whatever succinct, synopsis
information seems appropriate.[8]
Formatted as a displayed block.
RefSynopsisDiv
usually generates a
section heading, in the same typographic style as a
RefSect1
Title
, called “Synopsis.”
Formatting reference pages may require a fairly sophisticated
processing system. Much of the meta-information about a
reference page (its name, type, purpose, title, and
classification) is stored in wrappers near the beginning of
the RefEntry
.
Common presentational features, such as titles and running headers, may require data from several of these wrappers plus some generated text. Other formatting often requires that these elements be reordered.
The following elements occur in refsynopsisdiv: address
, anchor
, annotation
, bibliolist
, blockquote
, bridgehead
, calloutlist
, caution
, classsynopsis
, cmdsynopsis
, constraintdef
, constructorsynopsis
, destructorsynopsis
, epigraph
, equation
, example
, fieldsynopsis
, figure
, formalpara
, funcsynopsis
, glosslist
, html:form
, important
, indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), info
(db.info), info
(db.titleforbidden.info), informalequation
, informalexample
, informalfigure
, informaltable
(db.cals.informaltable), informaltable
(db.html.informaltable), itemizedlist
, literallayout
, mediaobject
, methodsynopsis
, msgset
, note
, orderedlist
, para
, procedure
, productionset
, programlisting
, programlistingco
, qandaset
, refsect2
, refsection
, remark
, revhistory
, screen
, screenco
, screenshot
, segmentedlist
, sidebar
, simpara
, simplelist
, subtitle
, synopsis
, table
(db.cals.table), table
(db.html.table), task
, tip
, title
, titleabbrev
, variablelist
, warning
.
arg
, cmdsynopsis
, group
, refnamediv
, refsect1
, refsect2
, refsect3
, refsection
, sbr
, synopfragment
, synopfragmentref
[8] In this book, each element of the
DTD is described on a reference page,
and the RefSynopsisDiv
is used for
the synopsis at the beginning of each entry.