Name
refsynopsisdiv — A syntactic synopsis of the subject of the reference page
Synopsis
refsynopsisdiv ::=
((((title? &
titleabbrev? & subtitle?),
info? db.titleforbidden.info) |
info? db.info), (((annotation
| bridgehead | remark |
revhistory | Indexing inlines | Admonition elements | Formal elements | Graphic elements | Informal elements | List elements | Paragraph elements | Publishing elements | Synopsis elements | Technical elements | Verbatim elements)+,
(refsection+ | refsect2+)?) |
refsection+ | refsect2+))
Description
A refsynopsisdiv contains a syntactic synopsis
of the function or command described by the refentry.
When refentrys are used to describe other sorts of
things, refsynopsisdiv should be used for whatever
succinct, synopsis information seems appropriate.[6]
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.
See Also
arg, cmdsynopsis, group, refnamediv, refsect1, refsect2, refsect3, refsection, sbr, synopfragment, synopfragmentref
[6] In this book, each element of the schema is described on a
reference page, and the refsynopsisdiv is used
for the synopsis at the beginning of each entry.