refsect1 — A major subsection of a reference entry.
- Sequence of:
- One of:
- One of:
- If this element is the root element, it must have a version attribute.
The value of a separate hierarchical structure is that it allows
the content model of sections in reference pages to be customized
differently than the content model of sections outside. For example,
because of this split, it was easy to add a recursive sectioning element
section) as a peer to
DocBook V3.1 without introducing it to
refentrys, in which it would not be
Formatted as a displayed block.
In some environments, the name, number, and order of major divisions in a reference page are strictly defined by house style. For example, one style requires that the first major section after the synopsis be the “Description,” which it must have as its title.
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
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.
The following elements occur in refsect1: