Merge branch 'hotfix/2.5.1'

* hotfix/2.5.1: Push details to 'root-chunk-override' description Minor copyediting, format & indent per conventions Enable description for 2014 / 2719 Remove warning from cli.color description Clarify cli.color description for #145 Enable cli.color property description (Fixes #145) Fix filepath tagging error Draft text for 2014 / 2719, tweak text for 2701 Draft notes for #2701, #2712 Fix logback version key Add draft notes for #2706, 2728 Add items missing from original 2.5 notes Draft notes for 2670, missing from 2.5 Draft notes for #2716 Add draft notes for 2714 Update description for 2705 Prepare 2.5.1 Release Notes stub Bump 'maintenance-version' key to “2.5.1” Update Gradle wrapper to 3.5 Use latest DITA-OT version (2.5) for CI builds
dita-ot · Jun 21, 2017 · 70abe13 · 70abe13
2 parents 0d151dd + 407c803
commit 70abe13
Show file tree

Hide file tree

Showing 10 changed files with 119 additions and 24 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -4,7 +4,7 @@ jdk:
 - oraclejdk8
 env:
   global:
-  - DITA_OT_VERSION=2.4.6
+  - DITA_OT_VERSION=2.5
 install:
 - ".travis/install.sh"
 script:

diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
-#Fri Oct 07 19:27:40 CEST 2016
+#Wed May 17 18:25:09 CEST 2017
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-bin.zip
diff --git a/gradlew b/gradlew
@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env sh
 
 ##############################################################################
 ##
@@ -154,16 +154,19 @@ if $cygwin ; then
     esac
 fi
 
-# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
-function splitJvmOpts() {
-    JVM_OPTS=("$@")
+# Escape application args
+save ( ) {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
 }
-eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
-JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
 
 # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
-if [[ "$(uname)" == "Darwin" ]] && [[ "$HOME" == "$PWD" ]]; then
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
   cd "$(dirname "$0")"
 fi
 
-exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
+exec "$JAVACMD" "$@"
diff --git a/license/third-party-software.dita b/license/third-party-software.dita
@@ -56,7 +56,7 @@
             </row>
             <row>
               <entry>Logback Classic Module</entry>
-              <entry><keyword keyref="tool.icu4j.version"/></entry>
+              <entry><keyword keyref="tool.logback.version"/></entry>
               <entry>
                 <xref keyref="license-EPL"/>,
                 <xref keyref="license-LGPL"/>

diff --git a/parameters/ant-parameters-details.dita b/parameters/ant-parameters-details.dita
@@ -210,6 +210,15 @@
             <pd conaction="pushafter">By default, the output is written to
                 <filepath><varname>DITA-dir</varname>/out</filepath>.</pd>
           </plentry>
+          <plentry id="root-chunk-override">
+            <pt>
+              <parmname>root-chunk-override</parmname>
+            </pt>
+            <pd conaction="mark" conref="parameters-base.dita#base/root-chunk-override.desc"/>
+            <pd conaction="pushafter">Acceptable values include any value normally allowed on the <xmlatt>chunk</xmlatt>
+              attribute. If the map does not have a <xmlatt>chunk</xmlatt> attribute, this value will be used; if the
+              map already has a <xmlatt>chunk</xmlatt> attribute specified, this value will be used instead.</pd>
+          </plentry>
           <plentry id="transtype">
             <pt>
               <parmname>transtype</parmname>

diff --git a/parameters/lib-configuration-properties.dita b/parameters/lib-configuration-properties.dita
@@ -61,17 +61,17 @@
             <note conref="#configuration/protected-config-props"/>
           </pd>
         </plentry>
-        <!-- DITA-OT 2.5: https://github.com/dita-ot/dita-ot/pull/2552-->
-        <!--
-        <plentry id="cli-color">
+        <plentry id="cli-color" rev="2.5">
           <pt><parmname>cli.color</parmname></pt>
           <pd>
-            <p>Specifies whether the <cmdname>dita</cmdname> command prints colored output on the command line
-              console.</p>
-            <note conref="#configuration/protected-config-props"/>
+            <p>Specifies whether the <cmdname>dita</cmdname> command prints colored output on the command line console.
+              When set to <option>true</option>, error messages in <cmdname>dita</cmdname> command output will appear in
+              red on terminals that support <xref href="https://en.wikipedia.org/wiki/ANSI_escape_code" format="html"
+                scope="external">ANSI escape codes</xref>, such as on Linux or macOS. Set to <option>false</option> to
+              disable the color. (Colored output is not supported on Windows consoles such as <cmdname>cmd.exe</cmdname>
+              or PowerShell).</p>
           </pd>
         </plentry>
-        -->
         <plentry id="plugindirs">
           <pt><parmname>plugindirs</parmname></pt>
           <pd id="plugindirs.desc">A semicolon-separated list of directory paths that the DITA-OT searches for plug-ins

diff --git a/release-notes/index.dita b/release-notes/index.dita
@@ -6,11 +6,84 @@
   <title>DITA Open Toolkit <keyword keyref="maintenance-version"/> Release Notes</title>
 
   <abstract>
-    <shortdesc>DITA Open Toolkit <keyword keyref="release"/> is a feature release that provides new features and
-      enhancements, including <ph conref="#highlights/summary"/>.</shortdesc>
+    <shortdesc>DITA Open Toolkit <keyword keyref="maintenance-version"/> is a maintenance release that fixes issues
+      reported in DITA-OT <keyword keyref="release"/>, which includes <ph conref="#highlights/summary"/>.</shortdesc>
     <note type="tip"><ph conref="../resources/conref-task.dita#ID/download-ot"/></note>
   </abstract>
 
+  <reference id="v251">
+    <title>Maintenance Release <keyword keyref="maintenance-version"/></title>
+    <refbody>
+      <section>
+        <p>DITA Open Toolkit Release <keyword keyref="maintenance-version"/> includes the following bug fixes.</p>
+        <ul>
+          <li id="2014">
+            <p>In DITA-OT 2.5 and earlier, key resolution did not comply with the DITA specification's requirement to
+              use <xmlelement>linktext</xmlelement> from a key definition as valid replacement text for all uses of that
+              key.
+              <xref href="https://github.com/dita-ot/dita-ot/issues/1590" format="html" scope="external">#1590</xref>,
+              <xref href="https://github.com/dita-ot/dita-ot/issues/2014" format="html" scope="external">#2014</xref>,
+              <xref href="https://github.com/dita-ot/dita-ot/pull/2719" format="html" scope="external">#2719</xref></p>
+            <p>In addition, several less common cases are fixed:
+              <ul>
+                <li>Previously, a <xmlelement>keyword</xmlelement> anywhere within the key definition was used as the
+                  first choice for link text, even if that keyword was located within <xmlelement>linktext</xmlelement>.
+                  As defined by the DITA specification, the replacement keyword is taken only from within
+                    <xmlelement>keywords</xmlelement>.</li>
+                <li>Previously, the <xmlatt>navtitle</xmlatt> attribute was used as fallback text in some cases, while
+                    <xmlelement>navtitle</xmlelement> was ignored. The <xmlelement>navtitle</xmlelement> element is now
+                  used before checking the deprecated <xmlatt>navtitle</xmlatt> value for all cases.</li>
+                <li>Previously, <xmlatt>navtitle</xmlatt> was used as link text even for local DITA topics where that
+                  value was ignored in favor of a navigation title in the topic. Now <xmlatt>navtitle</xmlatt> and
+                    <xmlelement>navtitle</xmlelement> are only used when locked or when the topic is not local
+                  DITA.</li>
+              </ul>
+            </p>
+          </li>
+          <li id="2701">In some cases, invalid DITA content resulted in build crashes from PDF, XHTML, or HTML5
+            processing modules that expect required elements to be present. For example, this could happen when an
+            element such as <xmlelement>ol</xmlelement> (which requires at least one list item) used DITAVAL filtering
+            to exclude all items from the list. The code has been updated to more gracefully handle elements that are
+            missing required children.
+            <xref href="https://github.com/dita-ot/dita-ot/issues/2701" format="html" scope="external">#2701</xref>,
+            <xref href="https://github.com/dita-ot/dita-ot/pull/2712" format="html" scope="external">#2721</xref>
+          </li>
+          <li id="2705">One DITA 1.3 RNG module from the OASIS DITA Standard contained a typo in a default attribute
+            value. The typo will be corrected in the next DITA 1.3 errata, and is now fixed in the DITA-OT copy.
+            <xref href="https://github.com/dita-ot/dita-ot/issues/2705" format="html" scope="external">#2705</xref>
+          </li>
+          <li id="2706">On Windows only, chunking a DITA document using the "by-topic" method would lose the root chunk
+            and result in processing errors. The chunking process has been updated to handle Windows file paths
+            correctly; the chunking process now produces the same results on all systems.
+            <xref href="https://github.com/dita-ot/dita-ot/issues/2706" format="html" scope="external">#2706</xref>,
+            <xref href="https://github.com/dita-ot/dita-ot/pull/2728" format="html" scope="external">#2728</xref>
+          </li>
+          <li id="2714">HTML5 output restores support for the <xmlatt>spectitle</xmlatt> attribute on
+              <xmlelement>simpletable</xmlelement> elements and for the <xmlatt>specentry</xmlatt> attribute on
+              <xmlelement>stentry</xmlelement> elements. Support for those attributes was missing after the HTML5 and
+            XHTML code bases split in release 2.4.
+            <xref href="https://github.com/dita-ot/dita-ot/pull/2714" format="html" scope="external">#2714</xref>
+          </li>
+          <li id="2716">In the original 2.5 release, a <xmlelement>topicref</xmlelement> that included a reference to a
+            local topic ID (such as <codeph>href="file.dita#root"</codeph>) could cause build failures when another
+            element in the document used the same ID. The reference is now handled properly.
+            <xref href="https://github.com/dita-ot/dita-ot/pull/2716" format="html" scope="external">#2716</xref>
+          </li>
+          <li>
+            <p>The documentation includes minor
+              <xref href="https://github.com/dita-ot/docs/compare/2.5...2.5.1" format="html" scope="external">
+                changes</xref> with
+              <xref href="https://github.com/dita-ot/docs/milestone/25?closed=1" format="html" scope="external"
+                >corrections and improvements</xref> to existing topics.</p>
+          </li>
+        </ul>
+        <p>For the complete list of changes since the previous release, see the
+          <xref href="https://github.com/dita-ot/dita-ot/compare/2.5...2.5.1" format="html" scope="external">
+            changelog</xref> on GitHub.</p>
+      </section>
+    </refbody>
+  </reference>
+
   <reference id="requirements">
     <title>Requirements</title>
     <refbody>
@@ -56,7 +129,8 @@
             <xmlelement>dita</xmlelement> element), earlier versions of DITA-OT included only the first topic, and links
           to topics within <xmlelement>dita</xmlelement> elements were broken. The PDF output now includes the full
           content of the referenced document, and links to any element within the document are correct.
-          <xref href="https://github.com/dita-ot/dita-ot/issues/1077" format="html" scope="external">#1077</xref></p>
+          <xref href="https://github.com/dita-ot/dita-ot/issues/1077" format="html" scope="external">#1077</xref>,
+          <xref href="https://github.com/dita-ot/dita-ot/pull/2679" format="html" scope="external">#2679</xref></p>
         <p id="2698">Attributes from the <xmlelement>dita</xmlelement> element are now preserved when merging topics. In
           previous releases, attributes like <xmlatt>xml:lang</xmlatt> set on the <xmlelement>dita</xmlelement> element
           were lost during the PDF "topic merge" process.
@@ -127,6 +201,11 @@
               <xmlatt>conref</xmlatt> targets were not retrieved and links were not properly handled.
             <xref href="https://github.com/dita-ot/dita-ot/issues/2569" format="html" scope="external">#2569</xref>
           </li>
+          <li id="2670">A new internal parameter named <codeph>temp.output.dir.name</codeph> allows plugin developers to
+            direct output to a location within the existing temporary directory, which allows for additional
+            post-processing before files are placed in the output directory.
+            <xref href="https://github.com/dita-ot/dita-ot/pull/2670" format="html" scope="external">#2670</xref>
+          </li>
           <li id="2684">Eclipse Help output can now be created as a JAR file. When the
               <codeph>args.eclipsehelp.jar.name</codeph> property is specified for an Eclipse build, the generated
             content will all be zipped in a JAR file with the name taken from that property.
@@ -283,6 +362,10 @@
             image processing. These now use <codeph>format="image"</codeph> as intended.
             <xref href="https://github.com/dita-ot/dita-ot/issues/2653" format="html" scope="external">#2653</xref>
           </li>
+          <li id="2659">In DITA-OT 2.4, when new topics were generated by the Branch Filtering process, the generated
+            topics were not added to the <filepath>.job.xml</filepath> configuration file. They are now added properly.
+            <xref href="https://github.com/dita-ot/dita-ot/issues/2659" format="html" scope="external">#2659</xref>
+          </li>
           <li id="2665">When setting link text, some link targets caused <filepath>topicpullImpl.xsl</filepath> to
             generate the following message <msgph>XPTY0004: A sequence of more than one item is not allowed as the first
               argument of normalize-space()</msgph>. The XSLT data type has been corrected to prevent this.

diff --git a/resources/key-definitions.ditamap b/resources/key-definitions.ditamap
@@ -32,7 +32,7 @@
   <keydef keys="maintenance-version">
     <topicmeta>
       <keywords>
-        <keyword>2.5</keyword>
+        <keyword>2.5.1</keyword>
       </keywords>
     </topicmeta>
   </keydef>

diff --git a/user-guide/dita2javahelp.dita b/user-guide/dita2javahelp.dita
@@ -12,7 +12,7 @@
       <ul>
         <li>Table of Contents (<filepath>toc.xml</filepath>)</li>
         <li>Sorted index (<filepath>mapname_index.xml</filepath>)</li>
-        <li>Other Java Help project files (<filepath>map.jhm and mapname_helpset.hs</filepath>)</li>
+        <li>Other Java Help project files (<filepath>map.jhm</filepath> and <filepath>mapname_helpset.hs</filepath>)</li>
         <li>If the Java Help compiler is located on the system, a compiled Java Help project will be returned.</li>
       </ul></p>
     <p>To run the Java Help transformation, set the <parmname>transtype</parmname> parameter to