Case 1 – DITA Map as Source of navtitle - Fluid Topics - 3.10 - Technical Notes

Empower Metadata with Fluid Topics

Product
Fluid Topics
Fluid Topics Version
3.10
Category
Technical Notes
Language
English
Target Audience
public

Fluid Topics uses the <navtitle> element defined for a topicref in a DITA map to generate an entry in the Table of Contents (ToC) if both of the following conditions are met:

  1. The <navtitle> element is defined in the DITA map.
  2. The @locktitle attribute is set to "yes".
  3. The title defined for the topic in the DITA map overrides the one defined in the topic itself.
  4. The <navtitle> element is not defined in the topic referenced by the <topicref> element.

If the @locktitle attribute is set to "yes", the content of the <navtitle> element or @navtitle attribute is used for a navigation title, if it is present. If the @locktitle attribute is not present or set to "no", the content of the <navtitle> element or @navtitle attribute is ignored, and the title of the referenced topic is used as a navigation title.

For more information about the @locktitle attribute, see the Oasis DITA documentation.

The following lines show a <navtitle> element declared at the topicref level of a DITA map and the associated topic displayed after it.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN"
"http://docs.oasis-open.org/dita/v1.1/OS/dtd/map.dtd">
<map title="time_machine_configuration_guide">
<title>Time Machine Configuration Guide</title>
<topicref href="time_travel_history.dita"/>
<topicref href="time_travel_principles.dita"/>
<topicref href="time_travel_settings.dita" locktitle="yes">
<topicmeta>
<navtitle>How to Time Travel</navtitle>
</topicmeta>
</topicref>
</map>

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN"
"http://docs.oasis-open.org/dita/v1.1/OS/dtd/topic.dtd">
<topic id="time_travel_settings">
<title>Time Travel Settings</title>
<body>
<p></p>
</body>
</topic>

The entry in the ToC appears as "How to Time Travel," and the topic is renamed to match.