<subjectHead>

The <subjectHead> element provides a heading for a group of subjects, for use if the subject scheme is rendered and displayed.

Usage information

The heading provided by the <subjectHead> element might be displayed when a subject scheme is rendered to let users select subjects as part of a faceted browsing experience.

The <subjectHead> element does not reference a resource. It also cannot specify either the @keys or @keyref attribute, so it does not define any controlled values.

Specialization hierarchy

The <subjectHead> element is specialized from <topicref>. It is defined in the subject scheme module.

Attributes

The following attributes are available on this element: universal attributes, @collection-type, @linking, @processing-role, and @toc,.

For this element, the following considerations apply:
  • The @collection-type attribute has an expected processing default value of unordered, although this value is not defaulted in the grammar files. This element limits the available values for @collection-type to unordered, sequence, and -dita-use-conref-target.
  • The @linking attribute has a default value of normal, and no other values are valid.

Example

In the following code sample, the <subjectHead> elements define two groupings of subjects and associate labels.

<subjectScheme toc="yes" search="no">
  <subjectdef keys="hobbies">
    <subjectdef keys="fiber-arts">
      <subjectHead>
        <subjectHeadMeta>
          <navtitle>Fiber arts</navtitle>
        </subjectHeadMeta>
        <subjectdef keys="knitting" href="knitting.dita"/>
        <subjectdef keys="quilting" href="quilting.dita"/>
        <subjectdef keys="sewing" href="sewing.dita/>
      </subjectHead>
    </subjectdef>
    <subjectdef keys="woodworking">
      <subjectHead>
        <subjectHeadMeta>
          <navtitle>Woodworking</navtitle>
        </subjectHeadMeta>
        <subjectdef keys="scroll-sawing" href="scroll-sawing.dita"/>
        <subjectdef keys="whittling" href="whittling.dita"/>
        <subjectdef keys="wood-turning" href="woodturning.dita"/>
      </subjectHead>
    </subjectdef>
  </subjectdef>
</subjectScheme>