note
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# note

## Name

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

### Parameter Entities

The following parameter entities contain note:

Parameter Entities
`%admon.class;` | `%bookcomponent.content;` | `%component.mix;`
`%divcomponent.mix;` | `%highlights.mix;` | `%legalnotice.mix;`
`%para.mix;` | `%qandaset.mix;` | `%refcomponent.mix;`
`%revdescription.mix;` | `%sidebar.mix;` | `%tabentry.mix;`
`%tbl.entry.mdl;` | `%textobject.mix;` |

## 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`, `legalnotice`, `listitem`, `msgexplan`, `msgtext`, `para`, `partintro`, `preface`, `procedure`, `qandadiv`, `qandaset`, `question`, `refsect1`, `refsect2`, `refsect3`, `refsynopsisdiv`, `revdescription`, `sect1`, `sect2`, `sect3`, `sect4`, `sect5`, `section`, `setindex`, `sidebar`, `simplesect`, `step`, `textobject`.

### Children

The following elements occur in note: `address`, `anchor`, `beginpage`, `blockquote`, `bridgehead`, `calloutlist`, `classsynopsis`, `cmdsynopsis`, `constructorsynopsis`, `destructorsynopsis`, `equation`, `example`, `fieldsynopsis`, `figure`, `formalpara`, `funcsynopsis`, `glosslist`, `graphic`, `graphicco`, `indexterm`, `informalequation`, `informalexample`, `informalfigure`, `informaltable`, `itemizedlist`, `literallayout`, `mediaobject`, `mediaobjectco`, `methodsynopsis`, `orderedlist`, `para`, `procedure`, `programlisting`, `programlistingco`, `remark`, `screen`, `screenco`, `screenshot`, `segmentedlist`, `sidebar`, `simpara`, `simplelist`, `synopsis`, `table`, `title`, `variablelist`.

## See Also

`caution`, `important`, `tip`, `warning`.

## 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.

For additional examples, see also `programlistingco` .

Prev | Home | Next
nonterminal | Up | objectinfo

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.