subjectHead
The <subjectHead> element provides a heading for a group
of subjects, for use if the scheme is displayed. For instance, a scheme
may be displayed to let a user select subjects as part of faceted
browsing. The subjectHead element itself does not reference a file
and cannot be referenced as a key, so it does not define any controlled
values.
Contains
Note
These models represent only the default document types distributed by OASIS.
Actual content models will differ with each new document type.
Doctype | Content model |
---|---|
subjectScheme | ( (subjectHeadMeta) (optional) then (data or data-about or subjectdef or subjectHead or topicref or (anchorref or keydef or mapref or topicgroup or topichead or topicset or topicsetref) ) (any number) ) |
Contained by
Doctype | Content model |
---|---|
subjectScheme | subjectScheme, hasNarrower, hasKind, hasPart, hasInstance, hasRelated, subjectdef, subjectHead |
Inheritance
- map/topicref subjectScheme/subjectHead
Example
In this example the “Server setup” label doesn't classify content but, when selected, is equivalent to the union of its child subjects. That is, the heading covers content about planning for any application, installing for any application, any task for web servers, or any task for database servers.
<subjectScheme toc="yes" search="no"> ... <subjectHead> <subjectHeadMeta> <navtitle>Server setup</navtitle> </subjectHeadMeta> <subjectdef href="planningTaskType.dita"/> <subjectdef href="installingTaskType.dita"/> <subjectdef href="webServerApp.dita"/> <subjectdef href="databaseApp.dita"/> </subjectHead> ... </subjectScheme>
Attributes
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 |
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.
|
(unordered | sequence | -dita-use-conref-target) | #IMPLIED | No |
linking | Defines some specific linking characteristics of subject topics. "normal" is the only valid value, and is specified as the default in the DTD and Schema. When attribute values cascade, this causes a linking value of "normal" to cascade to the subjects. | (normal) | normal | No |
processing-role | Describes the processing role of the referenced topic. The
processing default is "normal".
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) | #IMPLIED | No |
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. | (yes | no | -dita-use-conref-target) | #IMPLIED | 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 |