caution
Prev	DocBook Element Reference	Next

caution

Name

caution — A note of caution

Synopsis

Content Model

caution ::=
(title?,
 (calloutlist|glosslist|itemizedlist|orderedlist|segmentedlist|
  simplelist|variablelist|literallayout|programlisting|
  programlistingco|screen|screenco|screenshot|synopsis|
  cmdsynopsis|funcsynopsis|classsynopsis|fieldsynopsis|
  constructorsynopsis|destructorsynopsis|methodsynopsis|
  formalpara|para|simpara|address|blockquote|graphic|graphicco|
  mediaobject|mediaobjectco|informalequation|informalexample|
  informalfigure|informaltable|equation|example|figure|table|
  procedure|sidebar|anchor|bridgehead|remark|indexterm|beginpage)+)

Attributes

Common attributes

Parameter Entities

The following parameter entities contain caution:

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

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 (Caution might imply the possibility of harm to equipment whereas 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.

Parents

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

Children

The following elements occur in caution: address, anchor, beginpage, blockquote, bridgehead, calloutlist, classsynopsis, cmdsynopsis, constructorsynopsis, destructorsynopsis, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glosslist, graphic, graphicco, indexterm, informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, mediaobjectco, methodsynopsis, orderedlist, para, procedure, programlisting, programlistingco, remark, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, synopsis, table, title, variablelist.

Examples

<!DOCTYPE caution PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<caution><title>No User Servicable Parts Inside</title>
<para>
Breaking this seal voids all warranties.
</para>
</caution>

No User Servicable Parts Inside

Breaking this seal voids all warranties.

Prev	Home	Next
caption	Up	chapter