Name
refentrytitle — The title of a reference page
Synopsis
refentrytitle ::= (text | Bibliography inlines | Error inlines | Graphic inlines | GUI inlines | Indexing inlines | Keyboard inlines | Linking inlines | Markup inlines | Math inlines | Object-oriented programming inlines | Operating system inlines | Product inlines | Programming inlines | Publishing inlines | Technical inlines | Ubiquitous inlines)*
Attribute synopsis
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.
See Also
refdescriptor, refname
Examples
See refentry for examples that use this
element.
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
