refentrytitle

refentrytitle — The title of a reference page.

Synopsis

refentrytitle ::= [-]

Description

A refentrytitle is the title of a reference page. It is frequently the same as the first refname or the refdescriptor, although it may also be a longer, more general title.

Processing expectations

Formatted as a displayed block.

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 heads, 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 refentrytitle: citerefentry, refmeta.

Examples

See refentry for examples that use this element.

Last revised by Norman Walsh on (git hash: a5bf9d0f457b11f1d181c442e7789af392c4e1b6 9ea0f4c253876426b585b1ed5a3a381a983013c5)