refsynopsisdiv

refsynopsisdiv — A syntactic synopsis of the subject of the reference page.

Synopsis

refsynopsisdiv ::= [-]

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 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.

Parents

These elements contain refsynopsisdiv: refentry.

Examples

See refentry for an example using this element.


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

Last revised by Norman Walsh on (git hash: 8efbb30ec1f2a59299576c057927c2032216aea4 f2da477a142b88c50ef9ceb6f54ce6b54fca5836)