subjectref

Darwin Information Typing Architecture (DITA) Version 1.3 Part 1: Base Edition

version
1.3
author
OASIS DITA Technical Committee

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).

Content models

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

Inheritance

+ map/topicref classify-d/subjectref

Example

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>

Attributes

The following attributes are available on this element: Universal attribute group, Link relationship attribute group (with a narrowed definition of href, given below), navtitle and query from Topicref element attributes group, outputclass, keyref, and keys. This element also uses collection-type, linking, and narrowed definitions of processing-role and toc (given below), from Attributes common to many map elements.

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.
processing-role
For this element, the default value for processing-role is "resource-only". Otherwise, the definition matches the one found in Attributes common to many map elements.
toc
Specifies whether a topic appears in the table of contents (TOC). If the value is not specified locally, but is specified on an ancestor, the value will cascade from the closest ancestor. On this element the default value for toc is "no". See Attributes common to many map elements for a complete definition of toc.