note
note — A message set off from the text.
Synopsis
note ::=
- Sequence of:
- One of:
- One or more of:
annotation
bridgehead
formalgroup
remark
revhistory
- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequation
informalexample
informalfigure
informaltable
(db.cals.informaltable)informaltable
(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
Attributes
Common attributes and common linking attributes.
No additional attributes.
Additional Constraints
- caution must not occur among the children or descendants of note
- danger 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.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
Parents
These elements contain note
: abstract
, acknowledgements
, annotation
, answer
, appendix
, article
, bibliodiv
, bibliography
, bibliolist
, blockquote
, callout
, calloutlist
, caption
(db.caption), caution
, chapter
, colophon
, constraintdef
, danger
, dedication
, entry
, example
, figure
, footnote
, glossary
, glossdef
, glossdiv
, glosslist
, important
, index
, indexdiv
, informalexample
, informalfigure
, itemizedlist
, legalnotice
, listitem
, meta
(db.meta.content), msgexplan
, msgtext
, note
, orderedlist
, para
, partintro
, preface
, procedure
, qandadiv
, qandaset
, question
, refsect1
, refsect2
, refsect3
, refsection
, refsynopsisdiv
, result
, revdescription
, sect1
, sect2
, sect3
, sect4
, sect5
, section
, setindex
, sidebar
, simplesect
, step
, taskprerequisites
, taskrelated
, tasksummary
, td
, textobject
, th
, tip
, toc
, tocdiv
, topic
, variablelist
, warning
.
Children
The following elements occur in note
: address
, anchor
, annotation
, bibliolist
, blockquote
, bridgehead
, calloutlist
, caution
, classsynopsis
, cmdsynopsis
, constraintdef
, constructorsynopsis
, danger
, destructorsynopsis
, enumsynopsis
, epigraph
, equation
, example
, fieldsynopsis
, figure
, formalgroup
, formalpara
, funcsynopsis
, glosslist
, 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
, macrosynopsis
, mediaobject
, methodsynopsis
, msgset
, note
, orderedlist
, packagesynopsis
, 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
, typedefsynopsis
, unionsynopsis
, variablelist
, warning
.
See Also
Examples
1 |<article xmlns='http://docbook.org/ns/docbook'>
|<title>Example note</title>
||
<note><title>Upcoming Changes</title>
5 |<para>Future versions of this feature may not be backward compatible.
|Consider implementing the revised interface now.
|</para>
|</note>
|10 |
</article>
Future versions of this feature may not be backward compatible. Consider implementing the revised interface now.