AsciiDoc User Guide
Two line titles
A two line title consists of a title line, starting hard against the left margin, and an underline. Section underlines consist a repeated character pairs spanning the width of the preceding title (give or take up to three characters):
The default title underlines for each of the document levels are:
Level 0 (top level): |
====================== |
|
Level 1: |
---------------------- |
|
Level |
2: |
~~~~~~~~~~~~~~~~~~~~~~ |
Level |
3: |
^^^^^^^^^^^^^^^^^^^^^^ |
Level 4 (bottom level): ++++++++++++++++++++++
Examples:
Level One Section Title
-----------------------
Level 2 Subsection Title
~~~~~~~~~~~~~~~~~~~~~~~~
One line titles
One line titles consist of a line starting with one or more equals characters (the number of equals corresponds the section level) followed by a space followed by the title text. Here are some examples:
= Document Title (level 0) == Section title (level 1)
=== Section title (level 2)
==== Section title (level 3)
===== Section title (level 4)
The one-line title syntax can be changed by editing the configuration file [titles] section sect0…sect4 entries.
BlockTitles
A BlockTitle element is a single line beginning with a period followed by a title. The title is applied to the next Paragraph, DelimitedBlock, List, Table or BlockMacro. For example:
.Notes
-Note 1.
-Note 2.
is rendered as:
Notes
•Note 1.
•Note 2.
16