note

$Revision: 1.3 $

$Date: 2002/06/12 11:18:19 $

note — A message set off from the text

Synopsis

Content Model

note ::=
(title?,
 (calloutlist|glosslist|itemizedlist|orderedlist|segmentedlist|
  simplelist|variablelist|literallayout|programlisting|
  programlistingco|screen|screenco|screenshot|synopsis|
  cmdsynopsis|funcsynopsis|classsynopsis|fieldsynopsis|
  constructorsynopsis|destructorsynopsis|methodsynopsis|
  formalpara|para|simpara|address|blockquote|graphic|graphicco|
  mediaobject|mediaobjectco|informalequation|informalexample|
  informalfigure|informaltable|equation|example|figure|table|
  procedure|sidebar|anchor|bridgehead|remark|indexterm|beginpage)+)

Attributes

Common attributes

DocBook NG “Bourbon” Content Model

note ::=

Sequence of:

One of:

Sequence of:

Interleave of:

title?
titleabbrev?

info? (db.info.titleforbidden)

info (db.info.titleonly)

One or more of:

DocBook NG “Bourbon” Attributes

Common attributes and common linking attributes.

DocBook NG “Bourbon” Additional Constraints

caution must not occur in the descendants of note
important must not occur in the descendants of note
note must not occur in the descendants of note
tip must not occur in the descendants of note
warning must not occur in the 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 (Caution might imply the possibility of harm to equipement 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.

Parents

These elements contain note: answer, appendix, article, bibliodiv, bibliography, blockquote, callout, caption, chapter, colophon, dedication, entry, glossary, glossdiv, highlights, index, itemizedlist, legalnotice, listitem, msgexplan, msgtext, 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, variablelist.

Examples

<!DOCTYPE note PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<note><title>Upcoming Changes</title>
<para>
Future versions of this feature may not be backward-compatible.
Consider implementing the revised interface now.
</para>
</note>

Upcoming Changes

Future versions of this feature may not be backward-compatible. Consider implementing the revised interface now.