<h1>

Description

A level 1 heading.

Text within level 1 headings is searched during index construction.

Attributes

In addition to the following attributes, standard attributes may be defined on <h1> elements.

Attribute name Description
toc Include 'true' or exclude 'false' in the automatically generated table of contents.

Immediate descendants

<h1> elements may contain text.

No element descendants are defined for the <h1> element.

Immediate ancestors

Element name Relation
<chapter> The chapter containing the heading.

Example

<document xmlns="http://boradoc.org/1.0">
  <chapter>
    <h1>A heading</h1>
    <para>A paragraph of text.</para>
  </chapter>
</document>

The above BDML renders to the following:

A heading

A paragraph of text.