refsect1

refsect1 — A major subsection of a reference entry.

Synopsis

refsect1 ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • label
  • status

Additional Constraints

  • If this element is the root element, it must have a version attribute.

Description

Reference pages have their own hierarchical structure. A refsect1 is a major division in a refentry, analogous to a sect1 elsewhere in the document.

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 sect1 in DocBook V3.1 without introducing it to refentrys, in which it would not be desirable.

Processing expectations

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.

In those cases, it may be useful to replace refsect1 in the content model with a set of named sections (following the pattern of refnamediv and refsynopsisdiv).

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.

Attributes

Common attributes and common linking attributes.

label

Specifies an identifying string for presentation purposes

status

Identifies the editorial or publication status of the element on which it occurs

Parents

These elements contain refsect1: refentry.

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