diff --git a/reference/third-party-software.dita b/reference/third-party-software.dita index 75bbd3bf..3a2ad3ab 100644 --- a/reference/third-party-software.dita +++ b/reference/third-party-software.dita @@ -53,6 +53,13 @@ + + Apache XML Commons Resolver + Apache XML Commons Resolver + + + + Guava Guava @@ -115,7 +122,7 @@ XML Resolver XML Resolver - + diff --git a/release-notes/index.dita b/release-notes/index.dita index 000cf4e1..37f189c4 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -26,15 +26,135 @@ - + DITA-OT <keyword keyref="maintenance-version"/> - <ph outputclass="small text-muted">released July 20, 2023</ph> + <!--<ph outputclass="small text-muted">released MMMM DD, YYYY</ph>--> -

DITA Open Toolkit is a maintenance release that includes the following bug fixes.

+
    + +
  • Various issues in map-first preprocessing have been resolved in this release. + #4237 +
      +
    • Earlier versions failed to expand content references that were specified in key definitions. + In preprocess2, content references are now expanded before key references to ensure + that all topics are available when the map is processed. + #2420, + #4258, + #4261 +
      • +
    • Key references to duplicate topics created via copy-to attributes caused + builds to fail. This issue was initially resolved for the original preprocessing routine in DITA-OT + 3.1.1. The original source information is now also correctly recorded for copy-to targets in + preprocess2, allowing builds to continue. + #3007, + #3015 +
      • +
    • Earlier versions failed to catch certain validation errors in preprocess2. + Map-first preprocessing has been updated to validate files correctly. + #3281 +
      • +
    • In DITA-OT 3.5 to 4.1, map-first preprocessing failed to report unresolved content + references to topics that were not referenced in the map, and any key references they contained were not + expanded. In the past, this issue could be avoided by adding content reference targets to the map with + the processing-role attribute set to resource-only, but this + workaround is no longer necessary. Unresolved references should now be reported, and keys expanded even + if the target topics are not referenced in the map. + #3446, + #3546 +
      • +
    • Map-first preprocessing set incorrect values for the path2project, + path2project-uri, and path2rootmap-uri processing instructions. In + preprocess2, they are now set with correct values that match the original preprocess + output. + #3514, + #4252 +
      • +
    • The map-first preprocessing test code has been simplified to use the same expected output + for the original preprocessing routines and preprocess2. + #4268 +
      • +
    +
    • +
  • Network file URI validation has been fixed to allow builds to continue when cross-references + point to invalid URIs. Up until DITA-OT 3.6, the non-standard 2-slash format could be used to represent the + server name in Windows UNC filenames such as \\server\folder\file.pdf using the + Authority part of the URI as file://server/folder/file.pdf. Recent versions of DITA-OT + required the correct 3-slash notation with an explicitly empty authority component + (file:///server/folder/file.pdf), or builds would fail. Validation has been relaxed + to restore support for the 2-slash format. + #3718, + #4255 +
    • +
  • Chunk-to-content publishing failed on DITA map files whose paths included spaces. The chunk map + reader module now normalizes map file paths to allow publishing to continue in these cases. + #4064, + #4257 +
    • +
  • The HTML5 plug-in has been updated to remove the remaining inline style attributes that + prevented custom plug-ins from overriding the monospace font presentation of teletype + tt elements. These changes move the default teletype styling to CSS to allow + users to override the presentation in custom stylesheets. The output is visually equivalent to the results + generated by previous toolkit versions. + #4254, + #4267 + In publishing environments that do not use the default common CSS files, these styles + may need to be implemented in custom stylesheets. +
    • +
  • Test coverage has been improved to include unit tests for preprocessing, integration tests for + subject schemes, and unit tests for cascading metadata in duplicate topicrefs. + #4259, + #4264, + #4280 +
    • +
  • In earlier versions, cross-references or other links to titles that contained footnotes included + the footnote text. For a link to a target element that has no explicit link text, DITA-OT computes default + link text from the target element. Link text computation now ignores any fn + elements it encounters, so the link shows only the text from the title element. + #4269, + #4276 +
    • +
  • When maps point to the same resource in multiple topic references with different navigation + titles (or other topic metadata), older versions of DITA-OT used the metadata from the first reference for + all subsequent instances. The original code was written to cascade metadata within the map and also collect + metadata to be pushed to topics. This code worked when each topic was only referenced once. When there were + duplicates, only the first topic reference got the correct cascaded metadata; the second reference was + processed with the cascaded metadata, but also with the metadata from the first topicref. The code has been + refactored to separate metadata cascading within maps from the collection of metadata to push to topics, so + subsequent references to the same resource now retain the correct metadata for each instance. + #4275, + #4283, + #4284 +
    • +
  • The bundled XML Resolver has been upgraded to version 5.2.1, which no longer fails on invalid + URI characters like spaces or Windows backslashes, and now also runs in environments with a restrictive + security manager. + #4274, + #4279 +
    • +
+

For additional information on the issues resolved since the previous release, see the + 4.1.2 milestone and + + changelog on GitHub.

+
+ + + + + DITA-OT 4.1.1 + <ph outputclass="small text-muted">released July 20, 2023</ph> + + +
+

DITA Open Toolkit 4.1.1 is a maintenance release that includes the following bug fixes.

  • In previous releases, there were some cases in which a desc element @@ -75,7 +195,7 @@ #4187, #4240, #4248 -
    • +
  • Several dependencies have been upgraded to include the latest utility versions and fix security issues in bundled libraries:
      diff --git a/resources/key-definitions.ditamap b/resources/key-definitions.ditamap index 8685a63c..58840541 100644 --- a/resources/key-definitions.ditamap +++ b/resources/key-definitions.ditamap @@ -26,7 +26,7 @@ - 4.1.1 + 4.1.2 @@ -49,7 +49,7 @@ - + @@ -113,7 +113,7 @@ - + @@ -129,7 +129,7 @@ - + @@ -145,7 +145,7 @@ - + @@ -153,7 +153,8 @@ - + + @@ -161,6 +162,15 @@ + + + + + + 5.2.1 + + + @@ -176,7 +186,7 @@ - + diff --git a/resources/source-files.ditamap b/resources/source-files.ditamap index e102efdd..53916690 100644 --- a/resources/source-files.ditamap +++ b/resources/source-files.ditamap @@ -109,6 +109,7 @@ + diff --git a/samples/docker/Dockerfile b/samples/docker/Dockerfile index 685baa72..315d808f 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.1.1 +FROM ghcr.io/dita-ot/dita-ot:4.1.2 # Install a custom plug-in from a remote location: RUN dita --install https://github.com/infotexture/dita-bootstrap/archive/master.zip diff --git a/topics/migrating-to-4.1.dita b/topics/migrating-to-4.1.dita new file mode 100644 index 00000000..e4aff13a --- /dev/null +++ b/topics/migrating-to-4.1.dita @@ -0,0 +1,32 @@ + + + + + + Migrating to release 4.1 + + To 4.1 + + + DITA-OT 4.1 includes a new version of the Lightweight DITA plug-in with significant + enhancements to Markdown processing, and updates for the latest DITA 2.0 draft standard. + + +
      + This topic provides a summary of changes in DITA-OT 4.1 that may require modifications to custom stylesheets + or plug-ins. For more information on changes in this release, see the + . +
      + +
      + Legacy <xmlelement>tt</xmlelement> style attributes moved to CSS + tt styles +

      The HTML5 plug-in has been updated to remove the remaining inline style attributes that prevented custom + plug-ins from overriding the monospace font presentation of teletype tt elements.

      +

      These changes move the default teletype styling to CSS to allow users to override the presentation in custom + stylesheets. The output is visually equivalent to the results generated by previous toolkit versions.

      + In publishing environments that do not use the default common CSS files, these styles may + need to be implemented in custom stylesheets. +
      +       +       diff --git a/topics/migration.ditamap b/topics/migration.ditamap index b2c2de3e..0f856859 100644 --- a/topics/migration.ditamap +++ b/topics/migration.ditamap @@ -4,6 +4,7 @@ Migrating customizations +