note
note — A message set off from the text.
Synopsis
note ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Sequence of:
- One of:
- One or more of:
bridgeheaddialoguedramapoetryremarkrevhistory- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
- List elements
- Paragraph elements
- Publishing elements
- Technical elements
- Verbatim elements
- One of:
Attributes
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.
Parents
These elements contain note: acknowledgements, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption, chapter, colophon, dedication, dialogue, drama, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, index, informalexample, informalfigure, itemizedlist, legalnotice, linegroup, listitem, note, orderedlist, para, partintro, poetry, preface, procedure, qandadiv, qandaset, question, revdescription, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, textobject, toc, variablelist.
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.