sect1
sect1 — A top-level section of document.
Synopsis
- Sequence of:
- One of:
- Zero or more of:
- Optionally one of:
- Sequence of:
- One or more of:
annotation
bridgehead
remark
revhistory
- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequation
informalexample
informalfigure
informaltable
(db.cals.informaltable)informaltable
(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
- Optionally one of:
- Sequence of:
- One or more of:
- Zero or more of:
- One or more of:
- Sequence of:
- One or more of:
- Sequence of:
- One or more of:
- Zero or more of:
- One or more of:
- Sequence of:
- Zero or more of:
- One of:
Attributes
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,
sect1
…sect5
, which must be properly nested and can only be five levels deep.Recursive
section
s, which are alternatives to the numbered sections and have unbounded depth.simplesect
s, which are terminal. Thesimplesect
s 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.
- label
Specifies an identifying string for presentation purposes
- status
Identifies the editorial or publication status of the element on which it occurs
Children
The following elements occur in sect1: address
, anchor
, annotation
, bibliography
, bibliolist
, blockquote
, bridgehead
, calloutlist
, caution
, classsynopsis
, cmdsynopsis
, constraintdef
, constructorsynopsis
, destructorsynopsis
, epigraph
, equation
, example
, fieldsynopsis
, figure
, 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
, mediaobject
, methodsynopsis
, msgset
, note
, orderedlist
, para
, procedure
, productionset
, programlisting
, programlistingco
, qandaset
, 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
, variablelist
, warning
.
See Also
bridgehead
, sect2
, sect3
, sect4
, sect5
, section
, simplesect