Merge branch 'hotfix/2.5.4'

* hotfix/2.5.4: Copyedit Java references Note that Java 8 is required as of 2.4 (#155) Link to docs diff & GitHub changelog Copyedit issue descriptions Sort items by earliest issue ID Use earliest issue as list item ID Enable descriptions for recently resolved issues Draft notes for 2806 Add draft notes for 2805 Update index.dita Clarify system path separator for multiple DITAVALs Draft notes for latest fix in 2.5.4 Draft release notes for existing 2.5.4 issues Prepare 2.5.4 Release Notes stub Bump 'maintenance-version' key to “2.5.4” Use latest DITA-OT version (2.5.3) for CI builds
dita-ot · Oct 5, 2017 · a2ae2db · a2ae2db
2 parents 2749573 + fa14cad
commit a2ae2db
Show file tree

Hide file tree

Showing 6 changed files with 85 additions and 14 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -4,7 +4,7 @@ jdk:
 - oraclejdk8
 env:
   global:
-  - DITA_OT_VERSION=2.5.2
+  - DITA_OT_VERSION=2.5.3
 install:
 - ".travis/install.sh"
 script:

diff --git a/parameters/ant-parameters-details.dita b/parameters/ant-parameters-details.dita
@@ -44,10 +44,11 @@
             <pd conaction="pushreplace" conref="parameters-base.dita#base/args.filter.desc">
               <p>Specifies filter file(s) used to include, exclude, or flag content. Relative paths are resolved against
                 the DITA-OT base directory (for backwards compatibility) and internally converted to absolute paths.</p>
-              <note>The system separator character is used to separate the values. DITAVAL files are evaluated in the
-                order specified, so conditions specified in the first file take precedence over matching conditions
-                specified in later files, just as conditions at the start of a DITAVAL document take precedence over
-                matching conditions later in the same document.</note></pd>
+              <note>The system path separator character is used to delimit individual file paths in the list of values
+                (semicolon ‘<codeph>;</codeph>’ on Windows, and colon ‘<codeph>:</codeph>’ on macOS and Linux). DITAVAL
+                files are evaluated in the order specified, so conditions specified in the first file take precedence
+                over matching conditions specified in later files, just as conditions at the start of a DITAVAL document
+                take precedence over matching conditions later in the same document.</note></pd>
           </plentry>
           <plentry id="args.gen.task.lbl">
             <pt>

diff --git a/release-notes/index.dita b/release-notes/index.dita
@@ -11,11 +11,74 @@
     <note type="tip"><ph conref="../resources/conref-task.dita#ID/download-ot"/></note>
   </abstract>
 
-  <reference id="v253">
+  <reference id="v254">
     <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="2226">In earlier releases, plugins that contributed variables (or strings) did not work when the
+            variables were contributed with mixed case (such as <codeph>pt-BR</codeph> instead of
+            <codeph>pt-pt</codeph>). This has been fixed, so that the case of <xmlatt>xml:lang</xmlatt> is ignored when
+            contributing variables.
+            <xref href="https://github.com/dita-ot/dita-ot/issues/2226" format="html" scope="external">#2226</xref>,
+            <xref href="https://github.com/dita-ot/dita-ot/issues/2790" format="html" scope="external">#2790</xref>,
+            <xref href="https://github.com/dita-ot/dita-ot/pull/2803" format="html" scope="external">#2803</xref>
+          </li>
+          <li id="2772">In DITA-OT 2.5, external cross references to DITA topics, such as <codeph>&lt;xref
+              href="http://example.com/onlineTopic.dita" scope="external"&gt;</codeph>, resulted in build failures due
+            to an improperly set XSLT variable. This setting has been corrected to ensure external references are
+            resolved as expected.
+            <xref href="https://github.com/dita-ot/dita-ot/issues/2772" format="html" scope="external">#2772</xref>
+          </li>
+          <li id="2795">External links in <xmlelement>related-links</xmlelement> collections were dropped from PDF
+            output in DITA-OT 2.4 and 2.5. These links now appear using the <xmlatt>href</xmlatt> attribute value as
+            link text, as in earlier releases.
+            <xref href="https://github.com/dita-ot/dita-ot/issues/2795" format="html" scope="external">#2795</xref>,
+            <xref href="https://github.com/dita-ot/dita-ot/pull/2802" format="html" scope="external">#2802</xref>
+          </li>
+          <li id="2800">In DITA-OT 2.5, cross references to targets within the same document, such as <codeph>&lt;xref
+              href="#topicid/sampleFigure"/&gt;</codeph>, caused build errors when the
+              <parmname>onlytopic.in.map</parmname> parameter was set to <option>true</option>. Processing has been
+            corrected to ensure these links are generated correctly.
+            <xref href="https://github.com/dita-ot/dita-ot/issues/2800" format="html" scope="external">#2800</xref>
+          </li>
+          <li id="2801">In DITA-OT 2.4 and 2.5, the <xmlelement>property</xmlelement> element in reference topics
+            resulted in an "Ambiguous rule match" message from Saxon when building HTML5. This message has been removed.
+            <xref href="https://github.com/dita-ot/dita-ot/pull/2801" format="html" scope="external">#2801</xref>
+          </li>
+          <li id="2805">In earlier releases, when <codeph>chunk="by-topic"</codeph> was specified on a
+              <xmlelement>topicref</xmlelement> element that did not specify the <xmlatt>href</xmlatt> attribute, the
+            build would end in a null pointer exception. This error has been removed and the build will continue.
+            <xref href="https://github.com/dita-ot/dita-ot/pull/2805" format="html" scope="external">#2805</xref>
+          </li>
+          <li id="2806">In earlier releases, when a map reference (such as <xmlelement>mapref</xmlelement>) referred to
+            a map in a subdirectory, and that referenced map included elements with <xmlatt>conref</xmlatt> attributes,
+            the step that resolved map references did not properly adjust paths in <xmlatt>conref</xmlatt>, resulting in
+            unresolvable content references. This has been fixed, and <xmlatt>conref</xmlatt> attributes in nested maps
+            in subdirectories now resolve properly.
+            <xref href="https://github.com/dita-ot/dita-ot/pull/2806" format="html" scope="external">#2806</xref>
+          </li>
+          <li>
+            <p>The documentation includes minor
+              <xref href="https://github.com/dita-ot/docs/compare/2.5.3...2.5.4" format="html" scope="external">
+                changes</xref> with
+              <xref href="https://github.com/dita-ot/docs/milestone/29?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.3...2.5.4" format="html" scope="external">
+            changelog</xref> on GitHub.</p>
+      </section>
+    </refbody>
+  </reference>
+
+  <reference id="v253">
+    <title>Maintenance Release 2.5.3</title>
+    <refbody>
+      <section>
+        <p>DITA Open Toolkit Release 2.5.3 includes the following bug fixes.</p>
         <ul>
           <li id="2759">In DITA-OT 2.5, the <codeph>gen-list</codeph> pre-processing step listed resource-only
             references with <xmlatt>scope</xmlatt>=<codeph>"peer"</codeph> as local files when the
@@ -213,14 +276,20 @@
       <section id="2637">
         <title>Publishing with multiple DITAVAL filter files</title>
         <p>The <codeph>args.filter</codeph> parameter, which previously allowed you to specify a single DITAVAL file for
-          filtering or flagging, now accepts a list of URIs. The system separator character is used to separate the
-          values. DITAVAL files are evaluated in the order specified, so conditions specified in the first file take
-          precedence over matching conditions specified in later files, just as conditions at the start of a DITAVAL
-          document take precedence over matching conditions later in the same document.
+          filtering or flagging, now accepts a list of URIs. The system path separator character is used to delimit
+          individual file paths in the list of values (semicolon ‘<codeph>;</codeph>’ on Windows, and colon
+            ‘<codeph>:</codeph>’ on macOS and Linux). DITAVAL files are evaluated in the order specified, so conditions
+          specified in the first file take precedence over matching conditions specified in later files, just as
+          conditions at the start of a DITAVAL document take precedence over matching conditions later in the same
+          document.
           <xref href="https://github.com/dita-ot/dita-ot/issues/2637" format="html" scope="external">#2637</xref></p>
         <p>This feature allows you to manage your conditions independently or combine conditions from multiple sources.
           For example, you can now manage your filter conditions (that might change rarely) separately from revisions,
           or easily combine flagging conditions from different products when those products are published together.</p>
+        <p>You can then pass the filenames to the <cmdname>dita</cmdname> command as follows:</p>
+        <p>
+          <codeblock><cmdname>dita</cmdname> <parmname>--input</parmname>=<filepath>userguide.ditamap</filepath> <parmname>--format</parmname>=<option>pdf</option> <parmname>--filter</parmname>=<filepath>filters.ditaval:flags.ditaval</filepath></codeblock>
+        </p>
         <p id="2681"> DITAVAL properties are now more flexible so that plug-ins can provide a common set of DITAVAL
           conditions and override the <parmname>args.filter</parmname> parameter. Initialization code has been cleaned
           up so that it does not set unnecessary properties.

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.3</keyword>
+        <keyword>2.5.4</keyword>
       </keywords>
     </topicmeta>
   </keydef>

diff --git a/user-guide/DITA-messages-details.xml b/user-guide/DITA-messages-details.xml
@@ -357,8 +357,8 @@
       <strow>
         <stentry conref="DITA-messages.xml#msgs/DOTJ071E-extra" conaction="pushreplace">
           <p>Ensure that the DITAVAL file exists. If more than one DITAVAL file is specified, ensure that the paths are
-            separated using the separator character appropriate for your operating system (semicolon <codeph>;</codeph>
-            on Windows, or colon <codeph>:</codeph> on Linux or macOS).</p>
+            delimited using the file path separator character appropriate for your operating system (semicolon
+              ‘<codeph>;</codeph>’ on Windows, or colon ‘<codeph>:</codeph>’ on macOS or Linux).</p>
         </stentry>
       </strow>
       <strow>

diff --git a/user-guide/reducing-processing-time.dita b/user-guide/reducing-processing-time.dita
@@ -35,7 +35,8 @@
       </section>
       <section>
          <title>Use the latest Java version</title>
-         <p>DITA-OT 2.0 requires Java 7, but using the latest version Java 8 will further reduce processing time.</p>
+         <p>DITA-OT 2.0 to 2.3 require Java 7, and DITA-OT 2.4 and newer require Java 8. However, using a newer version
+            of Java can further reduce processing time.</p>
       </section>
    </body>