warning

warning — An admonition set off from the text.

Synopsis

warning ::= [-]

Additional Constraints

  • caution must not occur among the children or descendants of warning
  • danger 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

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.

Children

The following elements occur in warning: address, anchor, bibliolist, blockquote, bridgehead, calloutlist, caution, danger, db:stagedir, dialogue, drama, epigraph, equation, example, figure, formalpara, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonly.info), informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, note, orderedlist, para, poetry, procedure, qandaset, remark, revhistory, sidebar, simpara, simplelist, table, task, tip, title, titleabbrev, variablelist, warning.

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 (git hash: c3457cab689d8fd89ba4252de204cf9a14e40acd 6a501344525f32f9834f0e4a5c3c3f8131803fa4 47fe34b28bad7941a61b9c1c17d47f6eed36cd04)