The navigation title (<navtitle>)
element is one of a set of alternate titles that can be included inside
the <titlealts> element. This navigation
title may differ from the first level heading that shows in the main
browser window. Use <navtitle> when the actual
title of the topic isn't appropriate for use in a table of contents,
navigation pane, or online content (for example, because the actual
title is too long). Beginning with DITA 1.2, the navtitle
element is also available in the <topicmeta>
element in a <topicref> in a map, and its use
is preferred over the topicref's navtitle attribute.
When navtitle is used in a map, it functions
in the same way as the navtitle attribute; both are used to specify
a navigation title for the target of the <topicref>
element. That is, the title itself will only be used as an actual
navigation title when the title is locked; the title is locked when
the closest ancestor topicref element sets or inherits the attribute
locktitle="yes". If the title is not locked, processing systems will
typically retrieve the current title from the target topic, looking
first for a navtitle element and second for the general title.
When
both a navtitle element and a navtitle attribute are specified, the
navtitle element should be used.
Because the navtitle element
is available within topicmeta, and topicmeta is used in many different
contexts, it is possible that navtitle can be specified in contexts
where a navigation title does not make sense (for example, on the
topicgroup element). In those situations, the navtitle element has
no defined purpose.
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 |
|---|
| topic (base), map (base), classifyMap, subjectScheme, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary |
( text data or data or data-about or foreign or unknown or keyword or term or ph or b or i or sup or sub or tt or u) (any number) |
| topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap |
( text data or data or data-about or foreign or unknown or keyword or apiname or option or parmname or cmdname or msgnum or varname or wintitle or term or abbreviated-form or ph or b or i or sup or sub or tt or u or codeph or synph or filepath or msgph or systemoutput or userinput or menucascade or uicontrol) (any number) |
| machineryTask |
( text data or data or data-about or foreign or unknown or keyword or wintitle or term or ph or b or i or sup or sub or tt or u or menucascade or uicontrol) (any number) |
Contained by
| Doctype |
Content model |
|---|
| topic (base), topic (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), machineryTask, learningAssessment, learningContent, learningOverview, learningPlan, learningSummary |
titlealts |
| map (base), map (technical content), bookmap, classifyMap, learningBookmap, learningMap |
topicmeta |
| subjectScheme |
topicmeta, subjectHeadMeta |
Inheritance
-
topic/navtitle
Example
Figure 1. Navtitle sample
in a topic
<task id=progexample">
<title>Publishing a DITA information set in PDF</title>
<titlealts><navtitle>Publishing in PDF</navtitle></titlealts>
<taskbody> . . . </taskbody>
</task>
Figure 2. Navtitle samples in a map
In this sample, the first title is not locked, and will generally
be replaced with a title retrieved from a.dita. The second title is
locked, and will be displayed when this map is used as a basis for
navigation.
<map xml:lang="en">
<title>This is a sample map</title>
<topicref href="a.dita">
<topicmeta>
<navtitle>Title of A</navtitle>
</topicmeta>
</topicref>
<topicref href="b.dita" locktitle="yes">
<topicmeta>
<navtitle>Short Title for B</navtitle>
</topicmeta>
</topicref>
</map>