caution

caution — A note of caution.

Synopsis

Additional Constraints

  • caution must not occur in the descendants of caution
  • important must not occur in the descendants of caution
  • note must not occur in the descendants of caution
  • tip must not occur in the descendants of caution
  • warning must not occur in the descendants of caution

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.

Parents [+]

This element occurs in 72 elements.

Children [+]

This element contains 63 elements.

Examples

  1 <article xmlns='http://docbook.org/ns/docbook'>
  2 <title>Example caution</title>
    
  4 <caution><title>No User Servicable Parts Inside</title>
    <para>Breaking this seal voids all warranties.
  6 </para>
    </caution>
  8 
    </article>

No User Servicable Parts Inside

Breaking this seal voids all warranties.

Last revised by Norman Walsh on 6 Jun 2011 (git hash: 6ffcc7640bbc5f852a318e452c9f210f03292cb9)