warning

$Revision: 1666 $

$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $

warning — An admonition set off from the text

Synopsis

Content Model

warning ::=
(title?,
 (%admon.mix;)+)

Attributes

Common attributes

Parameter Entities

The following parameter entities contain warning:

Parameter Entities
`%admon.class;`	`%bookcomponent.content;`	`%component.mix;`
`%divcomponent.mix;`	`%highlights.mix;`	`%legalnotice.mix;`
`%listpreamble.mix;`	`%para.mix;`	`%qandaset.mix;`
`%refcomponent.mix;`	`%revdescription.mix;`	`%sidebar.mix;`
`%tabentry.mix;`	`%tbl.entry.mdl;`	`%textobject.mix;`

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.

Parents

These elements contain warning: answer, appendix, article, bibliodiv, bibliography, blockquote, callout, caption, chapter, colophon, dedication, entry, glossary, glossdiv, highlights, index, itemizedlist, legalnotice, listitem, msgexplan, msgtext, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, variablelist.

Examples

<!DOCTYPE warning PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<warning>
<para>
Striking your thumb with a hammer may cause severe pain and discomfort.
</para>
</warning>

Warning

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

For additional examples, see also videoobject.