refentrytitle
refentrytitle — The title of a reference page.
Synopsis
- Zero or more of:
Attributes
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
.
See Also
Examples
See refentry
for examples that use this element.