<note>
A note is information that expands on or calls attention to a particular point.
Usage information
The nature of a note (for example,
caution, danger, or warning) is indicated through the values
selected for the @type attribute.
The values danger, notice, and warning have meanings that are based on ANSI Z535 and ISO 3864 regulations.
If @type is set to
other, the value of the
@othertype attribute can be used as a label for
the note. Many processors will require additional information on
how to process the value.
Rendering expectations
Processors SHOULD render a
label for notes. The content of the label depends on the values of
the @type attribute.
A note is typically rendered in a way that stands out from the surrounding content.
Content model
(Text |
<audio>
|
<dl>
|
<div>
|
<imagemap>
|
<example>
|
<fig>
|
<image>
|
<lines>
|
<lq>
|
<object>
|
<ol>
|
<p>
|
<pre>
|
<simpletable>
|
<sl>
|
<table>
|
<ul>
|
<video>
|
<cite>
|
<include>
|
<keyword>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<q>
|
<term>
|
<text>
|
<tm>
|
<xref>
|
<data>
|
<sort-as>
|
<foreign>
|
<draft-comment>
|
<fn>
|
<indexterm>
|
<required-cleanup>
)*
- Text
-
<audio> -
<b> -
<cite> -
<data> -
<div> -
<dl> -
<draft-comment> -
<em> -
<example> -
<fig> -
<fn> -
<foreign> -
<i> -
<image> -
<imagemap> -
<include> -
<indexterm> -
<keyword> -
<line-through> -
<lines> -
<lq> -
<object> -
<ol> -
<overline> -
<p> -
<ph> -
<pre> -
<q> -
<required-cleanup> -
<simpletable> -
<sl> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<table> -
<term> -
<text> -
<tm> -
<tt> -
<u> -
<ul> -
<video> -
<xref>
Attributes
The following attributes are available on this element: universal attributes and the attributes defined below.
@othertype- Specifies an alternate note type. This value is used as the
user-provided note label when the
@typeattribute value is set to other. @type- Specifies the type of a note. This
differs from the
@typeattribute on many other DITA elements. The following are the allowable values:- attention
- caution
- danger
- important
- note
- notice
- other
- remember
- restriction
- tip
- trouble
- warning
- -dita-use-conref-target
The following attributes are available on this element: universal attributes and the attributes defined below.
@othertype- Specifies an alternate note type. This value is used as the
user-provided note label when the
@typeattribute value is set to other. @type- Specifies the type of a note. This
differs from the
@typeattribute on many other DITA elements. The following are the allowable values:- attention
- caution
- danger
- important
- note
- notice
- other
- remember
- restriction
- tip
- trouble
- warning
- -dita-use-conref-target
Example
This section is non-normative.
The following code sample shows a <note> with @type set to
"tip":
<note type="tip">Thinking of a seashore, green meadow, or cool
mountain overlook can help you to relax and be more
patient.</note>