note

note — A message set off from the text.

Synopsis

note ::= [-]

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.

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.

Last revised by Norman Walsh on (git hash: a5bf9d0f457b11f1d181c442e7789af392c4e1b6 9ea0f4c253876426b585b1ed5a3a381a983013c5)