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|FormalPara|Para|SimPara|Address|
  BlockQuote|Graphic|GraphicCO|MediaObject|MediaObjectCO|
  InformalEquation|InformalExample|InformalFigure|InformalTable|
  Equation|Example|Figure|Table|Procedure|Sidebar|Anchor|
  BridgeHead|Comment|IndexTerm)+)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

%admon.class;%admon.exclusion;%bookcomponent.content;
%component.mix;%divcomponent.mix;%highlights.mix;
%legalnotice.mix;%para.mix;%refcomponent.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: Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Caption, Chapter, Colophon, Dedication, entry, Glossary, GlossDiv, Highlights, Index, LegalNotice, ListItem, MsgExplan, MsgText, Para, PartIntro, Preface, Procedure, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Sect1, Sect2, Sect3, Sect4, Sect5, Section, SetIndex, Sidebar, SimpleSect, Step, TextObject.

Children

The following elements occur in Caution: Address, Anchor, BlockQuote, BridgeHead, CalloutList, CmdSynopsis, Comment, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, Synopsis, Table, Title, VariableList.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: Equation, Example, Figure, IndexTerm, InformalTable, Table.

See Also

Important, Note, Tip, Warning

Examples

<!DOCTYPE caution PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<caution><title>No User Servicable Parts Inside</title>
<para>
Breaking this seal voids all warranties.
</para>
</caution>

CautionNo User Servicable Parts Inside
 

Breaking this seal voids all warranties.

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.