The <subjectref> element identifies a subject to classify content. The <subjectref> can identify the subject with a keyref attribute (if the scheme has a <subjectdef> with a keys attribute that assigns a key to the subject) or an href attribute (if the scheme is not available and a topic exists that defines the subject).
Doctype | Content model |
---|---|
classifyMap | ( (topicmeta) (optional) then (data or data-about) (any number) ) |
In the following example, the map is classified as covering the Linux subject and the "Developing web applications" topic as covering the web and development subjects. These subjects (and their keys) are defined externally in a subject scheme map; in order to reference the subject directly without the subject scheme map, the href attribute would be used in place of keyref.
<map> <title>Working with Linux</title> <topicsubject keyref="linux"/> <!-- ... --> <topicref href="webapp.dita" navtitle="Developing web applications"> <topicsubject> <subjectref keyref="web"/> <subjectref keyref="development"/> </topicsubject> <!-- ... --> </topicref> <!-- ... --> </map>
Name | Description | Data Type | Default Value | Required? |
---|---|---|---|---|
navtitle | Specifies the title of the topic as it will appear in the navigation or tables of contents that are generated from the map. Beginning with DITA 1.2, the preferred way to specify the navigation title in a map is with the navtitle element, available inside the topicmeta element. | CDATA | #IMPLIED | No |
href | A pointer to the resource represented by the <topicref>. See The href attribute for detailed information on supported values and processing implications. References to DITA content cannot be below the topic level: that is, you cannot reference individual elements inside a topic. References to content other than DITA topics should use the format attribute to identify the kind of resource being referenced. | CDATA | #IMPLIED | No |
keys | Introduces one or more global identifiers for a resource referenced from a map. See The keys attribute for details on how to use the keys attribute. | NMTOKEN | #IMPLIED | No |
keyref | Keyref provides a redirectable reference based on a key defined within a map. See The keyref attribute for information on using this attribute. | CDATA | #IMPLIED | No |
query | This attribute is deprecated. It may be removed in the future. | CDATA | #IMPLIED | No |
collection-type | Collection types describe how links relate to each other.
The processing default is "unordered", although no default is specified in the
DTD or Schema.
Usage of the collection-type attribute on <reltable> and <relcolspec> is currently undefined and reserved for future use. |
(unordered | sequence | choice | family | -dita-use-conref-target) | #IMPLIED | No |
type | Describes the target of a reference. See The type attribute for detailed information on supported values and processing implications. | CDATA | #IMPLIED | No |
processing-role | Describes the processing role of the referenced topic. The
default for this attribute on this element is "resource-only".
If the value is not specified locally, but
is specified on an ancestor, the value will cascade from the closest
ancestor.
|
(normal | resource-only | -dita-use-conref-target) | resource-only | No |
scope | The scope attribute identifies the closeness of the relationship between the current document and the target resource. See The scope attribute for more information on values. | (local | peer | external | -dita-use-conref-target) | #IMPLIED | No |
format | The format attribute identifies the format of the resource being referenced. See The format attribute for details on supported values. | CDATA | #IMPLIED | No |
linking | Defines some specific linking characteristics of a
topic's current location in the map.
If the value is not specified locally, but
is specified on an ancestor, the value will cascade from the closest
ancestor.
|
(targetonly | sourceonly | normal | none | -dita-use-conref-target) | #IMPLIED | No |
toc | Specifies whether a topic appears in the table of contents (toc); on this element the default is no. This value defaults to no for elements such as reltable, which typically cannot appear in the toc, and for elements such as glossref that generally are not desired in the toc. | (yes | no | -dita-use-conref-target) | "no" | No |
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | A set of related attributes, described in univ-atts attribute group | |||
global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
class, outputclass | Common attributes described in Other common DITA attributes |
Return to main page.
OASIS DITA Version 1.2 -- OASIS Standard, 1 December 2010
Copyright © OASIS Open 2005, 2010. All Rights Reserved.