DocBook 5: The Definitive Guide

Name

refsect1 — A major subsection of a reference entry

Synopsis

refsect1 ::= ((((title & titleabbrev? & subtitle?), info? ^{db.titleforbidden.info}) | info ^{db.titlereq.info}), (((annotation | bridgehead | remark | revhistory | Indexing inlines | Admonition elements | Formal elements | Graphic elements | Informal elements | List elements | Paragraph elements | Publishing elements | Synopsis elements | Technical elements | Verbatim elements)+, refsect2*) | refsect2+))

Attribute synopsis

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 ...