From d8ea6b8b32e646675546772a1116b5fd291fc5f4 Mon Sep 17 00:00:00 2001 From: Roger Sheen Date: Thu, 31 Aug 2017 12:41:17 +0200 Subject: [PATCH 01/16] Use latest DITA-OT version (2.5.3) for CI builds Signed-off-by: Roger Sheen --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index e44cc0214..7cee5d4da 100644 --- 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: From 08bd6e26e0a86c072ed4988e5e8fcda57b090bdd Mon Sep 17 00:00:00 2001 From: Roger Sheen Date: Fri, 29 Sep 2017 15:30:48 +0200 Subject: [PATCH 02/16] =?UTF-8?q?Bump=20'maintenance-version'=20key=20to?= =?UTF-8?q?=20=E2=80=9C2.5.4=E2=80=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Roger Sheen --- resources/key-definitions.ditamap | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/resources/key-definitions.ditamap b/resources/key-definitions.ditamap index 0aa261594..a2c31f8d0 100644 --- a/resources/key-definitions.ditamap +++ b/resources/key-definitions.ditamap @@ -32,7 +32,7 @@ - 2.5.3 + 2.5.4 From 3962cba4efc5b754277a56edda1a73571b0615b1 Mon Sep 17 00:00:00 2001 From: Roger Sheen Date: Fri, 29 Sep 2017 15:36:40 +0200 Subject: [PATCH 03/16] Prepare 2.5.4 Release Notes stub Signed-off-by: Roger Sheen --- release-notes/index.dita | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/release-notes/index.dita b/release-notes/index.dita index 63b460d58..c484a42aa 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -11,11 +11,31 @@ - + Maintenance Release <keyword keyref="maintenance-version"/>

DITA Open Toolkit Release includes the following bug fixes.

+
    +
  • In-topic links break when using onlytopic.in.map=true + #2800 +
    • +
  • Fix variable failure from xref without format + #2772 +
    • +
+

For the complete list of changes since the previous release, see the + + changelog on GitHub.

+
+ + + + + Maintenance Release 2.5.3 + +
+

DITA Open Toolkit Release 2.5.3 includes the following bug fixes.

  • In DITA-OT 2.5, the gen-list pre-processing step listed resource-only references with scope="peer" as local files when the From 057273986c245847e30ad292157c122611eec143 Mon Sep 17 00:00:00 2001 From: Robert D Anderson Date: Fri, 29 Sep 2017 21:35:07 -0500 Subject: [PATCH 04/16] Draft release notes for existing 2.5.4 issues --- release-notes/index.dita | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/release-notes/index.dita b/release-notes/index.dita index c484a42aa..a5cbabc84 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -17,12 +17,20 @@

    DITA Open Toolkit Release includes the following bug fixes.

      -
    • In-topic links break when using onlytopic.in.map=true - #2800 -
      • -
    • Fix variable failure from xref without format +
    • External cross references to DITA topics, such as + <xref href="http://example.com/onlineTopic.dita" scope="external">, + result in build failures due to an improperly set XSLT variable. #2772
      • +
    • Cross references within the same document, such as + <xref href="#topicid/sampleFigure"/>, cause build errors + when the build parameter onlytopic.in.map is set to true. + #2800 +
      • +

    For the complete list of changes since the previous release, see the From b326a517ed618f82c80e521682d33cd6a3e5e3b5 Mon Sep 17 00:00:00 2001 From: Robert D Anderson Date: Fri, 29 Sep 2017 22:22:56 -0500 Subject: [PATCH 05/16] Draft notes for latest fix in 2.5.4 --- release-notes/index.dita | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/release-notes/index.dita b/release-notes/index.dita index a5cbabc84..95a04cb40 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -22,6 +22,12 @@ result in build failures due to an improperly set XSLT variable. #2772

    • +
  • Cross references within the same document, such as <xref href="#topicid/sampleFigure"/>, cause build errors when the build parameter onlytopic.in.map is set to true. From 43542c9d29a587e60b0de4f6be83cfd30f94c3e9 Mon Sep 17 00:00:00 2001 From: Roger Sheen Date: Tue, 3 Oct 2017 01:20:37 +0200 Subject: [PATCH 06/16] Clarify system path separator for multiple DITAVALs Fixes #154. Signed-off-by: Roger Sheen --- parameters/ant-parameters-details.dita | 9 +++++---- release-notes/index.dita | 14 ++++++++++---- user-guide/DITA-messages-details.xml | 4 ++-- 3 files changed, 17 insertions(+), 10 deletions(-) diff --git a/parameters/ant-parameters-details.dita b/parameters/ant-parameters-details.dita index 15f5baca3..1f6f8ec6f 100644 --- a/parameters/ant-parameters-details.dita +++ b/parameters/ant-parameters-details.dita @@ -44,10 +44,11 @@

    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.

    - 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.     + The system path separator character is used to delimit individual file paths in the list of values + (semicolon ‘;’ on Windows, and colon ‘:’ 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. diff --git a/release-notes/index.dita b/release-notes/index.dita index 95a04cb40..70e97b30b 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -247,14 +247,20 @@
    Publishing with multiple DITAVAL filter files

    The args.filter 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 ‘;’ on Windows, and colon + ‘:’ 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. #2637

    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.

    +

    You can then pass the filenames to the dita command as follows:

    +

    + dita --input=userguide.ditamap --format= --filter=filters.ditaval:flags.ditaval +

    DITAVAL properties are now more flexible so that plug-ins can provide a common set of DITAVAL conditions and override the args.filter parameter. Initialization code has been cleaned up so that it does not set unnecessary properties. diff --git a/user-guide/DITA-messages-details.xml b/user-guide/DITA-messages-details.xml index 4c3684f13..d8e2fdf46 100644 --- a/user-guide/DITA-messages-details.xml +++ b/user-guide/DITA-messages-details.xml @@ -357,8 +357,8 @@

    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 ; - on Windows, or colon : on Linux or macOS).

    + delimited using the file path separator character appropriate for your operating system (semicolon + ‘;’ on Windows, or colon ‘:’ on macOS or Linux).

    From 23b575403d155e8470ff16ebd0e6d4132109e0b4 Mon Sep 17 00:00:00 2001 From: Robert D Anderson Date: Mon, 2 Oct 2017 20:52:20 -0500 Subject: [PATCH 07/16] Update index.dita --- release-notes/index.dita | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/release-notes/index.dita b/release-notes/index.dita index 70e97b30b..101a52273 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -17,25 +17,33 @@

    DITA Open Toolkit Release includes the following bug fixes.

      -
    • External cross references to DITA topics, such as +
    • In DITA-OT 2.5, external cross references to DITA topics, such as <xref href="http://example.com/onlineTopic.dita" scope="external">, result in build failures due to an improperly set XSLT variable. #2772
      • - -
    • Cross references within the same document, such as +
      • + +
    • In DITA-OT 2.4 and 2.5, the property in reference topics resulted in an "Ambiguous rule match" message from Saxon when building HTML5. This message has been removed. #2801 +
      • +

    For the complete list of changes since the previous release, see the From 89fe8ba75c64cc8b2e7dfce6ec5c7379aa312077 Mon Sep 17 00:00:00 2001 From: Robert D Anderson Date: Tue, 3 Oct 2017 09:01:40 -0500 Subject: [PATCH 08/16] Add draft notes for 2805 --- release-notes/index.dita | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/release-notes/index.dita b/release-notes/index.dita index 101a52273..5399a5a02 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -45,6 +45,11 @@ #2790, #2803

    • --> +

For the complete list of changes since the previous release, see the From 3a3260b050ff5ad8e3ebc8f4a11769f32e69bd74 Mon Sep 17 00:00:00 2001 From: Robert D Anderson Date: Tue, 3 Oct 2017 20:51:07 -0500 Subject: [PATCH 09/16] Draft notes for 2806 --- release-notes/index.dita | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/release-notes/index.dita b/release-notes/index.dita index 5399a5a02..82e239ce1 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -50,6 +50,13 @@ the build would end in a null pointer error. This error has been removed and the build will continue. #2805 --> +

For the complete list of changes since the previous release, see the From df24d395c9f13cb0b1edc1f660ce511b4ebde589 Mon Sep 17 00:00:00 2001 From: Roger Sheen Date: Wed, 4 Oct 2017 22:44:54 +0200 Subject: [PATCH 10/16] Enable descriptions for recently resolved issues Signed-off-by: Roger Sheen --- release-notes/index.dita | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/release-notes/index.dita b/release-notes/index.dita index 82e239ce1..d7a2b898c 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -28,35 +28,35 @@ #2795, #2802 - +

  • In DITA-OT 2.4 and 2.5, the property in reference topics resulted in an "Ambiguous rule match" message from Saxon when building HTML5. This message has been removed. #2801
    • - - - +

    For the complete list of changes since the previous release, see the From 900ddaafa9f72cc14d28677aa5a70287e6364d51 Mon Sep 17 00:00:00 2001 From: Roger Sheen Date: Wed, 4 Oct 2017 22:45:55 +0200 Subject: [PATCH 11/16] Use earliest issue as list item ID Signed-off-by: Roger Sheen --- release-notes/index.dita | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/release-notes/index.dita b/release-notes/index.dita index d7a2b898c..cda11da66 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -37,7 +37,7 @@ "Ambiguous rule match" message from Saxon when building HTML5. This message has been removed. #2801 -

  • In earlier releases, plugins that contributed variables (or strings) did not work +
  • In earlier releases, plugins that contributed variables (or strings) did not work when the variables were contributed with mixed case (such as pt-BR instead of pt-pt. This has been fixed, so that the case of xml:lang is ignored when contributing variables. From 842d1c99f7803be3aeda9e3abca1b9943457fbcd Mon Sep 17 00:00:00 2001 From: Roger Sheen Date: Wed, 4 Oct 2017 22:50:16 +0200 Subject: [PATCH 12/16] Sort items by earliest issue ID Signed-off-by: Roger Sheen --- release-notes/index.dita | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/release-notes/index.dita b/release-notes/index.dita index cda11da66..b7ac4c046 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -17,6 +17,14 @@

    DITA Open Toolkit Release includes the following bug fixes.

      +
    • In earlier releases, plugins that contributed variables (or strings) did not work + when the variables were contributed with mixed case (such as pt-BR instead of + pt-pt. This has been fixed, so that the case of xml:lang is + ignored when contributing variables. + #2226, + #2790, + #2803 +
    • In DITA-OT 2.5, external cross references to DITA topics, such as <xref href="http://example.com/onlineTopic.dita" scope="external">, result in build failures due to an improperly set XSLT variable. @@ -37,14 +45,6 @@ "Ambiguous rule match" message from Saxon when building HTML5. This message has been removed. #2801
      • -
    • In earlier releases, plugins that contributed variables (or strings) did not work - when the variables were contributed with mixed case (such as pt-BR instead of - pt-pt. This has been fixed, so that the case of xml:lang is - ignored when contributing variables. - #2226, - #2790, - #2803 -
    • In earlier releases, when chunk="by-topic" was specified on a topicref element that did not specify the href attribute, the build would end in a null pointer error. This error has been removed and the build will continue. From 926d96917a3e0aee341bccbdcbe14380f5693d9f Mon Sep 17 00:00:00 2001 From: Roger Sheen Date: Thu, 5 Oct 2017 00:46:46 +0200 Subject: [PATCH 13/16] Copyedit issue descriptions Signed-off-by: Roger Sheen --- release-notes/index.dita | 48 +++++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 23 deletions(-) diff --git a/release-notes/index.dita b/release-notes/index.dita index b7ac4c046..426b4b46f 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -17,44 +17,46 @@

      DITA Open Toolkit Release includes the following bug fixes.

        -
      • In earlier releases, plugins that contributed variables (or strings) did not work - when the variables were contributed with mixed case (such as pt-BR instead of - pt-pt. This has been fixed, so that the case of xml:lang is - ignored when contributing variables. +
      • In earlier releases, plugins that contributed variables (or strings) did not work when the + variables were contributed with mixed case (such as pt-BR instead of + pt-pt). This has been fixed, so that the case of xml:lang is ignored when + contributing variables. #2226, #2790, #2803
        • -
      • In DITA-OT 2.5, external cross references to DITA topics, such as - <xref href="http://example.com/onlineTopic.dita" scope="external">, - result in build failures due to an improperly set XSLT variable. +
      • In DITA-OT 2.5, external cross references to DITA topics, such as <xref + href="http://example.com/onlineTopic.dita" scope="external">, resulted in build failures due + to an improperly set XSLT variable. This setting has been corrected to ensure external references are + resolved as expected. #2772
        • -
      • External links inside of related-links are dropped from PDF - output in DITA-OT 2.4 and 2.5. These links now appear using the href attribute - value as link text, as in earlier releases. +
      • External links in related-links collections were dropped from PDF + output in DITA-OT 2.4 and 2.5. These links now appear using the href attribute value as + link text, as in earlier releases. #2795, #2802
        • -
      • In DITA-OT 2.5, cross references within the same document, such as - <xref href="#topicid/sampleFigure"/>, cause build errors - when the build parameter onlytopic.in.map is set to true. +
      • In DITA-OT 2.5, cross references to targets within the same document, such as <xref + href="#topicid/sampleFigure"/>, caused build errors when the + onlytopic.in.map parameter was set to . Processing has been + corrected to ensure these links are generated correctly. #2800
        • -
      • In DITA-OT 2.4 and 2.5, the property in reference topics resulted in an - "Ambiguous rule match" message from Saxon when building HTML5. This message has been removed. +
      • In DITA-OT 2.4 and 2.5, the property element in reference topics + resulted in an "Ambiguous rule match" message from Saxon when building HTML5. This message has been removed. #2801
        • -
      • In earlier releases, when chunk="by-topic" was specified on a - topicref element that did not specify the href attribute, - the build would end in a null pointer error. This error has been removed and the build will continue. +
      • In earlier releases, when chunk="by-topic" was specified on a + topicref element that did not specify the href attribute, the + build would end in a null pointer exception. This error has been removed and the build will continue. #2805
        • -
      • In earlier releases, when a map reference (such as mapref) - referenced a map in a subdirectory, and that referenced map included elements with conref - attributes, the step that resolved map references did not properly adjust paths in - conref, resulting in unresolvable content references. This has been fixed, and - conref attributes in nested maps in subdirectories resolve properly. +
      • In earlier releases, when a map reference (such as mapref) referred to + a map in a subdirectory, and that referenced map included elements with conref attributes, + the step that resolved map references did not properly adjust paths in conref, resulting in + unresolvable content references. This has been fixed, and conref attributes in nested maps + in subdirectories now resolve properly. #2806
      From 3e1e6884e312c4d391c3ba29c071237a4ec85379 Mon Sep 17 00:00:00 2001 From: Roger Sheen Date: Thu, 5 Oct 2017 00:49:18 +0200 Subject: [PATCH 14/16] Link to docs diff & GitHub changelog Signed-off-by: Roger Sheen --- release-notes/index.dita | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/release-notes/index.dita b/release-notes/index.dita index 426b4b46f..b63d7edcd 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -59,6 +59,13 @@ in subdirectories now resolve properly. #2806
      • +
    • +

      The documentation includes minor + + changes with + corrections and improvements to existing topics.

      +

    For the complete list of changes since the previous release, see the From b6dbf41464ac9a469712b1c528b0cf88b129ffba Mon Sep 17 00:00:00 2001 From: Garrett Guillotte Date: Wed, 4 Oct 2017 16:47:57 -0700 Subject: [PATCH 15/16] Note that Java 8 is required as of 2.4 (#155) [DITA-OT 2.4 and newer require Java 8.](http://www.dita-ot.org/2.4/release-notes/index.html#ID__requirements) Noting that DITA-OT 2.0 requires Java 7 without including this context can lead to confusion if this is the first page of documentation a user encounters. Signed-off-by: Garrett Guillotte --- user-guide/reducing-processing-time.dita | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/user-guide/reducing-processing-time.dita b/user-guide/reducing-processing-time.dita index 84ef3eb98..9e7fee016 100644 --- a/user-guide/reducing-processing-time.dita +++ b/user-guide/reducing-processing-time.dita @@ -35,7 +35,9 @@

    Use the latest Java version -

    DITA-OT 2.0 requires Java 7, but using the latest version Java 8 will further reduce processing time.

    +

    DITA-OT 2.0 to 2.3 require Java Runtime Environment (JRE) 7, and DITA-OT 2.4 and newer require JRE 8. + However, using a newer version of the JRE with these versions of DITA-OT can further reduce processing + time.

    From fa14cad78f9b962839ed3de89d3d046d9bfd76c4 Mon Sep 17 00:00:00 2001 From: Roger Sheen Date: Thu, 5 Oct 2017 01:50:27 +0200 Subject: [PATCH 16/16] Copyedit Java references Signed-off-by: Roger Sheen --- user-guide/reducing-processing-time.dita | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/user-guide/reducing-processing-time.dita b/user-guide/reducing-processing-time.dita index 9e7fee016..d49722e13 100644 --- a/user-guide/reducing-processing-time.dita +++ b/user-guide/reducing-processing-time.dita @@ -35,9 +35,8 @@
    • Use the latest Java version -

    DITA-OT 2.0 to 2.3 require Java Runtime Environment (JRE) 7, and DITA-OT 2.4 and newer require JRE 8. - However, using a newer version of the JRE with these versions of DITA-OT can further reduce processing - time.

    +

    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.