caution

caution — A note of caution.

Synopsis

caution ::=

Attributes

Common attributes and common linking attributes.

No additional attributes.

Additional Constraints

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

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

Parents

These elements contain caution: abstract, acknowledgements, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption, caution, chapter, colophon, danger, dedication, dialogue, drama, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, important, index, informalexample, informalfigure, itemizedlist, legalnotice, linegroup, listitem, meta (db.meta.content), note, orderedlist, para, partintro, poetry, preface, procedure, qandadiv, qandaset, question, result, revdescription, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, textobject, tip, toc, variablelist, warning.

Children

The following elements occur in caution: address, anchor, bibliolist, blockquote, bridgehead, calloutlist, caution, danger, dialogue, drama, epigraph, equation, example, figure, formalgroup, 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, stagedir, table, task, tip, title, titleabbrev, variablelist, warning.

See Also

Related elements: danger, important, note, tip, warning.

Examples

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

Breaking this seal voids all warranties.