warning

warning — An admonition set off from the text.

Synopsis

warning ::= [-]

Additional Constraints

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

Description

A warning is an admonition, usually 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 “Warning” 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 warning</title>

<warning>
<para>Striking your thumb with a hammer may cause severe pain and discomfort.
</para>
</warning>

</article>

Warning

Striking your thumb with a hammer may cause severe pain and discomfort.

Last revised by Norman Walsh on 28 Apr 2016 (git hash: 8efbb30ec1f2a59299576c057927c2032216aea4)