refsynopsisdiv
refsynopsisdiv — A syntactic synopsis of the subject of the reference page.
Synopsis
refsynopsisdiv ::=
- Sequence of:
- One of:
- One of:
- Sequence of:
- One or more of:
annotation
bridgehead
formalgroup
remark
revhistory
- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequation
informalexample
informalfigure
informaltable
(db.cals.informaltable)informaltable
(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
- Optionally one of:
- One or more of:
- One or more of:
- One or more of:
- One or more of:
- One or more of:
- Sequence of:
Attributes
Common attributes and common linking attributes.
No additional attributes.
Additional Constraints
- If this element is the root element, it must have a version attribute.
Description
A 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.1
Processing expectations
Formatted as a displayed block. A
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.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
Parents
These elements contain refsynopsisdiv
: refentry
.
Children
The following elements occur in refsynopsisdiv
: address
, anchor
, annotation
, bibliolist
, blockquote
, bridgehead
, calloutlist
, caution
, classsynopsis
, cmdsynopsis
, constraintdef
, constructorsynopsis
, danger
, destructorsynopsis
, enumsynopsis
, epigraph
, equation
, example
, fieldsynopsis
, figure
, formalgroup
, formalpara
, funcsynopsis
, glosslist
, 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
, macrosynopsis
, mediaobject
, methodsynopsis
, msgset
, note
, orderedlist
, packagesynopsis
, 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
, typedefsynopsis
, unionsynopsis
, variablelist
, warning
.
See Also
Related elements: arg
, cmdsynopsis
, group
, refnamediv
, refsect1
, refsect2
, refsect3
, refsection
, sbr
, synopfragment
, synopfragmentref
.
Examples
See refentry
for an example using this element.