Skip to content

Commit

Permalink
Merge tag '4.2.1' into develop
Browse files Browse the repository at this point in the history
DITA-OT 4.2.1

* tag '4.2.1':
  Remove WIP from 4.2.1 section title
  Favor JDKs & add package managers as Java sources
  Update <shortdesc> w/ maintenance release pattern
  Add details on issues resolved in 4.2.1
  Remove redundant Contributors section
  Add standard intro to maintenance release section
  Mark latest hotfix updates
  Bump Docker image version to ”4.2.1“
  Bump 'maintenance-version' key to “4.2.1”
  Draft 4.2.1 Release Notes (#541)
  • Loading branch information
infotexture committed Mar 1, 2024
2 parents 5ba6793 + 3773b6a commit 9f846ce
Show file tree
Hide file tree
Showing 6 changed files with 77 additions and 11 deletions.
56 changes: 49 additions & 7 deletions release-notes/index.dita
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
</titlealts>

<abstract>
<shortdesc><ph conref="#v4.2/summary"/></shortdesc>
<shortdesc>DITA Open Toolkit <keyword keyref="maintenance-version"/> is a maintenance release that fixes issues
reported in DITA-OT <keyword keyref="release"/>, which <ph conref="#v4.2/summary"/>.</shortdesc>
<p conkeyref="conref-task/semver-info"/>
<note type="tip"><ph conkeyref="conref-task/download-ot"/></note>
</abstract>
Expand All @@ -25,6 +26,49 @@
</refbody>
</reference>

<reference id="v4.2.1" outputclass="mark">
<title>DITA-OT <keyword keyref="maintenance-version"/>
<!--<ph outputclass="small text-muted">released MMMM DD, YYYY</ph>-->
</title>
<refbody>
<section id="bugs">
<p>DITA Open Toolkit <keyword keyref="maintenance-version"/> is a maintenance release that includes the
following bug fixes.</p>
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3A4.2.1+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
<ul>
<li id="4401">When using the in-memory store, earlier versions of the map-first pre-processing pipeline failed
to initialize the temporary directory. The directory is now created to ensure that files are processed
correctly.
<xref href="https://github.com/dita-ot/dita-ot/pull/4401" format="html" scope="external">#4401</xref>
</li>
<li id="4402">A NullPointerException that occured when using the in-memory store with map-first
pre-processing has also been fixed.
<xref href="https://github.com/dita-ot/dita-ot/pull/4402" format="html" scope="external">#4402</xref>
</li>
<li id="4405">In DITA-OT 4.2, the HTML5 transformation was updated to include map-level
<xmlelement>keywords</xmlelement> metadata in the table-of-contents file <filepath>index.html</filepath>.
However, this inadvertently also included variable definition keywords from nested topic references.
Processing has been updated to only include top-level map keyword metadata.
<xref href="https://github.com/dita-ot/dita-ot/issues/4405" format="html" scope="external">#4405</xref>,
<xref href="https://github.com/dita-ot/dita-ot/pull/4418" format="html" scope="external">#4418</xref>
</li>
<li id="4406">The command-line interface in DITA-OT 4.2 prints colored messages in several additional cases,
but these changes accidentally removed the logging level prefixes in terminal environments that don’t
support color. These message prefixes now appear in all environments, regardless of color support.
<xref href="https://github.com/dita-ot/dita-ot/issues/4406" format="html" scope="external">#4406</xref>
<xref href="https://github.com/dita-ot/dita-ot/pull/4409" format="html" scope="external">#4409</xref>
</li>
<li id="4416">DITA-OT 4.2 pruned logging level prefixes from messages by removing anything that appeared
between square brackets <codeph>][</codeph> and <codeph>]</codeph>, but this also dropped custom prefixes.
Logging has been updated to only remove prefixes that match the default level names like
<codeph>INFO</codeph> or <codeph>WARN</codeph>.
<xref href="https://github.com/dita-ot/dita-ot/pull/4416" format="html" scope="external">#4416</xref>
</li>
</ul>
</section>
</refbody>
</reference>

<reference id="v4.2">
<title>DITA-OT <keyword keyref="release"/>
<ph outputclass="small text-muted"> released February 11, 2024</ph>
Expand All @@ -40,12 +84,10 @@
</prolog>
<refbody>
<section>
<p><ph id="summary">DITA Open Toolkit Release <keyword
keyref="release"
/> uses map-first pre-processing for HTML5
output and includes a new local configuration file, better CLI messages with support for overrides, a new
version of the Lightweight DITA plug-in with enhancements to Markdown processing, and updates for the latest
DITA 2.0 draft standard.</ph></p>
<p>DITA Open Toolkit Release <keyword keyref="release"/>
<ph id="summary">uses map-first pre-processing for HTML5 output and includes a new local configuration file,
better CLI messages with support for overrides, a new version of the Lightweight DITA plug-in with
enhancements to Markdown processing, and updates for the latest DITA 2.0 draft standard</ph>.</p>
</section>

<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3ANext+is%3Aclosed+label%3Afeature+sort%3Acreated-asc -->
Expand Down
20 changes: 20 additions & 0 deletions resources/external-links.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -859,6 +859,16 @@
<linktext>CommonMark</linktext>
</topicmeta>
</keydef>
<keydef
keys="chocolatey"
href="https://chocolatey.org/"
scope="external"
format="html"
>
<topicmeta>
<linktext>Chocolatey</linktext>
</topicmeta>
</keydef>
<keydef
keys="dita-adoption-tc"
href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita-adoption"
Expand Down Expand Up @@ -1029,6 +1039,16 @@
<linktext>Sass</linktext>
</topicmeta>
</keydef>
<keydef
keys="sdkman"
href="https://sdkman.io/jdks"
scope="external"
format="html"
>
<topicmeta>
<linktext>SDKMAN!</linktext>
</topicmeta>
</keydef>
<keydef
keys="python-markdown-attlists"
href="https://python-markdown.github.io/extensions/attr_list/"
Expand Down
2 changes: 1 addition & 1 deletion resources/key-definitions.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<keydef keys="maintenance-version">
<topicmeta>
<keywords>
<keyword>4.2</keyword>
<keyword>4.2.1</keyword>
</keywords>
</topicmeta>
</keydef>
Expand Down
6 changes: 5 additions & 1 deletion resources/reusable-components.dita
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,18 @@
<indexterm>OpenJDK</indexterm>
<indexterm>Oracle JDK</indexterm>
<ul>
<li>You can download the Oracle JRE or JDK from
<li>You can download Oracle distributions from
<xref keyref="download.oracle-jdk"/> under commercial license.</li>
<li>Eclipse Temurin is the free OpenJDK distribution available from
<xref keyref="download.openjdk"/>.</li>
<li>Free OpenJDK distributions are also provided by
<xref keyref="download.openjdk.corretto"/>,
<xref keyref="download.openjdk.azul"/>, and
<xref keyref="download.openjdk.redhat"/>.</li>
<li>Java versions are also available via package managers such as
<xref keyref="chocolatey"/>,
<xref keyref="homebrew"/>, or
<xref keyref="sdkman"/></li>
</ul>
</p>
<p id="java-bc">
Expand Down
2 changes: 1 addition & 1 deletion samples/docker/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Use the latest DITA-OT image ↓ as parent:
FROM ghcr.io/dita-ot/dita-ot:4.2
FROM ghcr.io/dita-ot/dita-ot:4.2.1

# Install a custom plug-in from a remote location:
RUN dita --install https://github.com/infotexture/dita-bootstrap/archive/master.zip
Expand Down
2 changes: 1 addition & 1 deletion topics/prerequisite-software.dita
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<p>DITA-OT requires the following software applications:
<dl>
<dlentry>
<dt>Java Runtime Environment (JRE) or Java Development Kit (JDK)</dt>
<dt>Java Development Kit (JDK) or Java Runtime Environment (JRE)</dt>
<dd>
<p conkeyref="reusable-components/java-clients"/>
<note>This is the <i>only</i> prerequisite that you need to install. All other required software is
Expand Down

0 comments on commit 9f846ce

Please sign in to comment.