The type attribute

The type attribute is most often used on linking elements to describe the target of a cross-reference. It is also used on the note element to describe the type of the current note, and on several other elements for varying purposes.

The descriptions for the type attribute on linking elements and on note are too long to fit in the usual attribute table, so they are included in this section; for other elements, such as audience, copyright, or object, the description can be found with the element.

Using type on a linking element

The type attribute describes the target of a cross-reference and may generate cross-reference text based on that description. Only the <xref> element can link to content below the topic level: other types of linking can target whole topics, but not parts of topics. Typically <xref> should also be limited to topic-level targets, unless the output is primarily print-oriented. Web-based referencing works best at the level of whole topics, rather than anchor locations within topics.

When the type attribute is unspecified, it should be determined by inspecting the target if possible. If the target cannot be inspected for some reason, the value should default to "topic".

If the type attribute is specified when referencing DITA content, it should match one of the values in the target's class attribute. For example, if type="topic", the link could be to a generic topic, or any specialization of topic, including concept, task, and reference. Applications may, but need not, issue a warning when the specified or inherited type attribute value does not match the target (or a specialization ancestor of the target).

Some possible values for use on the xref element and its specializations include:

Indicates a link to a figure.
Indicates a link to a table.
Indicates a link to an ordered list item.
Indicates a link to a footnote.
"section" indicates a link to a section.

Other values that may be used on any linking element include:

concept, task, reference, topic
Cross-reference to a topic type.
(no value)
The processor should retrieve the actual type from the target if available. If the type cannot be determined, the default should be treated as "topic".

Other values can be used to indicate other types of topics or elements as targets. Processing is only required to support the above list, or specializations of types in that list. Supporting additional types as targets may require the creation of processing overrides.

Using type in a note element

In a note element, this defines the type of note. For example, if the note is a tip, the word Tip may be used to draw the reader's attention to it. If type is set to other, the value of the othertype attribute may be used. If you use othertype, many processors will require additional information on how to process the value. Allowable values for the type attribute are:

This is just a note.
Please pay extra attention to this note.
Care is required when proceeding.
Important! Be aware of this before doing anything else.
This note will speed you on your way.
This note is important.
Don't forget to do what this note says.
You can't do what this note says.
This is a fine little tip.
This is something other than a normal note.
See Using the -dita-use-conref-target value for more information.

Return to main page.

OASIS DITA Version 1.1 Language Specification -- OASIS Standard, 1 August 2007
Copyright © OASIS Open 2005, 2007. All Rights Reserved.