<nav class="toc" role="toc"><ul><li><a href="../../introduction/dita-release-overview.html">Introduction</a></li><li><a href="../../archSpec/base/dita-terminology.html">DITA terminology, notation, and conventions</a></li><li><a href="../../archSpec/base/introduction-to-dita.html">Overview of DITA</a></li><li><a href="../../archSpec/base/accessibility-and-translation.html">Accessibility and translation</a></li><li><a href="../../archSpec/base/dita-map-processing.html">DITA map processing</a></li><li><a href="../../archSpec/base/ditaaddressing.html">DITA addressing</a></li><li><a href="../../archSpec/base/behaviors.html">DITA processing</a></li><li><a href="../../archSpec/base/configuration-specialization-and-constraints.html">Configuration and specialization </a></li><li><a href="../../langRef/langRef-base.html">Element reference</a></li><li><a href="../../conformance/conformance.html">Conformance</a></li><li><a href="../../acknowledgments/acknowledgments.html">Acknowledgments</a></li><li><a href="../../non-normative/aggregated-RFC-2119-statements.html">Aggregated RFC-2119 statements</a></li><li><a href="../../archSpec/base/coding-requirements.html">Coding practices for DITA grammar files</a></li><li><a href="../../non-normative/developing-constraint-and-expansion-modules.html">Constraint modules</a></li><li><a href="../../non-normative/expansion-modules.html">Expansion modules</a></li><li><a href="../../non-normative/elementsMerged.html">Element-by-element recommendations for translators</a></li><li><a href="../../non-normative/formatting-expectations.html">Formatting expectations</a></li><li><a href="../../non-normative/migrating-to-dita-2.0.html">Migrating to DITA 2.0</a></li><li><a href="../../non-normative/basedoctypes.html">OASIS grammar files</a></li><li><a href="../../non-normative/interoperability-considerations.html">Processing interoperability considerations</a></li><li><a href="../../non-normative/revision-history.html">Revision history</a></li></ul></nav><main role="main" class=""><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1"><code class="keyword markupname xmlelement"><subtitle></code></h1>
<div class="body refbody"><p class="shortdesc">A subtitle is an subordinate title for a resource. It is
designed to augment the information about the resource in certain
display contexts.</p>
<section class="section" id="subtitle__usage-information"><h2 class="title sectiontitle">Usage information</h2>
<p class="p">The <code class="keyword markupname xmlelement"><subtitle></code> element is a convenience
element. It is equivalent to a <code class="keyword markupname xmlelement"><titlealt></code>
element with <code class="keyword markupname xmlatt">@title-role</code> set to
<span class="keyword">subtitle</span>. </p>
</section>
<section class="section" id="subtitle__processing-expectations"><h2 class="title sectiontitle">Processing expectations</h2>
<p class="p">Processing expectations are dictated by the rules for the
<code class="keyword markupname xmlelement"><titlealt></code> element.</p>
</section>
<section class="section" id="subtitle__specialization-hierarchy"><h2 class="title sectiontitle">Specialization hierarchy</h2>
<p class="p">The <code class="keyword markupname xmlelement"><subtitle></code> element is specialized from
<code class="keyword markupname xmlelement"><titlealt></code>. It is defined in the
alternative-titles domain module.</p>
</section>
<section class="section generated" id="subtitle__content-model"><h2 class="title sectiontitle">Content model</h2>
<p class="p content-model generated">(Text | <a class="xref" href="../content-models/../base/data.html" title="Data is a generic component that represents metadata within a topic or map. Complex metadata is represented by nested data structures.">
<code class="keyword markupname xmlelement"><data></code>
</a> | <a class="xref" href="../content-models/../base/sort-as.html" title="The sort-as element can be used to specify an effective sort phrase when the base sort phrase is not appropriate for sorting, for example, Japanese characters. This element prepends text to the base sort phrase in order to construct an effective sort phrase.">
<code class="keyword markupname xmlelement"><sort-as></code>
</a> | <a class="xref" href="../content-models/../base/foreign.html" title="Foreign content is non-DITA content, such as MathML, SVG, or Rich Text Format (RTF).">
<code class="keyword markupname xmlelement"><foreign></code>
</a> | <a class="xref" href="../content-models/../base/keyword.html" title="A keyword is text or a token that has a unique value, such as a product name or unit of reusable text.">
<code class="keyword markupname xmlelement"><keyword></code>
</a> | <a class="xref" href="../content-models/../base/term.html" title="A term is a word or phrase that has specific meanings in certain contexts. It might have or require extended definitions or explanations.">
<code class="keyword markupname xmlelement"><term></code>
</a> | <a class="xref" href="../content-models/../base/text.html" title="The text element is a container for text. It does not have any associated semantics.">
<code class="keyword markupname xmlelement"><text></code>
</a> | <a class="xref" href="../content-models/../base/ph.html" title="A phrase is a small group of words that stand together as a unit, typically forming a component of a clause.">
<code class="keyword markupname xmlelement"><ph></code>
</a> | <a class="xref" href="../content-models/../base/strong.html" title="Strong text is text that is of greater importance than the surrounding text.">
<code class="keyword markupname xmlelement"><strong></code>
</a> | <a class="xref" href="../content-models/../base/em.html" title="Emphasis indicates special meaning or particular importance.">
<code class="keyword markupname xmlelement"><em></code>
</a> | <a class="xref" href="../content-models/../base/b.html" title="Bold text is text that is used to draw a reader's attention to a phrase without otherwise adding meaning to the content.">
<code class="keyword markupname xmlelement"><b></code>
</a> | <a class="xref" href="../content-models/../base/i.html" title="Italic text is text that is used to emphasize the key points in printed text, or when quoting a speaker, to show which words the speaker stressed.">
<code class="keyword markupname xmlelement"><i></code>
</a> | <a class="xref" href="../content-models/../base/line-through.html" title="A strikethrough is a typographical presentation of words with a horizontal line through their center. It can indicate that words are a mistake and not intended for inclusion, or it can be used deliberately to imply a change of thought.">
<code class="keyword markupname xmlelement"><line-through></code>
</a> | <a class="xref" href="../content-models/../base/overline.html" title="An overline is a horizontal line that is printed above a line of text, a mathematical symbol, or an illustration in a newspaper or journal.">
<code class="keyword markupname xmlelement"><overline></code>
</a> | <a class="xref" href="../content-models/../base/sup.html" title="A superscript is text that is printed above the line. It is frequently used in chemical and mathematical formulas.">
<code class="keyword markupname xmlelement"><sup></code>
</a> | <a class="xref" href="../content-models/../base/sub.html" title="A subscript is text that is printed below the line. It is frequently used in chemical and mathematical formulas.">
<code class="keyword markupname xmlelement"><sub></code>
</a> | <a class="xref" href="../content-models/../base/tt.html" title="Teletype text is text that is displayed on a fixed-width display such as a teletype, text-only screen, or line printer.">
<code class="keyword markupname xmlelement"><tt></code>
</a> | <a class="xref" href="../content-models/../base/u.html" title="An underline, also called an underscore, is a line immediately below a portion of text.">
<code class="keyword markupname xmlelement"><u></code>
</a> | <a class="xref" href="../content-models/../base/draft-comment.html" title="A draft comment is content that is intended for review and discussion, such as questions, comments, and notes to reviewers. This content is not intended to be included in production output.">
<code class="keyword markupname xmlelement"><draft-comment></code>
</a> | <a class="xref" href="../content-models/../base/required-cleanup.html" title="Required cleanup sections are placeholders for migrated elements that cannot be appropriately tagged without manual intervention, or for content that must be cleaned up before publishing.">
<code class="keyword markupname xmlelement"><required-cleanup></code>
</a>)*</p>
<p class="p content-model generated">Contained by</p>
<p class="p content-model generated">
<a class="xref" href="../content-models/../base/prolog.html" title="The prolog contains metadata about the topic, for example, author information or subject category.">
<code class="keyword markupname xmlelement"><prolog></code>
</a>
</p>
<div class="p content-model-prose generated">Zero or more of the following<ul class="ul">
<li class="li">Text</li>
<li class="li">
<a class="xref" href="../content-models/../base/b.html" title="Bold text is text that is used to draw a reader's attention to a phrase without otherwise adding meaning to the content.">
<code class="keyword markupname xmlelement"><b></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/data.html" title="Data is a generic component that represents metadata within a topic or map. Complex metadata is represented by nested data structures.">
<code class="keyword markupname xmlelement"><data></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/draft-comment.html" title="A draft comment is content that is intended for review and discussion, such as questions, comments, and notes to reviewers. This content is not intended to be included in production output.">
<code class="keyword markupname xmlelement"><draft-comment></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/em.html" title="Emphasis indicates special meaning or particular importance.">
<code class="keyword markupname xmlelement"><em></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/foreign.html" title="Foreign content is non-DITA content, such as MathML, SVG, or Rich Text Format (RTF).">
<code class="keyword markupname xmlelement"><foreign></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/i.html" title="Italic text is text that is used to emphasize the key points in printed text, or when quoting a speaker, to show which words the speaker stressed.">
<code class="keyword markupname xmlelement"><i></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/keyword.html" title="A keyword is text or a token that has a unique value, such as a product name or unit of reusable text.">
<code class="keyword markupname xmlelement"><keyword></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/line-through.html" title="A strikethrough is a typographical presentation of words with a horizontal line through their center. It can indicate that words are a mistake and not intended for inclusion, or it can be used deliberately to imply a change of thought.">
<code class="keyword markupname xmlelement"><line-through></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/overline.html" title="An overline is a horizontal line that is printed above a line of text, a mathematical symbol, or an illustration in a newspaper or journal.">
<code class="keyword markupname xmlelement"><overline></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/ph.html" title="A phrase is a small group of words that stand together as a unit, typically forming a component of a clause.">
<code class="keyword markupname xmlelement"><ph></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/required-cleanup.html" title="Required cleanup sections are placeholders for migrated elements that cannot be appropriately tagged without manual intervention, or for content that must be cleaned up before publishing.">
<code class="keyword markupname xmlelement"><required-cleanup></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/sort-as.html" title="The sort-as element can be used to specify an effective sort phrase when the base sort phrase is not appropriate for sorting, for example, Japanese characters. This element prepends text to the base sort phrase in order to construct an effective sort phrase.">
<code class="keyword markupname xmlelement"><sort-as></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/strong.html" title="Strong text is text that is of greater importance than the surrounding text.">
<code class="keyword markupname xmlelement"><strong></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/sub.html" title="A subscript is text that is printed below the line. It is frequently used in chemical and mathematical formulas.">
<code class="keyword markupname xmlelement"><sub></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/sup.html" title="A superscript is text that is printed above the line. It is frequently used in chemical and mathematical formulas.">
<code class="keyword markupname xmlelement"><sup></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/term.html" title="A term is a word or phrase that has specific meanings in certain contexts. It might have or require extended definitions or explanations.">
<code class="keyword markupname xmlelement"><term></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/text.html" title="The text element is a container for text. It does not have any associated semantics.">
<code class="keyword markupname xmlelement"><text></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/tt.html" title="Teletype text is text that is displayed on a fixed-width display such as a teletype, text-only screen, or line printer.">
<code class="keyword markupname xmlelement"><tt></code>
</a>
</li>
<li class="li">
<a class="xref" href="../content-models/../base/u.html" title="An underline, also called an underscore, is a line immediately below a portion of text.">
<code class="keyword markupname xmlelement"><u></code>
</a>
</li>
</ul>
</div>
<p class="p content-model-prose generated">Contained by</p>
<ul class="ul content-model-prose contained-by-list generated">
<li class="li">
<a class="xref" href="../content-models/../base/prolog.html" title="The prolog contains metadata about the topic, for example, author information or subject category.">
<code class="keyword markupname xmlelement"><prolog></code>
</a>
</li>
</ul>
</section>
<section class="section generated" id="subtitle__inheritance"><h2 class="title sectiontitle">Inheritance</h2>
<p class="p inheritance">+ topic/titlealt alternativeTitles-d/subtitle </p>
<p class="p inheritance-prose">The <code class="keyword markupname xmlelement"><subtitle></code> element is specialized from <a class="xref" href="../content-models/../base/titlealt.html" title="An alternative title is used to convey information about a document in contexts other than straightforward display.">
<code class="keyword markupname xmlelement"><titlealt></code>
</a>. It is defined in the alternativeTitles-domain module.</p>
</section> <section class="section" id="subtitle__attributes"><h2 class="title sectiontitle">Attributes</h2>
<p class="p attributes-prose">The following attributes are available on this element: <span class="ph"><a class="xref" href="../../common/../langRef/attributes/universalAttributes.html" title="Universal attributes include: audience, base, class, conaction, conkeyref, conref, conrefend, deliveryTarget, dir, id, importance, otherprops, outputclass, platform, product, props, rev, status, translate, and xml:lang">universal
attributes</a></span> and <a class="xref" href="../attributes/commonAttributes.html#common-atts__attr-title-role"><code class="keyword markupname xmlatt">@title-role</code></a>.</p>
<p class="p attributes-prose attr-exception" id="subtitle__attr-exception">For this element, <code class="keyword markupname xmlatt">@title-role</code> has a default value of
<span class="keyword">subtitle</span>.</p>
<p class="p inlined-attributes">The following attributes are available on this element: <a class="xref" href="../../common/../langRef/attributes/universalAttributes.html" title="Universal attributes include: audience, base, class, conaction, conkeyref, conref, conrefend, deliveryTarget, dir, id, importance, otherprops, outputclass, platform, product, props, rev, status, translate, and xml:lang">universal
attributes</a> and the attributes defined below.</p><dl class="dl inlined-attributes"><dt class="dt dlterm" id="subtitle__attr-title-role"><code class="keyword markupname xmlatt">@title-role</code>
<span class="ph">(REQUIRED)</span></dt><dd class="dd">Specifies the role that the alternative title serves.
Multiple roles are separated by white space. The following
roles are defined in the specification:
<span class="keyword">linking</span>, <span class="keyword">navigation</span>,
<span class="keyword">search</span>, <span class="keyword">subtitle</span>, and
<span class="keyword">hint</span>.<p class="p">Processors can define custom
values for the <code class="keyword markupname xmlatt">@title-role</code>
attribute.</p></dd><dd class="dd ddexpand">For this element, <code class="keyword markupname xmlatt">@title-role</code> has a default value of
<span class="keyword">subtitle</span>.</dd></dl></section>
<div class="example non-normative" id="subtitle__example"><h2 class="title sectiontitle">Examples</h2><p class="non-normative-label">This section is non-normative.</p>
<p class="p">This section contains examples of how the <code class="keyword markupname xmlelement"><subtitle></code> element can be
used.</p>
<figure class="fig fignone" id="subtitle__figure-3"><figcaption><span class="fig--title-label">Example 1. </span>Subtitle used within a map</figcaption>
<p class="p">The following code sample shows how a map can specify a subtitle
for the publication:</p>
<pre style="color:red;" class="pre codeblock"><code><map>
<title>Frankenstein</title>
<topicmeta>
<subtitle>The Modern Prometheus</subtitle>
</topicmeta>
</map></code></pre>
</figure>
<figure class="fig fignone" id="subtitle__fig_ofj_dkh_rnb"><figcaption><span class="fig--title-label">Example 2. </span>Subtitle used within a topic</figcaption>
<p class="p">The following code sample shows how a topic can specify a
subtitle:</p>
<pre class="pre codeblock"><code><topic id="topic">
<title>Getting started</title>
<prolog>
<subtitle>An introduction to the Acme Inc. processing system</subtitle>
</prolog>
</code></pre>
</figure>
</div>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../../langRef/containers/alternativeTitles-d.html" title="The alternative title elements are designed to provide alternative titles for resources. The elements in the alternative-titles domain are specialized from the titlealt element.">Alternative-titles domain elements</a></div></div></nav><aside class="section-toc" role="aside"><h2>In this section</h2><ul><li><a href="#subtitle__usage-information">Usage information</a></li><li><a href="#subtitle__processing-expectations">Processing expectations</a></li><li><a href="#subtitle__specialization-hierarchy">Specialization hierarchy</a></li><li><a href="#subtitle__content-model">Content model</a></li><li><a href="#subtitle__inheritance">Inheritance</a></li><li><a href="#subtitle__attributes">Attributes</a></li><li><a href="#subtitle__example">Examples</a></li></ul></aside></article></main>