Replace all @navtitle attributes with elements

Fixes dita-ot#196. Signed-off-by: Roger Sheen <[email protected]>
ContentGraz · Feb 25, 2018 · edf1f69 · edf1f69
1 parent a3352b4
commit edf1f69
Show file tree

Hide file tree

Showing 27 changed files with 125 additions and 106 deletions.
diff --git a/parameters/parameters.ditamap b/parameters/parameters.ditamap
@@ -6,14 +6,18 @@
   <title>Parameter Reference</title>
   <topicref keyref="dita-command-arguments"/>
   <topicref keyref="parameters_intro" keys="dita-ot-params">
-    <topicref keyref="parameters-base" navtitle="Common"/>
+    <topicref keyref="parameters-base"/>
     <topicref keyref="parameters-pdf"/>
     <topicref keyref="parameters-base-html"/>
     <topicref keyref="parameters-html5"/>
     <topicref keyref="parameters-xhtml"/>
-    <topicref keyref="parameters-htmlhelp" locktitle="yes" navtitle="HTML Help" platform="windows"/>
-    <topicref keyref="parameters-eclipsehelp" navtitle="Eclipse Help"/>
-    <topicref keyref="parameters-other" navtitle="Other"/>
+    <topicref keyref="parameters-htmlhelp" locktitle="yes" platform="windows">
+      <topicmeta>
+        <navtitle>HTML Help</navtitle>
+      </topicmeta>
+    </topicref>
+    <topicref keyref="parameters-eclipsehelp"/>
+    <topicref keyref="parameters-other"/>
     <topicref keyref="ant-parameters-details" keys="parameters-push" processing-role="resource-only" toc="no"/>
   </topicref>
   <topicref keyref="configuration-properties">

diff --git a/resources/common-toc.ditamap b/resources/common-toc.ditamap
@@ -7,7 +7,7 @@
 
   <topicref keyref="landing-page"/>
   <topicref keyref="release-notes"/>
-  <topicref keyref="installing-client" locktitle="yes">
+  <topicref keyref="installing-client">
     <mapref href="../topics/installing.ditamap"/>
   </topicref>
   <topicref keyref="alternative-input-formats" collection-type="family">

diff --git a/resources/external-links.ditamap b/resources/external-links.ditamap
@@ -7,8 +7,10 @@
   <!-- Key definitions for external web resources -->
 
   <topicset
-    id="dita-ot-github"
-    navtitle="DITA-OT GitHub Project">
+    id="dita-ot-github">
+    <topicmeta>
+      <navtitle>DITA-OT GitHub Project</navtitle>
+    </topicmeta>
     <keydef
       keys="github-help"
       href="https://help.github.com/articles/set-up-git"
@@ -75,8 +77,10 @@
   </topicset>
 
   <topicset
-    id="dita-ot-rn"
-    navtitle="DITA-OT Release Notes">
+    id="dita-ot-rn">
+    <topicmeta>
+      <navtitle>DITA-OT Release Notes</navtitle>
+    </topicmeta>
     <keydef
       keys="2.0-release-notes"
       href="http://www.dita-ot.org/2.0/readme/changes/rel2.0.html"
@@ -143,8 +147,10 @@
   </topicset>
 
   <topicset
-    id="downloads"
-    navtitle="Download links">
+    id="downloads">
+    <topicmeta>
+      <navtitle>Download links</navtitle>
+    </topicmeta>
     <keydef
       keys="download.ant"
       href="http://ant.apache.org"
@@ -195,8 +201,10 @@
   </topicset>
 
   <topicset
-    id="fop"
-    navtitle="FOP links">
+    id="fop">
+    <topicmeta>
+      <navtitle>FOP links</navtitle>
+    </topicmeta>
     <keydef
       keys="fop-20-rn"
       href="https://xmlgraphics.apache.org/fop/2.0/releaseNotes_2.0.html"
@@ -227,8 +235,10 @@
   </topicset>
 
   <topicset
-    id="specs"
-    navtitle="Specs and RFC links">
+    id="specs">
+    <topicmeta>
+      <navtitle>Specs and RFC links</navtitle>
+    </topicmeta>
     <topicset
       id="dita13spec">
       <keydef
@@ -370,7 +380,8 @@
         </topicmeta>
       </keydef>
     </topicset>
-    <topicset id="lightweight-dita">
+    <topicset
+      id="lightweight-dita">
       <keydef
         keys="lwdita"
         href="http://docs.oasis-open.org/dita/LwDITA/v1.0/cnprd01/LwDITA-v1.0-cnprd01.pdf"
@@ -425,8 +436,10 @@
   </topicset>
 
   <topicset
-    id="licenses"
-    navtitle="Third-party licenses">
+    id="licenses">
+    <topicmeta>
+      <navtitle>Third-party licenses</navtitle>
+    </topicmeta>
     <keydef
       keys="license-apache-2"
       href="https://www.apache.org/licenses/LICENSE-2.0"
@@ -493,8 +506,10 @@
   </topicset>
 
   <topicset
-    id="websites"
-    navtitle="Other Websites">
+    id="websites">
+    <topicmeta>
+      <navtitle>Other Websites</navtitle>
+    </topicmeta>
     <keydef
       keys="ant-manual"
       href="http://ant.apache.org/manual"

diff --git a/resources/reltable.ditamap b/resources/reltable.ditamap
@@ -31,12 +31,12 @@
     </relheader>
     <relrow>
       <relcell>
-        <topicref keyref="ant" navtitle="Ant overview"/>
+        <topicref keyref="ant"/>
       </relcell>
       <relcell>
         <topicgroup collection-type="family">
-          <topicref keyref="building-with-ant" navtitle="Building output using Ant"/>
-          <topicref keyref="creating-an-ant-build-script" navtitle="Creating an Ant build script"/>
+          <topicref keyref="building-with-ant"/>
+          <topicref keyref="creating-an-ant-build-script"/>
         </topicgroup>
       </relcell>
       <relcell>
@@ -206,13 +206,13 @@
     </relheader>
     <relrow>
       <relcell>
-        <topicref keyref="parameters-eclipsehelp" navtitle="Eclipse help transformation"/>
-        <topicref keyref="parameters-htmlhelp" navtitle="HTML Help transformation"/>
-        <topicref keyref="parameters-pdf" navtitle="PDF transformation"/>
-        <topicref keyref="parameters-xhtml" navtitle="XHTML transformation"/>
+        <topicref keyref="parameters-eclipsehelp"/>
+        <topicref keyref="parameters-htmlhelp"/>
+        <topicref keyref="parameters-pdf"/>
+        <topicref keyref="parameters-xhtml"/>
       </relcell>
       <relcell>
-        <topicref keyref="parameters-base" navtitle="All transformation types"/>
+        <topicref keyref="parameters-base"/>
       </relcell>
     </relrow>
     <relrow>
@@ -243,21 +243,21 @@
     </relheader>
     <relrow>
       <relcell>
-        <topicref keyref="parameters-base-html" navtitle="HTML-based transformations"/>
+        <topicref keyref="parameters-base-html"/>
       </relcell>
       <relcell>
-        <topicref keyref="parameters-eclipsehelp" navtitle="Eclipse help transformation"/>
+        <topicref keyref="parameters-eclipsehelp"/>
         <topicref keyref="parameters-html5"/>
         <topicref keyref="parameters-htmlhelp"/>
-        <topicref keyref="parameters-xhtml" navtitle="XHTML transformation"/>
+        <topicref keyref="parameters-xhtml"/>
       </relcell>
     </relrow>
     <relrow>
       <relcell>
-        <topicref keyref="other-errors" navtitle="Out of Memory errors" locktitle="yes"/>
+        <topicref keyref="other-errors"/>
       </relcell>
       <relcell>
-        <topicref keyref="parameters-other" navtitle="Reload style sheets parameters" locktitle="yes"/>
+        <topicref keyref="parameters-other"/>
       </relcell>
     </relrow>
     <relrow>

diff --git a/samples/taskbook.ditamap b/samples/taskbook.ditamap
@@ -72,11 +72,6 @@
   <appendix href="taskbook/task_appendix.dita"/>
   <backmatter>
     <booklists>
-      <!--
-        <topicref href="taskbook/otherbooks.dita" navtitle="Related Books"/>
-        <topicref href="taskbook/trademarks.dita" navtitle="Trademarks"/>
-        <topicref href="taskbook/Glossary.dita navtitle="Glossary"/>
-      -->
       <indexlist/>
     </booklists>
   </backmatter>

diff --git a/topics/customization.ditamap b/topics/customization.ditamap
@@ -11,9 +11,5 @@
   <mapref href="plug-ins.ditamap"/>
   <mapref href="../extension-points/extension-points.ditamap"/>
   <mapref href="migration.ditamap"/>
-  <topicref keyref="rebuilding-the-dita-ot-documentation" keys="rebuild-docs" locktitle="yes">
-    <topicmeta>
-      <navtitle>Rebuilding documentation</navtitle>
-    </topicmeta>
-  </topicref>
+  <topicref keyref="rebuilding-the-dita-ot-documentation" keys="rebuild-docs"/>
 </map>
diff --git a/topics/dita-resources.ditamap b/topics/dita-resources.ditamap
@@ -5,48 +5,44 @@
 <map>
   <title>DITA and DITA-OT resources</title>
 
-  <topicref format="html" href="http://www.dita-ot.org/" navtitle="Project website at dita-ot.org" scope="external">
+  <topicref format="html" href="http://www.dita-ot.org/" scope="external">
     <topicmeta>
       <linktext>DITA-OT project website at dita-ot.org</linktext>
       <shortdesc>The DITA-OT project website at dita-ot.org provides information about the latest toolkit releases,
         including download links, release notes, and documentation for recent DITA-OT versions.</shortdesc>
     </topicmeta>
   </topicref>
-  <topicref format="html" href="http://dita.xml.org/wiki/the-dita-open-toolkit"
-    navtitle="Project archive at dita.xml.org" scope="external">
+  <topicref format="html" href="http://dita.xml.org/wiki/the-dita-open-toolkit" scope="external">
     <topicmeta>
       <linktext>DITA-OT project archive at dita.xml.org</linktext>
       <shortdesc>The DITA-OT project archive at dita.xml.org provides news about earlier toolkit releases, and release
         notes for all past releases.</shortdesc>
     </topicmeta>
   </topicref>
-  <topicref format="html" href="http://groups.yahoo.com/group/dita-users/" navtitle="Yahoo! dita-users group"
-    scope="external">
+  <topicref format="html" href="http://groups.yahoo.com/group/dita-users/" scope="external">
     <topicmeta>
       <linktext>Yahoo! dita-users group</linktext>
       <shortdesc>The original DITA list-serv is a vital resource for the DITA community. People post regularly, both
         asking for and offering help. While the archived messages can be difficult to search, this is a treasure trove
         of information.</shortdesc>
     </topicmeta>
   </topicref>
-  <topicref format="html" href="https://groups.google.com/d/forum/dita-ot-users" scope="external"
-    navtitle="DITA-OT Users Google Group">
+  <topicref format="html" href="https://groups.google.com/d/forum/dita-ot-users" scope="external">
     <topicmeta>
       <linktext>DITA-OT Users Google Group</linktext>
       <shortdesc>General interest DITA-OT product forum, for questions on any aspect of the toolkit - from installation
         and getting started to questions about specific overrides, plug-ins, and customizations.</shortdesc>
     </topicmeta>
   </topicref>
-  <topicref format="html" href="https://dita-ot.slack.com" scope="external" navtitle="DITA-OT Development Slack team">
+  <topicref format="html" href="https://dita-ot.slack.com" scope="external">
     <topicmeta>
       <linktext>DITA-OT Development Slack team</linktext>
       <shortdesc>Forum for discussion related to DITA-OT development and design. Topics in this forum are more technical
         in nature, covering upcoming design or code changes. To request an invitation and join in the discussion, visit
         <xref href="http://slack.dita-ot.org" format="html" scope="external">slack.dita-ot.org</xref>.</shortdesc>
     </topicmeta>
   </topicref>
-  <topicref format="html" href="http://www.oasis-open.org/committees/dita/" navtitle="OASIS DITA Technical Committee"
-    scope="external">
+  <topicref format="html" href="http://www.oasis-open.org/committees/dita/" scope="external">
     <topicmeta>
       <linktext>Home page for the OASIS DITA Technical Committee</linktext>
       <shortdesc>The OASIS DITA Technical Committee develops the DITA standard.</shortdesc>

diff --git a/topics/html-customization.dita b/topics/html-customization.dita
@@ -4,7 +4,9 @@
 
 <task id="customizing-html-output">
   <title>Customizing HTML output</title>
-  <shortdesc>You can adjust the look and feel of your HTML output without
-    creating a DITA-OT plugin by including custom CSS, headers and footers, or
-    table-of-contents navigation in topics.</shortdesc>
+  <titlealts>
+    <navtitle>Customizing HTML</navtitle>
+  </titlealts>
+  <shortdesc>You can adjust the look and feel of your HTML output without creating a DITA-OT plugin by including custom
+    CSS, headers and footers, or table-of-contents navigation in topics.</shortdesc>
 </task>
diff --git a/topics/html-customization.ditamap b/topics/html-customization.ditamap
@@ -4,10 +4,7 @@
 
 <map>
   <title>Customizing HTML output</title>
-  <topicref keyref="html-customization" locktitle="yes" collection-type="family">
-    <topicmeta>
-      <navtitle>Customizing HTML</navtitle>
-    </topicmeta>
+  <topicref keyref="html-customization" collection-type="family">
     <topicref keyref="html-customization-parameters" collection-type="family">
       <topicref keyref="html-customization-navigation"/>
       <topicref keyref="html-customization-css"/>

diff --git a/topics/input-formats.ditamap b/topics/input-formats.ditamap
@@ -6,7 +6,7 @@
   <title>Input formats</title>
 
   <topicref keyref="markdown-input"/>
-  <topicref keyref="lwdita-input" navtitle="Lightweight DITA" locktitle="yes"/>
-  <topicref keyref="markdown-dita-syntax-reference" navtitle="Markdown DITA syntax" locktitle="yes"/>
+  <topicref keyref="lwdita-input"/>
+  <topicref keyref="markdown-dita-syntax-reference"/>
 
 </map>
diff --git a/topics/lwdita-input.dita b/topics/lwdita-input.dita
@@ -4,6 +4,9 @@
 
 <topic id="lwdita-input">
   <title>Preview support for Lightweight DITA</title>
+  <titlealts>
+    <navtitle>Lightweight DITA</navtitle>
+  </titlealts>
   <shortdesc>DITA-OT provides preview support for the MDITA and HDITA authoring formats proposed for
     <xref keyref="lwdita"/>, or “<term>LwDITA</term>”. These proposed formats are alternative representations of DITA
     content in Markdown or HTML.</shortdesc>

diff --git a/topics/markdown-dita-syntax-reference.dita b/topics/markdown-dita-syntax-reference.dita
@@ -4,6 +4,9 @@
 
 <topic id="markdown-dita-syntax-reference">
   <title>Markdown DITA syntax reference</title>
+  <titlealts>
+    <navtitle>Markdown DITA syntax</navtitle>
+  </titlealts>
   <shortdesc>Markdown DITA uses
     <xref keyref="commonmark"/> as the underlying markup language.</shortdesc>
 

diff --git a/topics/migrating-ant-to-dita.dita b/topics/migrating-ant-to-dita.dita
@@ -4,6 +4,9 @@
 
 <task id="migrating-ant-to-dita">
   <title>Migrating Ant builds to use the <cmdname>dita</cmdname> command</title>
+  <titlealts>
+    <navtitle>Migrating Ant builds</navtitle>
+  </titlealts>
   <shortdesc>Although Ant builds are still supported in the DITA Open Toolkit, you might want to switch to use the new
       <cmdname>dita</cmdname> command.</shortdesc>
   <taskbody>
@@ -31,7 +34,8 @@
           option.</cmd>
       </step>
     </steps>
-    <example><title>Example: Ant build</title>
+    <example>
+      <title>Example: Ant build</title>
       <p>Sample build file: <filepath id="samples-dir"
           ><varname>dita-ot-dir</varname>/docsrc/samples</filepath><filepath>/ant_sample/build-chm-pdf.xml</filepath>
         <codeblock><coderef href="../samples/ant_sample/build-chm-pdf.xml"/></codeblock></p></example>

diff --git a/topics/migration.ditamap b/topics/migration.ditamap
@@ -4,7 +4,7 @@
 
 <map>
   <title>Migrating customizations</title>
-  <topicref keyref="migration" locktitle="yes">
+  <topicref keyref="migration">
     <topicref keyref="migrating-to-3.0">
       <topicmeta>
         <navtitle>To 3.0</navtitle>

diff --git a/topics/output-formats.dita b/topics/output-formats.dita
@@ -4,6 +4,9 @@
 
 <concept id="availabletransforms" xml:lang="en-US">
   <title>DITA-OT transformations (output formats)</title>
+  <titlealts>
+    <navtitle>Output formats</navtitle>
+  </titlealts>
   <shortdesc>The DITA Open Toolkit ships with several core transformations that generate different output formats from
     DITA content. Each transformation represents an implementation of the processing that is defined by OASIS in the
     DITA specification.</shortdesc>

diff --git a/topics/pdf-customization-example.dita b/topics/pdf-customization-example.dita
@@ -4,6 +4,9 @@
 
 <task id="dita2pdf-customization" xml:lang="en">
   <title>Example: Creating a simple PDF plug-in</title>
+  <titlealts>
+    <navtitle>Simple PDF plug-in example</navtitle>
+  </titlealts>
   <shortdesc>This scenario walks through the process of creating a very simple plug-in
       (<codeph>com.example.print-pdf</codeph>) that creates a new transformation type: <option>print-pdf</option>. </shortdesc>
   <taskbody>
@@ -138,7 +141,8 @@
   plugin.xml</codeblock>
     </result>
     <postreq>
-      <p>Run <filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--install</parmname> to install the plug-in and make the <option>print-pdf</option> transformation
+      <p>Run <filepath conref="../resources/conref-task.dita#ID/dita-cmd"/>
+        <parmname>--install</parmname> to install the plug-in and make the <option>print-pdf</option> transformation
         available.</p>
     </postreq>
   </taskbody>

diff --git a/topics/pdf-customization-resources.dita b/topics/pdf-customization-resources.dita
@@ -4,6 +4,9 @@
 
 <reference id="ID">
   <title>Resources for custom PDF plug-ins</title>
+  <titlealts>
+    <navtitle>Custom PDF plug-in resources</navtitle>
+  </titlealts>
   <shortdesc>There are several external resources that can help you generate and refine custom PDF plug-ins for the DITA
     Open Toolkit.</shortdesc>