note

Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition

version
1.3
author
OASIS DITA Technical Committee

A note element contains information that expands on or calls attention to a particular point. This information is typically differentiated from the main text.

Tip: Variant types of note (tip, caution, danger, restriction, etc.) can be indicated through values selected on the type attribute. This note uses the attribute type="tip"

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

- topic/note

Example

The following code sample demonstrates the use of 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>

The sample markup could produce output such as the following:

Tip: Thinking of a seashore, green meadow, or cool mountain overlook can help you to relax and be more patient.

Attributes

The following attributes are available on this element: Universal attribute group, outputclass, spectitle, and the attributes defined below.

type
Defines the type of a note. For example, if the note is a tip, the word Tip might be used to draw the reader's attention to it. Note that this differs from the type attribute on many other DITA elements. See The type attribute for detailed information on supported values and processing implications. Available values are note, tip, fastpath, restriction, important, remember, attention, caution, notice, danger, warning, trouble, other, and -dita-use-​conref-​target.
othertype
Indicates an alternate note type, when the type is not available in the type attribute value list. This value is used as the user-provided note title when the type attribute value is set to "other".