warning
warning — An admonition set off from the text.
Synopsis
warning ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Sequence of:
- One of:
- One or more of:
annotationbridgeheadremarkrevhistory- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequationinformalexampleinformalfigureinformaltable(db.cals.informaltable)informaltable(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
- One of:
Attributes
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.
Parents
These elements contain warning: acknowledgements, annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, result, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, topic, variablelist, warning.
Children
The following elements occur in warning: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, 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 (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, mediaobject, methodsynopsis, msgset, note, orderedlist, para, procedure, productionset, programlisting, programlistingco, qandaset, remark, revhistory, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, synopsis, table (db.cals.table), table (db.html.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.