DocBook 5: The Definitive Guide

Name

note — A message set off from the text

Synopsis

note ::= ((((title? & titleabbrev?), info? ^{db.titleforbidden.info}) | info ^{db.titleonly.info}), (annotation | bridgehead | remark | revhistory | Indexing inlines | Admonition elements | Formal elements | Graphic elements | Informal elements | List elements | Paragraph elements | Publishing elements | Synopsis elements | Technical elements | Verbatim elements)+)

Attribute synopsis

Common attributes and common linking attributes.

Additional constraints

• caution must not occur among the children or descendants of note.

• important must not occur among the children or descendants of note.

• note must not occur among the children or descendants of note.

• tip must not occur among the children or descendants of note.

• warning must not occur among the children or descendants of note.

Description

A note is an admonition set off from the main text.

In some types of documentation, the semantics of admonitions are clearly defined (caution might imply the possibility of harm to equipment whereas warning might imply harm to a person), but DocBook makes no such assertions.

Processing expectations

Formatted as a displayed block. Often outputs the generated text “Note” or some other visible indication of the type of admonition, especially if a title is not present. Sometimes outputs a graphical icon or another symbol as well.

See Also

caution, important, tip, warning

Examples

<article xmlns='http://docbook.org/ns/docbook'> <title>Example note</title> <note><title>Upcoming ...