note
note — A message set off from the text.
Synopsis
note ::= ![[-]](figs/web/nav/down.gif)
- Sequence of:
- One of:
- One or more of:
annotationbridgeheadremarkrevhistory- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequationinformalexampleinformalfigureinformaltable(db.cals.informaltable)informaltable(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
- One of:
Attributes
Additional Constraints
- caution must not occur among the children or descendants of note
- important must not occur among the children or descendants of note
- note must not occur among the children or descendants of note
- tip must not occur among the children or descendants of note
- warning must not occur among the children or descendants of note
- If this element is the root element, it must have a version attribute.
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 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
“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 ![[+]](figs/web/nav/right.gif)
This element occurs in 74 elements.
Children
This element contains 63 elements.
Examples
<article xmlns='http://docbook.org/ns/docbook'> <title>Example note</title> <note><title>Upcoming Changes</title> <para>Future versions of this feature may not be backward compatible. Consider implementing the revised interface now. </para> </note> </article>
Upcoming Changes
Future versions of this feature may not be backward compatible. Consider implementing the revised interface now.