From 90b532d0c7e94ae8b8ca94b953276b5cc7038c11 Mon Sep 17 00:00:00 2001
From: Roger Sheen
Date: Sat, 16 Nov 2024 22:31:55 +0100
Subject: [PATCH 01/13] =?UTF-8?q?Bump=20'maintenance-version'=20key=20to?=
=?UTF-8?q?=20=E2=80=9C4.2.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 aaa7736e..baa298d2 100644
--- a/resources/key-definitions.ditamap
+++ b/resources/key-definitions.ditamap
@@ -26,7 +26,7 @@
- 4.2.3
+ 4.2.4
From c688b098071fc995f31910990b38c1824d69b987 Mon Sep 17 00:00:00 2001
From: Roger Sheen
Date: Sat, 16 Nov 2024 22:32:25 +0100
Subject: [PATCH 02/13] =?UTF-8?q?Bump=20Docker=20image=20version=20to=20?=
=?UTF-8?q?=E2=80=9D4.2.4=E2=80=9C?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Roger Sheen
---
samples/docker/Dockerfile | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/samples/docker/Dockerfile b/samples/docker/Dockerfile
index ae54da57..307af80f 100644
--- a/samples/docker/Dockerfile
+++ b/samples/docker/Dockerfile
@@ -1,5 +1,5 @@
# Use the latest DITA-OT image ↓ as parent:
-FROM ghcr.io/dita-ot/dita-ot:4.2.3
+FROM ghcr.io/dita-ot/dita-ot:4.2.4
# Install a custom plug-in from a remote location:
RUN dita --install https://github.com/infotexture/dita-bootstrap/archive/master.zip
From 6612790b195cfb0ace9ae1b581207fb1b285ce4d Mon Sep 17 00:00:00 2001
From: Roger Sheen
Date: Sat, 16 Nov 2024 23:40:48 +0100
Subject: [PATCH 03/13] Draft 4.2.4 Release Notes stub
Signed-off-by: Roger Sheen
---
release-notes/index.dita | 37 ++++++++++++++++++++++++++++++++++---
1 file changed, 34 insertions(+), 3 deletions(-)
diff --git a/release-notes/index.dita b/release-notes/index.dita
index 94b74dd6..a23b056b 100644
--- a/release-notes/index.dita
+++ b/release-notes/index.dita
@@ -26,14 +26,45 @@
-
+ DITA-OT
- released May 5, 2024
+
DITA Open Toolkit is a maintenance release that includes the
following bug fixes.
+
+
+
The bundled Apache Commons IO library has
+ been upgraded to version 2.14.0, which includes security updates to mitigate the vulnerability described in
+ CVE-2024-47554, a possible denial of service attack on untrusted input to
+ XmlStreamReader.
+ #4526
+
+
In previous releases, the HTML5 transformation did not provide a mechanism for creating HTML5
+ metadata from data, data-about, and
+ resourceid elements. In this release, no metadata is created for these elements
+ by default, but placeholders have been added to the getMeta processing mode to allow custom
+ plug-ins to override the placeholders and generate metadata for these elements as needed.
+ #4532,
+ #4533
+
+
+
+
+
+
+
+ DITA-OT 4.2.3 released May 5, 2024
+
+
+
+
DITA Open Toolkit 4.2.3 is a maintenance release that includes the following bug fixes.
DITA-OT 4.2.2 included a regression bug that caused the map-first pre-processing routine to fail
@@ -46,7 +77,7 @@
-
+
DITA-OT 4.2.2
released March 24, 2024
From 1dc5e020a64b6d317ac41647013f1de79a8153df Mon Sep 17 00:00:00 2001
From: Jarno Elovirta
Date: Tue, 19 Nov 2024 19:13:32 +0200
Subject: [PATCH 04/13] Add stub for #4543 in the release notes
Signed-off-by: Jarno Elovirta
---
release-notes/index.dita | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/release-notes/index.dita b/release-notes/index.dita
index a23b056b..de8ad063 100644
--- a/release-notes/index.dita
+++ b/release-notes/index.dita
@@ -54,6 +54,15 @@
#4532,
#4533
+
+ DITA-OT had a bug that made it incorrectly process keyreffing elements
+ that has only whitespace, when per DITA spec it should have skipped those elements. This bug has been
+ fixed, but the fix has not been enabled. The existing broken behaviour is retained in order to not
+ break exising user content that rely on this buggy behaviour. The new
+ compatibility.keyref.treat-blank-as-empty property is can be used to switch off the
+ incorrect behaviour. The fix will be enabled by default in the next minor or major version.
+ #4543
+
From ca5cec972875e8a96a0164cfd4882a3eac1d4947 Mon Sep 17 00:00:00 2001
From: Jarno Elovirta
Date: Tue, 19 Nov 2024 19:19:27 +0200
Subject: [PATCH 05/13] Add stub for treat-blank-as-empty config
Signed-off-by: Jarno Elovirta
---
parameters/configuration-properties-file.dita | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/parameters/configuration-properties-file.dita b/parameters/configuration-properties-file.dita
index d7a03bb7..cdd6ef9c 100644
--- a/parameters/configuration-properties-file.dita
+++ b/parameters/configuration-properties-file.dita
@@ -73,6 +73,14 @@
configuration in the dost-configuration.jar file when the plug-in integration process runs. The
following properties are typically set in this file:
+
+ compatibility.keyref.treat-blank-as-empty
+
+
Enables compatibility mode that incorrectly processes key references that have only whitespace
+ content.
+ This property can only be set in
+ configuration.properties.
+ default.cascade
From 9057a3d99218bc47ddeedac04cc66faf48ed095a Mon Sep 17 00:00:00 2001
From: Roger Sheen
Date: Thu, 5 Dec 2024 00:51:23 +0100
Subject: [PATCH 06/13] Add details on recently resolved issues
Signed-off-by: Roger Sheen
---
release-notes/index.dita | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/release-notes/index.dita b/release-notes/index.dita
index de8ad063..1e1283fd 100644
--- a/release-notes/index.dita
+++ b/release-notes/index.dita
@@ -36,6 +36,13 @@
following bug fixes.
+
On Windows, earlier versions of the dita.bat command failed when options were
+ specified with straight quotation marks (" "). The batch script syntax has been updated to
+ enable delayed expansion, which ensures that quotation marks are parsed correctly. The order of commands has
+ also been adjusted to allow ANT_OPTS to override CLI parameters.
+ #4525,
+ #4545
+
The bundled Apache Commons IO library has
been upgraded to version 2.14.0, which includes security updates to mitigate the vulnerability described in
#4532,
#4533
+
Earlier versions did not generate links in HTML output when software elements such as
+ cmdname and msgnum were used in key references.
+ These elements are now processed as keywords to ensure that links are created as expected.
+ #4540,
+ #4547
+
DITA-OT had a bug that made it incorrectly process keyreffing elements
that has only whitespace, when per DITA spec it should have skipped those elements. This bug has been
From d7dd4f590d55ba0e530c7d6ab14040f38d68fe52 Mon Sep 17 00:00:00 2001
From: Roger Sheen
Date: Thu, 5 Dec 2024 01:15:02 +0100
Subject: [PATCH 07/13] Edit description for 4543
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 1e1283fd..30f2c889 100644
--- a/release-notes/index.dita
+++ b/release-notes/index.dita
@@ -67,14 +67,14 @@
#4540,
#4547
-
- DITA-OT had a bug that made it incorrectly process keyreffing elements
- that has only whitespace, when per DITA spec it should have skipped those elements. This bug has been
- fixed, but the fix has not been enabled. The existing broken behaviour is retained in order to not
- break exising user content that rely on this buggy behaviour. The new
- compatibility.keyref.treat-blank-as-empty property is can be used to switch off the
- incorrect behaviour. The fix will be enabled by default in the next minor or major version.
- #4543
+
Previous versions of DITA-OT incorrectly processed keyreffing elements that contain only
+ whitespace characters, where the DITA specification requires them to be skipped. This bug has been fixed,
+ but the fix is not yet enabled. The incorrect behavior is retained for backwards compatibility to ensure
+ that existing content that relies on this behavior will be processed in the same way.
+ A new compatibility.keyref.treat-blank-as-empty property can be used to switch off the
+ incorrect behavior. The fix will be enabled by default in the next minor or major version.
+ #4543,
+ #4544
Enables compatibility mode that incorrectly processes key references that have only whitespace
- content.
+
When set to true, this property enables a compatibility mode that processes key
+ references that contain only whitespace characters like earlier versions of DITA-OT (prior to version
+ 4.2.4). This behavior is not correct according to the DITA specification, but this setting ensures that
+ existing content that relies on this behavior will be processed in the same way as in earlier versions.
+ Set this property to false to skip these references as intended in the DITA
+ specification.
This property can only be set in
configuration.properties.
diff --git a/release-notes/index.dita b/release-notes/index.dita
index 30f2c889..43e23358 100644
--- a/release-notes/index.dita
+++ b/release-notes/index.dita
@@ -67,12 +67,13 @@
#4540,
#4547
-
Previous versions of DITA-OT incorrectly processed keyreffing elements that contain only
- whitespace characters, where the DITA specification requires them to be skipped. This bug has been fixed,
- but the fix is not yet enabled. The incorrect behavior is retained for backwards compatibility to ensure
- that existing content that relies on this behavior will be processed in the same way.
- A new compatibility.keyref.treat-blank-as-empty property can be used to switch off the
- incorrect behavior. The fix will be enabled by default in the next minor or major version.
+
Previous versions of DITA-OT incorrectly processed key references that contain only whitespace
+ characters, where the DITA specification requires them to be skipped. This bug has been fixed, but the fix
+ is not yet enabled. The incorrect behavior is retained for backwards compatibility to ensure that existing
+ content that relies on this behavior will be processed in the same way as in earlier versions.
+ A new compatibility.keyref.treat-blank-as-empty property can be set in
+ configuration.properties to switch off the incorrect
+ behavior. The fix will be enabled by default in the next minor or major version.
#4543,
#4544
From 1b5e8969a4ce2159ddacf84b4885cc629f8f4c30 Mon Sep 17 00:00:00 2001
From: Roger Sheen
Date: Fri, 6 Dec 2024 19:00:06 +0100
Subject: [PATCH 09/13] Add details on 4551
Signed-off-by: Roger Sheen
---
release-notes/index.dita | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/release-notes/index.dita b/release-notes/index.dita
index 43e23358..98b75c72 100644
--- a/release-notes/index.dita
+++ b/release-notes/index.dita
@@ -38,8 +38,7 @@
On Windows, earlier versions of the dita.bat command failed when options were
specified with straight quotation marks (" "). The batch script syntax has been updated to
- enable delayed expansion, which ensures that quotation marks are parsed correctly. The order of commands has
- also been adjusted to allow ANT_OPTS to override CLI parameters.
+ enable delayed expansion, which ensures that quotation marks are parsed correctly.
#4525,
#4545
@@ -77,6 +76,11 @@
#4543,
#4544
+
The order of arguments in the dita command scripts has been adjusted to allow
+ the content of the ANT_OPTS environment variable to override CLI parameters.
+ #4545,
+ #4551
+
Any property passed to Ant from the command line with -Dproperty or
--property=
A custom property file passed with --propertyfile
+
A .ditaotrc configuration file in the current directory or any ancestor directory, in
+ the user’s home directory, or in the root directory of the DITA-OT installation
A local.properties file in the root directory of the DITA-OT installation
The lib/org.dita.dost.platform/plugin.properties file
The configuration.properties file
@@ -43,7 +45,7 @@
property are ignored.
You can use this mechanism to override DITA-OT default settings for your environment by passing parameters to
the dita command with --property=, or using
- entries in .properties files.
+ entries in runtime configurations or .properties files.
diff --git a/parameters/dot-ditaotrc-file.dita b/parameters/dot-ditaotrc-file.dita
new file mode 100644
index 00000000..437d47b0
--- /dev/null
+++ b/parameters/dot-ditaotrc-file.dita
@@ -0,0 +1,41 @@
+
+
+
+
+ The .ditaotrc configuration file
+
+ .ditaotrc
+
+ As of DITA-OT 4.2, new files can be used to store DITA-OT runtime configurations in multiple places to
+ support fine-grained configuration layers.
+
+
+
+ files
+ .ditaotrc
+ .ditaotrc file
+
+
+
+
+
+
DITA-OT now looks for .ditaotrc configuration files in the current directory or any
+ ancestor directory first, then in the user’s home directory, and finally in the root directory of the DITA-OT
+ installation. These files are read in order and combined with the contents of the
+ local.properties file in the toolkit directory.
+
The first occurrence of a property takes precedence. This approach can be used to define multiple layers of
+ configuration, so personal defaults that apply to multiple projects can be stored in the home folder, with local
+ overrides in project folders.
+
+ For example, if the current directory includes a .ditaotrc file that sets
+ pdf.formatter=fop and the user’s home directory has a
+ .ditaotrc file with the following content,
+ pdf.formatter=xep
+args.grammar.cache=no DITA-OT will be run as if the following options were set on the command line:
+ --pdf.formatter=fop --args.grammar.cache=no
+ As of DITA-OT 4.2, any configurations in
+ local.properties files should be migrated to
+ .ditaotrc files.
+
+
+
diff --git a/parameters/local-properties-file.dita b/parameters/local-properties-file.dita
index 61fb33ef..ae329696 100644
--- a/parameters/local-properties-file.dita
+++ b/parameters/local-properties-file.dita
@@ -58,6 +58,9 @@ axf.cmd=C:\\Program Files\\Antenna House\\AHFormatterV62
This file can only be used to set Ant property values that can be passed as argument parameters to the
command line. The DITA-OT Java code does not read this file.
+ The local.properties file is still supported for backwards
+ compatibility, but as of DITA-OT 4.2, any local configurations should be migrated to
+ .ditaotrc configuration files.
diff --git a/parameters/parameters.ditamap b/parameters/parameters.ditamap
index 8d97ba43..01c9c9ab 100644
--- a/parameters/parameters.ditamap
+++ b/parameters/parameters.ditamap
@@ -20,6 +20,7 @@
+
diff --git a/release-notes/index.dita b/release-notes/index.dita
index 98b75c72..5d842ed0 100644
--- a/release-notes/index.dita
+++ b/release-notes/index.dita
@@ -229,9 +229,10 @@
- New configuration file
-
A new .ditaotrc configuration file can be used to store DITA-OT runtime configurations
- in multiple places.
+ New runtime configurations
+
New
+ .ditaotrc configuration files can be used to
+ store DITA-OT runtime configurations in multiple places.
DITA-OT now looks for this file in the current directory or any ancestor directory first, then in the user’s
home directory, and finally in the root directory of the DITA-OT installation. These files are read in order
and combined with the contents of the local.properties file in the toolkit directory. The
@@ -545,6 +546,8 @@
+
+
For additional information on documentation issues resolved in DITA Open Toolkit Release
+
From 86456c6d965012c91168891f410bbc36b03952ab Mon Sep 17 00:00:00 2001
From: Roger Sheen
Date: Fri, 6 Dec 2024 22:55:07 +0100
Subject: [PATCH 11/13] Link from args.rellinks to include.rellinks (#567)
Fixes #567
Signed-off-by: Roger Sheen
---
parameters/ant-parameters-details.dita | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/parameters/ant-parameters-details.dita b/parameters/ant-parameters-details.dita
index 6d40e4c7..3e4f682c 100644
--- a/parameters/ant-parameters-details.dita
+++ b/parameters/ant-parameters-details.dita
@@ -121,6 +121,16 @@
args.rellinks
+ Specifies which related
+ links to include in the output. The following values are supported:
+
+
– No links are included.
+
– All links are included.
+
– Ancestor and parent links are not included.
+
– Parent, ancestor, child, descendant, sibling, next, previous, and cousin
+ links are not included.
+
+
For PDF output, the default value is . Other formats include all link roles
@@ -132,7 +142,11 @@
HTML5
related linksargs.rellinks
-
+
+ For more precise control over related links output, set the internal Ant property
+
+ include.rellinks and specify which link roles to include.
+
args.resources
From dac4ab2beaa1b902154c9c719991759f82ecaf3c Mon Sep 17 00:00:00 2001
From: Roger Sheen
Date: Sat, 7 Dec 2024 19:25:41 +0100
Subject: [PATCH 12/13] Implement feedback on .ditaotrc
Signed-off-by: Roger Sheen
---
parameters/dot-ditaotrc-file.dita | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/parameters/dot-ditaotrc-file.dita b/parameters/dot-ditaotrc-file.dita
index 437d47b0..51d320c3 100644
--- a/parameters/dot-ditaotrc-file.dita
+++ b/parameters/dot-ditaotrc-file.dita
@@ -19,8 +19,8 @@
-
DITA-OT now looks for .ditaotrc configuration files in the current directory or any
- ancestor directory first, then in the user’s home directory, and finally in the root directory of the DITA-OT
+
DITA-OT looks for .ditaotrc configuration files in the current directory or any ancestor
+ directory first, then in the user’s home directory, and finally in the root directory of the DITA-OT
installation. These files are read in order and combined with the contents of the
local.properties file in the toolkit directory.
The first occurrence of a property takes precedence. This approach can be used to define multiple layers of
From 991df8c0bdac032d653d68ca2565b2dcd9de7a6b Mon Sep 17 00:00:00 2001
From: Roger Sheen
Date: Sun, 8 Dec 2024 11:31:56 +0100
Subject: [PATCH 13/13] Promote .ditaotrc note in local.properties topic
Signed-off-by: Roger Sheen
---
parameters/local-properties-file.dita | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/parameters/local-properties-file.dita b/parameters/local-properties-file.dita
index ae329696..e81a4fc9 100644
--- a/parameters/local-properties-file.dita
+++ b/parameters/local-properties-file.dita
@@ -34,9 +34,12 @@
-
For example, if you always use the same rendering engine to produce PDF output for all of your projects, you
- could create a local.properties file in the root directory of your DITA-OT installation to
- set the pdf.formatter parameter and additional options for the XSL processor:
+ The local.properties file is still supported for backwards
+ compatibility, but as of DITA-OT 4.2, any local configurations should be migrated to
+ .ditaotrc configuration files.
+
If you always use the same rendering engine to produce PDF output for all of your projects, you could create a
+ local.properties file in the root directory of your DITA-OT installation to set the
+ pdf.formatter parameter and additional options for the XSL processor:
# Use RenderX XEP Engine for PDF output
@@ -58,9 +61,6 @@ axf.cmd=C:\\Program Files\\Antenna House\\AHFormatterV62This file can only be used to set Ant property values that can be passed as argument parameters to the
command line. The DITA-OT Java code does not read this file.
- The local.properties file is still supported for backwards
- compatibility, but as of DITA-OT 4.2, any local configurations should be migrated to
- .ditaotrc configuration files.