sect1

sect1 — A top-level section of document.

Synopsis

sect1 ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • At most one of:
    • class (enumeration)
      • “legal”
    • All or none of:
      • class (enumeration)
        • “other”
      • otherclass (NMTOKEN)
  • label
  • status

Additional Constraints

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

Description

A sect1 is one of the top-level sectioning elements in a component. There are three types of sectioning elements in DocBook:

  • Explicitly numbered sections, sect1sect5, which must be properly nested and can only be five levels deep.

  • Recursive sections, which are alternatives to the numbered sections and have unbounded depth.

  • simplesects, which are terminal. The simplesects can occur as the leaf sections in either recursive sections or any of the numbered sections, or directly in components.

None of the sectioning elements is allowed to float in a component. You can place paragraphs and other block elements before a section, but you cannot place anything after it.

This means that you cannot have content in the sect1 after the end of a sect2. This is consistent with the DocBook book model, because in a printed book it is usually impossible for a reader to detect the end of the enclosed second-level section and, therefore, all content after a second-level section appears in that section.

Processing expectations

Formatted as a displayed block. Sometimes sections are numbered.

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

class

Identifies the nature of the section

label

Specifies an identifying string for presentation purposes

otherclass

Identifies a non-standard section class

status

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

Parents

These elements contain sect1: appendix, article, chapter, partintro, preface, topic.

Children

The following elements occur in sect1: address, anchor, annotation, bibliography, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, danger, destructorsynopsis, enumsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalgroup, formalpara, funcsynopsis, glossary, glosslist, important, index, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titlereq.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, macrosynopsis, mediaobject, methodsynopsis, msgset, note, orderedlist, packagesynopsis, para, procedure, productionset, programlisting, programlistingco, qandaset, refentry, remark, revhistory, screen, screenco, screenshot, sect2, segmentedlist, sidebar, simpara, simplelist, simplesect, subtitle, synopsis, table (db.cals.table), table (db.html.table), task, tip, title, titleabbrev, toc, typedefsynopsis, unionsynopsis, variablelist, warning.

See Also

Related elements: bridgehead, sect2, sect3, sect4, sect5, section, simplesect.