Name
caution — A note of caution
Synopsis
caution ::=
((((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
Additional constraints
caution
must not occur among the children or descendants ofcaution
.important
must not occur among the children or descendants ofcaution
.note
must not occur among the children or descendants ofcaution
.tip
must not occur among the children or descendants ofcaution
.warning
must not occur among the children or descendants ofcaution
.
Description
A caution
is an admonition, usually set off
from the main text.
In some types of documentation, the semantics of admonitions are
clearly defined (a caution
might imply the
possibility of harm to equipment whereas a warning
might imply harm to a person). However, DocBook makes no such
assertions.
Processing expectations
Formatted as a displayed block. Often outputs the generated text
“Caution” or some other visible indication of the type of
admonition, especially if a title
is not present.
Sometimes outputs a graphical icon or other symbol as well.
See Also
important
, note
, tip
, warning
Examples
<article xmlns='http://docbook.org/ns/docbook'> <title>Example caution</title> ...
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.