Attributes

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Description

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.[1]

Processing expectations

Formatted as a displayed block. RefSynopsisDiv usually generates a
section heading, in the same typographic style as a
RefSect1Title, 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.