<subtitle>

A subtitle is an subordinate title for a resource. It is designed to augment the information about the resource in certain display contexts.

Usage information

The <subtitle> element is a convenience element. It is equivalent to a <titlealt> element with @title-role set to subtitle.

Processing expectations

Processing expectations are dictated by the rules for the <titlealt> element.

Specialization hierarchy

The <subtitle> element is specialized from <titlealt>. It is defined in the alternative-titles domain module.

Content model

(Text | <data> | <foreign> | <keyword> | <term> | <text> | <ph> | <draft-comment> | <required-cleanup>)*

Not contained by any element.

Zero or more of the following

Not contained by any element.

Inheritance

+ topic/titlealt alternativeTitles-d/subtitle

The <subtitle> element is specialized from <titlealt>. It is defined in the alternativeTitles-domain module.

Attributes

The following attributes are available on this element: universal attributes and @title-role.

For this element, @title-role has a default value of subtitle.

The following attributes are available on this element: universal attributes and the attributes defined below.

@title-role (REQUIRED)
Specifies the role that the alternative title serves. Multiple roles are separated by white space. The following roles are defined in the specification: linking, navigation, search, subtitle, and hint.

Processors can define custom values for the @title-role attribute.

For this element, @title-role has a default value of subtitle.

Examples

This section is non-normative.

This section contains examples of how the <subtitle> element can be used.

Example 1. Subtitle used within a map

The following code sample shows how a map can specify a subtitle for the publication:

<map>
  <title>Frankenstein</title>
  <topicmeta>
    <subtitle>The Modern Prometheus</subtitle>
  </topicmeta>
</map>
Example 2. Subtitle used within a topic

The following code sample shows how a topic can specify a subtitle:

<topic id="topic">
  <title>Getting started</title>
  <prolog>
    <subtitle>An introduction to the Acme Inc. processing system</subtitle>
  </prolog>