note

note — A message set off from the text.

Synopsis

note ::= [-]

Additional Constraints

  • note must not occur among the children or 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 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.

Children

The following elements occur in note: address, anchor, bibliolist, blockquote, bridgehead, calloutlist, dialogue, drama, epigraph, equation, example, figure, formalpara, glosslist, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonly.info), informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, note, orderedlist, para, poetry, procedure, qandaset, remark, revhistory, sidebar, simpara, simplelist, table, task, title, titleabbrev, variablelist.

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.

Last revised by Norman Walsh on (git hash: c3457cab689d8fd89ba4252de204cf9a14e40acd 6a501344525f32f9834f0e4a5c3c3f8131803fa4 47fe34b28bad7941a61b9c1c17d47f6eed36cd04)