Reference. Reference for the DocBook DTD

[Prev] [Next]

Note

Name

Note---Message to the user, set off from the text

Synopsis

Content Model 
  (Title?, (CalloutList | GlossList | ItemizedList
  | OrderedList | SegmentedList | SimpleList | VariableList
  | LiteralLayout | ProgramListing | ProgramListingCO
  | Screen | ScreenCO | ScreenShot | Synopsis | CmdSynopsis
  | FuncSynopsis | FormalPara | Para | SimPara | Address
  | BlockQuote | Graphic | GraphicCO | InformalEquation
  | InformalExample | InformalTable | Equation | Example
  | Figure | Table | Procedure | Sidebar | Anchor | BridgeHead
  | Comment)+)
  -(Caution | Important | Note | Tip | Warning)

Exclusions

Note excludes these elements at every level: 

  Caution | Important | Note | Tip | Warning

Attributes

This element has common and Role attributes.

Tag Minimization

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

Description

Message to the user. Note is an admonition set off from the text, as are the other admonitions, Tip, Caution, Important, and Warning. Its contents may include paragraphs, lists, and so forth, but not other admonitions. It has common attributes.

Parents

These elements contain Note: Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Chapter, Dedication, GlossDiv, Glossary, Highlights, Index, LegalNotice, ListItem, MsgExplan, MsgText, Para, PartIntro, Preface, Procedure, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Sect1, Sect2, Sect3, Sect4, Sect5, SetIndex, Sidebar, SimpleSect, Step, and entry.

Children

Note contains these elements: Address, Anchor, BlockQuote, BridgeHead, CalloutList, CmdSynopsis, Comment, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, InformalEquation, InformalExample, InformalTable, ItemizedList, LiteralLayout, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, Synopsis, Table, Title, and VariableList.

In some contexts, additional elements may be allowed by inclusions in parent elements. Similarly, in some contexts, some of these elements may be invalid due to exclusions in parent elements.

Examples

<NOTE>
<TITLE>A Low Note</TITLE>
<PARA>Take care with all you do.
</PARA>
</NOTE>

[Prev] notation.class
[Next] OLink
[Reference Home] [Davenport Group Home]