Skip to content

Commit

Permalink
Add details on issues tagged “enhancement” & “bug”
Browse files Browse the repository at this point in the history 
Signed-off-by: Roger Sheen <[email protected]>
  • Loading branch information
@infotexture
infotexture committed Feb 11, 2025
1 parent 55ec83a commit 922d469
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 41 deletions.
87 changes: 47 additions & 40 deletions release-notes/index.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,7 @@
<li>For a list of available templates, run <filepath conkeyref="conref-task/dita-cmd"/>
<cmdname>init</cmdname>
<parmname>--list</parmname></li>
<li>To add files from a template to the current working directory, run <filepath
conkeyref="conref-task/dita-cmd"
/>
<li>To add files from a template to the current directory, run <filepath conkeyref="conref-task/dita-cmd"/>
<cmdname>init</cmdname>
<varname>template</varname></li>
</ul>
Expand All @@ -119,9 +117,11 @@
<section id="lwdita">
<title>Lightweight DITA and Markdown updates</title>
<p>The <codeph>org.lwdita</codeph> plug-in has been updated to version <keyword keyref="tool.lwdita.version"/>,
which includes performance improvements and updates to Markdown processing to reflect recent changes to the
latest LwDITA drafts from OASIS.</p>
<ul>
which includes <ph
outputclass="mark"
>[…] and updates to Markdown processing to reflect recent changes to the latest LwDITA drafts
from OASIS</ph>.</p>
<ul outputclass="mark">
<li>
<p><b>Markdown output</b></p>
<ul>
Expand Down Expand Up @@ -149,11 +149,10 @@

<section id="dita-2-0-preview">
<title>Updated DITA 2.0 preview</title>
<p>In addition to the
<p outputclass="mark">In addition to the
<xref keyref="dita-v2-0-support"/> provided in DITA-OT 3.5 – 4.2, this release includes updated processing for
the latest draft versions of the DITA 2.0 grammar files from OASIS (as of <keyword
keyref="draft-dita-grammar-state"
/>). <!-- Link to PRs that update 2.0 grammar files-->
the latest draft versions of the DITA 2.0 grammar files from OASIS (as of […]
<!--<keyword keyref="draft-dita-grammar-state"/>-->). <!-- Link to PRs that update 2.0 grammar files-->
</p>
<!--
<ul conkeyref="dita-v2-0-support/added-in-4.3">
Expand All @@ -171,59 +170,62 @@
existing features:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A4.3+is%3Aclosed+label%3Aenhancement+sort%3Acreated-asc -->
<ul>
<li id="4001">Lazy loading for external images
<li id="4001">To reduce page load times, HTML5 output now uses
<xref
href="https://developer.mozilla.org/en-US/docs/Web/Performance/Lazy_loading"
format="html"
scope="external"
>lazy loading</xref> for external images.
<xref href="https://github.com/dita-ot/dita-ot/issues/4001" format="html" scope="external">#4001</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/4005" format="html" scope="external">#4005</xref>
</li>
<li id="4396">Move warning about not using validation to Ant
<xref href="https://github.com/dita-ot/dita-ot/issues/4396" format="html" scope="external">#4396</xref>
</li>
<li id="4404">Add Javadoc for map-first preprocessing
Local and peer image resources are loaded eagerly as in previous versions, but images defined with
<xmlatt>scope</xmlatt>=<codeph>"external"</codeph> are now output with the <xmlatt>loading</xmlatt>
attribute set to <codeph>"lazy"</codeph> by default. A new <codeph>set-image-loading</codeph> template mode
allows custom plug-ins to override the default behavior if necessary.</li>
<li id="4404">The Java code for the map-first pre-processing routines now includes Javadoc comments to
document how the various stages are implemented. This documentation is not published separately, but is
available to developers who need to extend map processing or topic processing in custom plug-ins. Many
development environments extract and display the Javadoc information while viewing the source code.
<xref href="https://github.com/dita-ot/dita-ot/issues/4404" format="html" scope="external">#4404</xref>
</li>
<li id="4407">Refactor Java
<xref href="https://github.com/dita-ot/dita-ot/issues/4407" format="html" scope="external">#4407</xref>
</li>
<li id="4441">Clean plug-in parser
<xref href="https://github.com/dita-ot/dita-ot/issues/4441" format="html" scope="external">#4441</xref>
</li>
<li id="4442">Refactor integration
<li id="4407">The Java code has been modernized to use more standard library features and reduce dependencies
on external libraries, and restructured with automatic refactoring tools to make it easier to read and
maintain.
<xref href="https://github.com/dita-ot/dita-ot/issues/4407" format="html" scope="external">#4407</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/4441" format="html" scope="external">#4441</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/4442" format="html" scope="external">#4442</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/4444" format="html" scope="external">#4444</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/4498" format="html" scope="external">#4498</xref>
</li>
<li id="4444">Use less Guava
<xref href="https://github.com/dita-ot/dita-ot/issues/4444" format="html" scope="external">#4444</xref>
</li>
<li id="4542">Protect against billion laughs attack
<li id="4542">DITA-OT uses the Xerces SecurityManager to protect against the so-called “
<xref href="https://en.wikipedia.org/wiki/Billion_laughs_attack" format="html" scope="external">billion
laughs attack</xref>”, an entity expansion technique that can cause XML parsers to run out of memory and
overload the CPU when parsing maliciously crafted files. DITA-OT will now stop parsing and report an error
when processing any files that exceed the entity limit imposed by the security manager library.
<xref href="https://github.com/dita-ot/dita-ot/issues/4542" format="html" scope="external">#4542</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/4556" format="html" scope="external">#4556</xref>
</li>
<li>The following bundled plug-ins have been upgraded to the latest versions:
<!--
<ul>
<li id="4140">The Normalized DITA plug-in version 1.1 now removes unnecessary key artefacts like
<xmlatt>keys</xmlatt>, <xmlatt>keyref</xmlatt> or <xmlelement>keydef</xmlelement> after key
resolution, and <xmlelement>ditavalref</xmlelement> elements after branch filter resolution.
<xref href="https://github.com/dita-ot/dita-ot/issues/4140" format="html" scope="external">#4140</xref>
</li>
<li id="4210">The Lightweight DITA plug-in version 5.8 includes the
<li id="4210">The Lightweight DITA plug-in version <keyword keyref="tool.lwdita.version"/> includes the
<xref href="#./lwdita"/> described above.
<!--
<xref href="https://github.com/dita-ot/dita-ot/issues/4167" format="html" scope="external">#4167</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/4178" format="html" scope="external">#4178</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/4210" format="html" scope="external">#4210</xref>
-->
</li>
<li id="4194">The PDF Theme plug-in version 0.8.0 adds support for […],
so you can now style these elements in a YAML theme file without building a
custom PDF plug-in.
<xref href="https://github.com/dita-ot/dita-ot/issues/4194" format="html" scope="external">#4194</xref>
<!--<xref href="https://github.com/dita-ot/dita-ot/issues/4194" format="html" scope="external">#4194</xref>-->
</li>
</ul>
-->
</li>
<li>Several bundled dependencies have been upgraded to the latest versions:
<ul>
<li id="4519"><keyword keyref="tool.fop.tm"/>
<keyword keyref="tool.fop.version"/>
<keyword keyref="tool.fop.version"/> (including the Apache XML Graphics and Batik libraries)
<xref href="https://github.com/dita-ot/dita-ot/issues/4519" format="html" scope="external">#4519</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/4565" format="html" scope="external">#4565</xref>
</li>
Expand All @@ -239,12 +241,17 @@
<p>DITA Open Toolkit Release <keyword keyref="release"/> provides fixes for the following bugs:</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A4.3+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
<ul>
<li id="4354">Installing plugin from directory with '@' character results in error
<li id="4354">In earlier versions, installing a plug-in from a path that contained the at-sign character
“<codeph>@</codeph>” failed with an InvalidArgumentException. The implementation has been
updated to ensure these paths are handled correctly.
<xref href="https://github.com/dita-ot/dita-ot/issues/4354" format="html" scope="external">#4354</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/4558" format="html" scope="external">#4558</xref>
</li>
<li id="4377">In preprocess2, DOTJ037W shows up twice when validate is set to false
<xref href="https://github.com/dita-ot/dita-ot/issues/4377" format="html" scope="external">#4377</xref>
<li id="4377">Earlier versions issued the <msgnum>DOTJ037W</msgnum> twice when running transformations with
the <parmname>validate</parmname> parameter set to <codeph>false</codeph>. This warning has been moved from
the Java code to Ant, which ensures that it only appears once for each transformation.
<xref href="https://github.com/dita-ot/dita-ot/issues/4377" format="html" scope="external">#4377</xref>,
<xref href="https://github.com/dita-ot/dita-ot/issues/4396" format="html" scope="external">#4396</xref>
</li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion resources/key-definitions.ditamap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
<keydef keys="tool.lwdita.version">
<topicmeta>
<keywords>
<keyword>5.7</keyword>
<keyword>5.8</keyword>
</keywords>
</topicmeta>
</keydef>
Expand Down

0 comments on commit 922d469

Please sign in to comment.