note

Simplified DocBook: The Definitive Guide (Version 0.9.1 for Simplified DocBook 5.1)

note

note — A message set off from the text.

Synopsis

note ::=

Sequence of:
- One of:
  - Sequence of:
    Interleave of:
    title?
    titleabbrev?
    info? (db.titleforbidden.info)
  - info (db.titleonly.info)
- One or more of:
  - Sequence of:
    note
  - empty
  - empty
  - Sequence of:
    note
  - revhistory
  - Formal elements
    example
    figure
    table (db.cals.table)
    table (db.html.table)
  - Graphic elements
    mediaobject
  - Informal elements
    informaltable (db.cals.informaltable)
    informaltable (db.html.informaltable)
  - List elements
    itemizedlist
    orderedlist
    variablelist
  - Paragraph elements
    para
  - Publishing elements
    blockquote
    epigraph
    sidebar
  - Verbatim elements
    literallayout
    programlisting

Attributes

Common attributes and common linking attributes.

Additional Constraints

note 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 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: appendix, article, bibliodiv, bibliography, blockquote, caption (db.caption), entry, example, figure, footnote, itemizedlist, legalnotice, listitem, note, orderedlist, para, revdescription, section, sidebar, td, textobject, th, variablelist.

Children

The following elements occur in note: blockquote, epigraph, example, figure, info (db.titleforbidden.info), info (db.titleonly.info), informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, mediaobject, note, orderedlist, para, programlisting, revhistory, sidebar, table (db.cals.table), table (db.html.table), title, titleabbrev, variablelist.

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.