DocBook: The Definitive Guide
 | By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM |
| DocBook: The Definitive Guide | ||
|---|---|---|
| Prev | Next | |
Name
Note -- A message set off from the textSynopsis
Content Model
Note ::= (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
Description
A Note is an admonition 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 equipement 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 "Note" or some other visible indication of the type of admonition, especially if a Title is not present. Sometimes outputs a graphical icon or another symbol as well.
Parents
These elements contain Note: 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.
