refpurpose

refpurpose — A short (one sentence) synopsis of the topic of a reference page.

Synopsis

refpurpose ::= [-]

Description

The refpurpose is a concise summary of the topic of the reference page. A refpurpose is usually limited to a single, short sentence.

Processing expectations

Formatted inline. See refnamediv.

In a large reference, refnames and refpurposes are sometimes used to construct a permuted index. A permuted index is a keyword-in-context concordance of lines, like the short definitions in this element reference; the keyword cycles alphabetically through the words of the (definition) lines.

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 refpurpose: refnamediv.

Examples

See reference and refentry for examples that use this element.

Last revised by Norman Walsh on (git hash: 4460ecff4b65268b558037cbda9fadcfb9e3e09a 7c5a17532e372309975fdbdf572c92cf383a8b5d d8336abc499f0c937e6dbe0a81964bf398e6987d)