caution

caution — A note of caution.

Synopsis

caution ::= [-]

Additional Constraints

  • caution must not occur among the children or descendants of caution
  • danger must not occur among the children or descendants of caution
  • important must not occur among the children or descendants of caution
  • note must not occur among the children or descendants of caution
  • tip must not occur among the children or descendants of caution
  • warning must not occur among the children or descendants of caution
  • If this element is the root element, it must have a version attribute.

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.

Examples

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

<caution><title>No User Servicable Parts Inside</title>
<para>Breaking this seal voids all warranties.
</para>
</caution>

</article>

No User Servicable Parts Inside

Breaking this seal voids all warranties.

Last revised by Norman Walsh on (git hash: 8efbb30ec1f2a59299576c057927c2032216aea4 f2da477a142b88c50ef9ceb6f54ce6b54fca5836)