note — A message set off from the text
note ::=
address
anchor
annotation
bibliolist
blockquote
bridgehead
calloutlist
caution
classsynopsis
cmdsynopsis
constraintdef
constructorsynopsis
destructorsynopsis
epigraph
equation
example
fieldsynopsis
figure
formalpara
funcsynopsis
glosslist
html:form
important
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)informalequation
informalexample
informalfigure
informaltable
(db.cals.informaltable)informaltable
(db.html.informaltable)itemizedlist
literallayout
mediaobject
methodsynopsis
msgset
note
orderedlist
para
procedure
productionset
programlisting
programlistingco
qandaset
remark
revhistory
screen
screenco
screenshot
segmentedlist
sidebar
simpara
simplelist
synopsis
table
(db.cals.table)table
(db.html.table)task
tip
variablelist
warning
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.
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.
These elements contain note
: annotation
, answer
, appendix
, article
, bibliodiv
, bibliography
, bibliolist
, blockquote
, callout
, calloutlist
, caption
(db.caption), caution
, chapter
, colophon
, constraintdef
, dedication
, entry
, example
, figure
, footnote
, glossary
, glossdef
, glossdiv
, glosslist
, html:fieldset
, html:form
, important
, index
, indexdiv
, informalexample
, informalfigure
, itemizedlist
, legalnotice
, listitem
, msgexplan
, msgtext
, note
, orderedlist
, para
, partintro
, preface
, procedure
, qandadiv
, qandaset
, question
, refsect1
, refsect2
, refsect3
, refsection
, refsynopsisdiv
, revdescription
, sect1
, sect2
, sect3
, sect4
, sect5
, section
, setindex
, sidebar
, simplesect
, step
, taskprerequisites
, taskrelated
, tasksummary
, td
, textobject
, th
, tip
, toc
, tocdiv
, variablelist
, warning
.
The following elements occur in note: address
, anchor
, annotation
, bibliolist
, blockquote
, bridgehead
, calloutlist
, caution
, classsynopsis
, cmdsynopsis
, constraintdef
, constructorsynopsis
, destructorsynopsis
, epigraph
, equation
, example
, fieldsynopsis
, figure
, formalpara
, funcsynopsis
, glosslist
, html:form
, important
, indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), info
(db.titleforbidden.info), info
(db.titleonly.info), informalequation
, informalexample
, informalfigure
, informaltable
(db.cals.informaltable), informaltable
(db.html.informaltable), itemizedlist
, literallayout
, mediaobject
, methodsynopsis
, msgset
, note
, orderedlist
, para
, procedure
, productionset
, programlisting
, programlistingco
, qandaset
, remark
, revhistory
, screen
, screenco
, screenshot
, segmentedlist
, sidebar
, simpara
, simplelist
, synopsis
, table
(db.cals.table), table
(db.html.table), task
, tip
, title
, titleabbrev
, variablelist
, warning
.
<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>
Future versions of this feature may not be backward-compatible. Consider implementing the revised interface now.