note

note — A message set off from the text

Synopsis

Additional Constraints

  • caution must not occur in the descendants of note
  • important must not occur in the descendants of note
  • note must not occur in the descendants of note
  • tip must not occur in the descendants of note
  • warning must not occur in the descendants of note

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.

See Also

caution, important, tip, warning

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.

ChangeLog

This alpha reference page is $Revision: 1.4 $ published $Date: 2005/10/31 12:31:55 $.