<navtitle>
A navigation title is an alternative title for a resource. It is designed for situations where the topic title is unsuitable for use in a table of contents or navigation pane.
Usage information
The <navtitle>
element is a convenience
element. It is equivalent to a <titlealt>
element with @title-role
set to
navigation.
Processing expectations
Processing expectations are dictated by the rules for the
<titlealt>
element.
In some cases, when processing a <topicref>
element that has no @href
attribute, the navigation
title can also be used as the title of the generated topic, if applicable.
Specialization hierarchy
The <navtitle>
element is specialized from
<titlealt>
. It is defined in the
alternative-titles domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<term>
|
<text>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<draft-comment>
|
<required-cleanup>
)*
Attributes
The following attributes are available on this element: universal
attributes and @title-role
.
For this element, @title-role
has a default value of
navigation.
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 navigation.
Examples
This section is non-normative.
This section contains examples of how the <navtitle>
element can be
used.
<navtitle>
in a topicThe following code sample shows a <navtitle>
element used in a
topic. The <navtitle>
element contains a shorter title that
processors render in a TOC or navigation pane when the topic is published.
<task id="publishing-dita">
<title>Publishing a DITA information set in PDF</title>
<shortdesc>You can quickly publish your DITA information to PDF.</shortdesc>
<prolog>
<navtitle>Publishing in PDF</navtitle>
</prolog>
<!-- ... -->
</task>
<navtitle>
in a mapThe following code sample shows a
<navtitle>
element used in a DITA map.
The navigation title in the map takes precedence over a
navigation title that is specified in the topic.
<map xml:lang="en">
<title>Publishing a DITA information set</title>
<topicref href="2378d670f2op78.dita">
<topicmeta>
<navtitle>Publishing to PDF</navtitle>
</topicmeta>
</topicref>
</map>