note

A <note> element contains information, differentiated from the main text, which expands on or calls attention to a particular point.

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

Contains

( text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or p or lq or dl or parml or ul or ol or sl or pre or codeblock or msgblock or screen or lines or fig or syntaxdiagram or imagemap or image or object or table or simpletable or draft-comment or required-cleanup or fn or indextermref or indexterm) (any number)

Contained by

body, section, example, desc, p, lq, li, itemgroup, dd, fig, stentry, draft-comment, fn, linkinfo, entry, conbody, prereq, context, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, propdesc, pd

Inheritance

topic/note

Attributes

Name Description Data Type Default Value Required?
type Defines the type of a note. For example, if the note is a tip, the word Tip is used to draw the reader's attention to it. If type is set to other, the value of the othertype attribute is used. If you use othertype, there needs to be a stylesheet or transform override that does something with the information, or it will be ignored. Allowable values for the type attribute are:
note
This is just a note.
attention
Please pay extra attention to this note.
caution
Care is required when proceeding. For example:
<note type="caution">Contents 
may be erased.</note>
produces:
CAUTION:
You may reformat your hard drive.
danger
Important! Be aware of this before doing anything else. For example:
<note type="danger">You may 
hurt yourself!</note>
produces:
DANGER
You may hurt yourself!
fastpath
This note will speed you on your way.
important
This note is important.
remember
Don't forget to do what this note says.
restriction
You can't do what this note says.
tip
This is a fine little tip.
other
This is something other than a normal note.
(note | tip | fastpath | restriction | important | remember | attention | caution | danger | other) "note" No
spectitle The specialized title attribute allows architects of specialized types to define a fixed or default title for a specialized element. Not intended for direct use by authors. CDATA #IMPLIED No
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." CDATA #IMPLIED No
%univ-atts; (%select-atts;, %id-atts;, translate, xml:lang) A set of related attributes, described at %univ-atts; parameter entity PE not applicable Not applicable
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class, outputclass Common attributes described in Other common DITA attributes

Example

This example:
<note type="tip">Thinking of a seashore, green meadow, or cool
mountain overlook can help you to relax and be more
patient.</note>
produces this result:
Tip: Thinking of a seashore, green meadow, or cool mountain overlook can help you to relax and be more patient.

OASIS DITA Language Specification v1.0 -- 09 May 2005
Copyright (c) OASIS Open 2005. All Rights Reserved.