DocBook: The Definitive GuideBy Norman Walsh & Leonard Muellner1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM |
Warning
Synopsis
Content Model
Warning ::= (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
Tag Minimization
Both the start- and end-tags are required for this element.
Parameter Entities
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: 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 Warning: 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.
Examples
<!DOCTYPE warning PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <warning> <para> Striking your thumb with a hammer may cause severe pain and discomfort. </para> </warning>
Striking your thumb with a hammer may cause severe pain and discomfort.
For additional examples, see also VideoObject.
Back to: DocBook: The Definitive Guide
© 2001, O'Reilly & Associates, Inc.