Paragraphs are blocks of text terminated by a blank line, the end of
file, or the start of a DelimitedBlock. Paragraph markup is specified
by configuration file [paradef-*] sections.
Normal paragraphs consist of one or more non-blank lines of text. The first line must start hard against the left margin (no intervening white space). The default processing expectation is that of a normal paragraph of text. literal and verse paragraph styles are available (in addition to the default paragraph style).
Literal paragraphs are rendered verbatim in a monospaced font without any distinguishing background or border. By default there is no text formatting or substitutions within Literal paragraphs apart from Special Characters and Callouts.
The literal style is applied to indented paragraphs i.e. where the first line of the paragraph is indented by one or more space or tab characters. For example:
Consul *necessitatibus* per id, consetetur, eu pro everti postulant homero verear ea mea, qui.
Renders:
Consul *necessitatibus* per id, consetetur, eu pro everti postulant homero verear ea mea, qui.
| Note | |
|---|---|
Because lists can be indented it’s possible for your indented paragraph to be misinterpreted as a list — in situations like this apply the literal style to a normal paragraph. |
Instead of using a paragraph indent you could apply the literal style explicitly, for example:
[literal] Consul *necessitatibus* per id, consetetur, eu pro everti postulant homero verear ea mea, qui.
Renders:
Consul *necessitatibus* per id, consetetur, eu pro everti postulant homero verear ea mea, qui.
The verse paragraph style preserves line boundaries and is useful for lyrics and poems. For example:
[verse] Consul *necessitatibus* per id, consetetur, eu pro everti postulant homero verear ea mea, qui.
Renders:
Consul necessitatibus per id,
consetetur, eu pro everti postulant
homero verear ea mea, qui.
TIP, NOTE, IMPORTANT, WARNING and CAUTION admonishment
paragraph styles are generated by placing NOTE:, TIP:,
IMPORTANT:, WARNING: or CAUTION: as the first word of the
paragraph. For example:
NOTE: This is an example note.
Alternatively, you can specify the paragraph admonition style explicitly using an AttributeList element. For example:
[NOTE] This is an example note.
Renders:
| Note | |
|---|---|
This is an example note. |
| Tip | |
|---|---|
If your admonition requires more than a single paragraph use an admonition block instead. |
| Note | |
|---|---|
Admonition customization with |
By default the asciidoc(1) xhtml11 and html4 backends generate
text captions instead of admonition icon image links. To generate
links to icon images define the icons attribute, for example
using the -a icons command-line option.
The iconsdir attribute sets the location of linked icon
images.
You can override the default icon image using the icon attribute to
specify the path of the linked image. For example:
[icon="./images/icons/wink.png"] NOTE: What lovely war.
Use the caption attribute to customize the admonition captions (not
applicable to docbook backend). The following example suppresses the
icon image and customizes the caption of a NOTE admonition
(undefining the icons attribute with icons=None is only necessary
if admonition icons have been enabled):
[icons=None, caption="My Special Note"] NOTE: This is my special note.
This subsection also applies to Admonition Blocks.