Skip to content

Commit 0b70d34

Browse files
infotextureinfotexture
committed
Summarize enhancements and bugfixes
Signed-off-by: Roger Sheen <roger@infotexture.net>
1 parent bc1bcc8 commit 0b70d34

File tree

1 file changed

+119
-85
lines changed

1 file changed

+119
-85
lines changed

‎release-notes/index.dita‎

Lines changed: 119 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -90,90 +90,111 @@
9090
existing features:</p>
9191
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3ANext+is%3Aclosed+label%3Aenhancement+sort%3Acreated-asc -->
9292
<ul>
93-
<li id="4579">Add stacktrace CLI option
93+
<li id="4579">A new <parmname
94+
>--stacktrace</parmname> command-line option has been added to print the full Java
95+
stack trace when an error occurs. This option is useful for debugging and troubleshooting, and can help
96+
developers and support teams diagnose issues more quickly. By default, stack traces are no longer included
97+
in verbose logging output to reduce noise for end users.
9498
<xref href="https://github.com/dita-ot/dita-ot/issues/4579" format="html" scope="external">#4579</xref>
9599
</li>
96-
<li id="4583">Add support for multiple deliverable options
100+
<li id="4583">The <parmname>--deliverable</parmname> option can now be specified multiple times on the command
101+
line to publish several deliverables from a project file in a single build. This allows you to select
102+
specific deliverables without publishing all deliverables defined in the project.
97103
<xref href="https://github.com/dita-ot/dita-ot/issues/4583" format="html" scope="external">#4583</xref>
98104
</li>
99-
<li id="4600">Move simple DITA 1.3 chunking to DITA 2.0 chunking module
105+
<li id="4600">Simple chunking cases in DITA 1.x maps can now be processed using the DITA 2.0 chunking module
106+
in compatibility mode. For example, a DITA 1.3 map with <codeph>chunk="to-content"</codeph> is now processed
107+
as if it used the DITA 2.0 <codeph>chunk="combine"</codeph> action. This refactoring improves reliability by
108+
leveraging the newer chunking code, which has fewer bugs than the legacy implementation. Note that this may
109+
change how splitting operations generate file names.
100110
<xref href="https://github.com/dita-ot/dita-ot/issues/4600" format="html" scope="external">#4600</xref>
101111
</li>
102-
<li id="4630">Support HTML5 attribute group passthrough (#4488)
112+
<li id="4630">In previous releases, DITAVAL <codeph>passthrough</codeph> actions in HTML5 transformations
113+
supported only simple (ungrouped) profiling attribute values. Passthrough support has been extended to
114+
profiling attribute groups. When an HTML5 <codeph>data-*</codeph> passthrough attribute is created for a
115+
value in a group, it is named after the group name. Per the DITA 2.0 specification, the <xmlatt>att</xmlatt>
116+
value of a <codeph>passthrough</codeph> action can match either a profiling attribute name or a group name,
117+
and ungrouped values belong to an implicit group named after the attribute.
103118
<xref href="https://github.com/dita-ot/dita-ot/issues/4630" format="html" scope="external">#4630</xref>
104119
</li>
105-
<li id="4631">add a CSS comment explaining why 'display: inline' is applied to note body (#4629)
120+
<li id="4631">In HTML5 transformations, note bodies are rendered as <xmlelement>div</xmlelement> elements with
121+
<codeph>display: inline</codeph> applied to allow single-line note rendering for inline note content. A CSS
122+
comment has been added to explain this styling choice.
106123
<xref href="https://github.com/dita-ot/dita-ot/issues/4631" format="html" scope="external">#4631</xref>
107124
</li>
108-
<li id="4635">Rename DITAVAL @outputclass to @add-outputclass
125+
<li id="4635">The DITAVAL <xmlatt>outputclass</xmlatt> attribute has been renamed to
126+
<xmlatt>add-outputclass</xmlatt> to match the DITA 2.0 specification. Support for the old attribute name is
127+
retained for backwards compatibility, but a <msgnum>DOTA014W</msgnum> warning message is now generated when
128+
the deprecated <xmlatt>outputclass</xmlatt> attribute is used.
109129
<xref href="https://github.com/dita-ot/dita-ot/issues/4635" format="html" scope="external">#4635</xref>
110130
</li>
111-
<li id="4637">Refactor keyref parser
131+
<li id="4637">The keyref parser has been refactored to improve code quality and prepare for future feature
132+
additions.
112133
<xref href="https://github.com/dita-ot/dita-ot/issues/4637" format="html" scope="external">#4637</xref>
113134
</li>
114-
<li id="4638">Cache topic IDs in keyref processing
135+
<li id="4638">Topic ID values are now cached during keyref resolution as a performance optimization. This
136+
cache is used for key definitions that point to a file without a topic ID in the fragment identifier. Key
137+
definitions that include a topic ID (such as <codeph>href="topic.dita#id"</codeph>) are not affected.
115138
<xref href="https://github.com/dita-ot/dita-ot/issues/4638" format="html" scope="external">#4638</xref>
116139
</li>
117-
<li id="4657">Fix test class name
118-
<xref href="https://github.com/dita-ot/dita-ot/issues/4657" format="html" scope="external">#4657</xref>
119-
</li>
120-
<li id="4663">Use Files methods to create file streams
121-
<xref href="https://github.com/dita-ot/dita-ot/issues/4663" format="html" scope="external">#4663</xref>
122-
</li>
123-
<li id="4664">Add unit tests for coderef
124-
<xref href="https://github.com/dita-ot/dita-ot/issues/4664" format="html" scope="external">#4664</xref>
125-
</li>
126-
<li id="4665">Upgrade XSpec
127-
<xref href="https://github.com/dita-ot/dita-ot/issues/4665" format="html" scope="external">#4665</xref>
128-
</li>
129-
<li id="4666">#4447 follow-up /refactor_gradle
130-
<xref href="https://github.com/dita-ot/dita-ot/issues/4666" format="html" scope="external">#4666</xref>
131-
</li>
132-
<li id="4672">fix missing task description in xhtml build
133-
<xref href="https://github.com/dita-ot/dita-ot/issues/4672" format="html" scope="external">#4672</xref>
134-
</li>
135-
<li id="4673">Improve integration test results
136-
<xref href="https://github.com/dita-ot/dita-ot/issues/4673" format="html" scope="external">#4673</xref>
137-
</li>
138-
<li id="4676">refactor integration tests, modularize, rename
139-
<xref href="https://github.com/dita-ot/dita-ot/issues/4676" format="html" scope="external">#4676</xref>
140-
</li>
141-
<li id="4677">Intorduce more uplevels tests
142-
<xref href="https://github.com/dita-ot/dita-ot/issues/4677" format="html" scope="external">#4677</xref>
143-
</li>
144-
<li id="4678">check output image paths in integration tests
145-
<xref href="https://github.com/dita-ot/dita-ot/issues/4678" format="html" scope="external">#4678</xref>
146-
</li>
147-
<li id="4679">fix overlapping paths in integration test folders
148-
<xref href="https://github.com/dita-ot/dita-ot/issues/4679" format="html" scope="external">#4679</xref>
149-
</li>
150-
<li id="4680">Clean CleanPreprocessModule
151-
<xref href="https://github.com/dita-ot/dita-ot/issues/4680" format="html" scope="external">#4680</xref>
152-
</li>
153-
<li id="4684">Refactor clean preprocess
154-
<xref href="https://github.com/dita-ot/dita-ot/issues/4684" format="html" scope="external">#4684</xref>
155-
</li>
156-
<li id="4690">unify @BeforeAll method names in tests
157-
<xref href="https://github.com/dita-ot/dita-ot/issues/4690" format="html" scope="external">#4690</xref>
158-
</li>
159-
<li id="4711">Improve chunk processing
140+
<li id="4711">DITA 2.0 chunk processing has been improved to support multiple operation tokens. This
141+
refactoring work lays the groundwork for future support of select tokens in DITA 2.0 chunk processing.
160142
<xref href="https://github.com/dita-ot/dita-ot/issues/4711" format="html" scope="external">#4711</xref>
161143
</li>
162-
<li id="4712">Update to Saxon 12.9
163-
<xref href="https://github.com/dita-ot/dita-ot/issues/4712" format="html" scope="external">#4712</xref>
164-
</li>
165-
<li id="4718">Generic refactoring
166-
<xref href="https://github.com/dita-ot/dita-ot/issues/4718" format="html" scope="external">#4718</xref>
167-
</li>
168-
<li id="4724">Refactor intergrator
169-
<xref href="https://github.com/dita-ot/dita-ot/issues/4724" format="html" scope="external">#4724</xref>
170-
</li>
171-
<li id="4734">Add support for OASIS linktitle and navtitle elements
144+
<li id="4734">DITA-OT now supports the DITA 2.0 <xmlelement>linktitle</xmlelement> element and recognizes both
145+
the DITA 1.3 and DITA 2.0 class attributes for <xmlelement>navtitle</xmlelement>. When using a DITA 2.0 root
146+
map, the preprocessed map will contain both <xmlelement>linktext</xmlelement> (for DITA 1.3 compatibility)
147+
and <xmlelement>linktitle</xmlelement> (for DITA 2.0) elements. Plug-ins that handle
148+
<xmlelement>navtitle</xmlelement> or <xmlelement>linktext</xmlelement> may need to be updated to handle
149+
these new elements.
172150
<xref href="https://github.com/dita-ot/dita-ot/issues/4734" format="html" scope="external">#4734</xref>
173151
</li>
174-
<li id="4739">Update to Saxon-HE 12.9
152+
<li>Saxon has been updated to version 12.9, which includes minor bug fixes.
153+
<xref href="https://github.com/dita-ot/dita-ot/issues/4712" format="html" scope="external">#4712</xref>,
175154
<xref href="https://github.com/dita-ot/dita-ot/issues/4739" format="html" scope="external">#4739</xref>
176155
</li>
156+
<li>XSpec has been upgraded to version 3.2.2, which improves XSLT test capabilities and now reports all
157+
failing tests in a file instead of just the first one.
158+
<xref href="https://github.com/dita-ot/dita-ot/issues/4665" format="html" scope="external">#4665</xref>
159+
</li>
160+
<li>Several internal code improvements have been made to enhance code quality, test coverage, and
161+
maintainability:
162+
<ul>
163+
<li>Test class names now consistently use a <codeph>Test</codeph> suffix
164+
<xref href="https://github.com/dita-ot/dita-ot/issues/4657" format="html" scope="external">#4657</xref>
165+
</li>
166+
<li>File stream creation now uses the modern <codeph>Files</codeph> API
167+
<xref href="https://github.com/dita-ot/dita-ot/issues/4663" format="html" scope="external">#4663</xref>
168+
</li>
169+
<li>Unit tests have been added for coderef processing
170+
<xref href="https://github.com/dita-ot/dita-ot/issues/4664" format="html" scope="external">#4664</xref>
171+
</li>
172+
<li>Gradle build scripts have been refactored
173+
<xref href="https://github.com/dita-ot/dita-ot/issues/4666" format="html" scope="external">#4666</xref>
174+
</li>
175+
<li>Debug output now includes task descriptions for XHTML builds
176+
<xref href="https://github.com/dita-ot/dita-ot/issues/4672" format="html" scope="external">#4672</xref>
177+
</li>
178+
<li>Integration test result reporting has been improved
179+
<xref href="https://github.com/dita-ot/dita-ot/issues/4673" format="html" scope="external">#4673</xref>,
180+
<xref href="https://github.com/dita-ot/dita-ot/issues/4676" format="html" scope="external">#4676</xref>,
181+
<xref href="https://github.com/dita-ot/dita-ot/issues/4677" format="html" scope="external">#4677</xref>,
182+
<xref href="https://github.com/dita-ot/dita-ot/issues/4678" format="html" scope="external">#4678</xref>,
183+
<xref href="https://github.com/dita-ot/dita-ot/issues/4679" format="html" scope="external">#4679</xref>
184+
</li>
185+
<li>Preprocessing modules have been refactored for better readability
186+
<xref href="https://github.com/dita-ot/dita-ot/issues/4680" format="html" scope="external">#4680</xref>,
187+
<xref href="https://github.com/dita-ot/dita-ot/issues/4684" format="html" scope="external">#4684</xref>
188+
</li>
189+
<li>Test method naming conventions have been standardized
190+
<xref href="https://github.com/dita-ot/dita-ot/issues/4690" format="html" scope="external">#4690</xref>
191+
</li>
192+
<li>General code refactoring for improved quality and performance
193+
<xref href="https://github.com/dita-ot/dita-ot/issues/4718" format="html" scope="external">#4718</xref>,
194+
<xref href="https://github.com/dita-ot/dita-ot/issues/4724" format="html" scope="external">#4724</xref>
195+
</li>
196+
</ul>
197+
</li>
177198
</ul>
178199
</section>
179200

@@ -183,47 +204,60 @@
183204
<p>DITA Open Toolkit Release <keyword keyref="release"/> provides fixes for the following bugs:</p>
184205
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3ANext+is%3Aclosed+label%3Abug+sort%3Acreated-asc -->
185206
<ul>
186-
<li id="4036">NullPointerException when using the root-chunk-override with the new DITA 2.0 "combine" value
207+
<li id="4036">Earlier versions of DITA-OT threw a <codeph>NullPointerException</codeph> when using the
208+
<parmname>--root-chunk-override</parmname> option with the DITA 2.0 <codeph>combine</codeph> value. Chunk
209+
processing has been updated to handle this case correctly.
187210
<xref href="https://github.com/dita-ot/dita-ot/issues/4036" format="html" scope="external">#4036</xref>
188211
</li>
189-
<li
190-
id="4464"
191-
>DITAVAL "passthough" action does not work for profiling applied to top-level (root) topic element
192-
<xref href="https://github.com/dita-ot/dita-ot/issues/4464" format="html" scope="external">#4464</xref>
212+
<li id="4464">In previous releases, DITAVAL <codeph>passthrough</codeph> actions in HTML5 transformations were
213+
not applied to top-level (root) <xmlelement>topic</xmlelement> elements, even though they worked correctly
214+
for nested topics. The root-topic template has been updated to generate the expected
215+
<codeph>data-<varname>attname</varname></codeph> passthrough attributes on the HTML5 <xmlelement
216+
>body</xmlelement> element.
217+
<xref href="https://github.com/dita-ot/dita-ot/issues/4464" format="html" scope="external">#4464</xref>,
218+
<xref href="https://github.com/dita-ot/dita-ot/issues/4639" format="html" scope="external">#4639</xref>
193219
</li>
194-
<li id="4488">DITAVAL "passthough" action does not work for profiling applied to an attribute group
220+
<li id="4488">DITAVAL <codeph>passthrough</codeph> actions were not being applied to profiling attribute
221+
groups in HTML5 output. For example, a value like <codeph>audience="llm(keep)"</codeph> would not generate
222+
the expected passthrough attribute, even when a matching <xmlelement>prop</xmlelement> rule was defined.
223+
Processing has been updated so passthrough attributes are created using the group name.
195224
<xref href="https://github.com/dita-ot/dita-ot/issues/4488" format="html" scope="external">#4488</xref>
196225
</li>
197-
<li id="4511">NullPointerException with --root-chunk-override=combine and xref in Dita 2.0 content
226+
<li id="4511">Using the <parmname>--root-chunk-override=combine</parmname> option with DITA 2.0 content that
227+
contained <xmlelement>xref</xmlelement> elements caused a <codeph>NullPointerException</codeph> during link
228+
rewriting. Chunk processing has been updated to handle cross-references correctly.
198229
<xref href="https://github.com/dita-ot/dita-ot/issues/4511" format="html" scope="external">#4511</xref>
199230
</li>
200-
<li id="4513">SAXParseException with --root-chunk-override=combine and table in Dita 2.0 content
201-
<xref href="https://github.com/dita-ot/dita-ot/issues/4513" format="html" scope="external">#4513</xref>
202-
</li>
203-
<li id="4639">support HTML5 attribute passthrough on root topic elements (#4464)
204-
<xref href="https://github.com/dita-ot/dita-ot/issues/4639" format="html" scope="external">#4639</xref>
231+
<li id="4513">Using the <parmname>--root-chunk-override=combine</parmname> option with DITA 2.0 content that
232+
contained tables caused a <codeph>SAXParseException</codeph> due to unbound namespace prefixes. The
233+
namespace prefix tracking has been fixed to ensure that internal attributes are correctly handled when links
234+
are inserted during chunk processing.
235+
<xref href="https://github.com/dita-ot/dita-ot/issues/4513" format="html" scope="external">#4513</xref>,
236+
<xref href="https://github.com/dita-ot/dita-ot/issues/4738" format="html" scope="external">#4738</xref>
205237
</li>
206-
<li id="4688">fix node executable path on Windows
238+
<li id="4688">The Gradle build configuration has been updated to correctly locate the Node.js executable path
239+
on Windows systems.
207240
<xref href="https://github.com/dita-ot/dita-ot/issues/4688" format="html" scope="external">#4688</xref>
208241
</li>
209-
<li id="4695">DITA 2.0: HTML5 ignores navtitle element
242+
<li id="4695">When using a DITA 2.0 map schema, the <xmlelement>navtitle</xmlelement> element within
243+
<xmlelement>topicref</xmlelement> was ignored, causing navigation entries to be suppressed or flattened in
244+
HTML5 output. The transformation now matches both the DITA 1.3 and DITA 2.0 class values for
245+
<xmlelement>navtitle</xmlelement>.
210246
<xref href="https://github.com/dita-ot/dita-ot/issues/4695" format="html" scope="external">#4695</xref>
211247
</li>
212-
<li id="4698">Fix DITA 2.0 root map chunk
248+
<li id="4698">Combine chunking for the root map in DITA 2.0 has been fixed.
213249
<xref href="https://github.com/dita-ot/dita-ot/issues/4698" format="html" scope="external">#4698</xref>
214250
</li>
215-
<li id="4705">Fix force unique filter attribute stack
216-
<xref href="https://github.com/dita-ot/dita-ot/issues/4705" format="html" scope="external">#4705</xref>
217-
</li>
218-
<li id="4706">Fix attribute stack bug
251+
<li id="4701">The attribute stack in the force-unique filter and merge-map parser modules was not being
252+
correctly maintained, which could cause attributes to be incorrectly applied during processing. The stack
253+
management has been fixed to ensure attributes are properly tracked.
254+
<xref href="https://github.com/dita-ot/dita-ot/issues/4705" format="html" scope="external">#4705</xref>,
219255
<xref href="https://github.com/dita-ot/dita-ot/issues/4706" format="html" scope="external">#4706</xref>
220256
</li>
221-
<li id="4733">Remove stale `args.logdir` reference from test code
257+
<li id="4733">A stale reference to the deprecated <parmname>args.logdir</parmname> parameter has been removed
258+
from test code. This parameter was deprecated in DITA-OT 2.5 and removed in 3.4.
222259
<xref href="https://github.com/dita-ot/dita-ot/issues/4733" format="html" scope="external">#4733</xref>
223260
</li>
224-
<li id="4738">Fix namespace prefix bug in move links
225-
<xref href="https://github.com/dita-ot/dita-ot/issues/4738" format="html" scope="external">#4738</xref>
226-
</li>
227261
</ul>
228262
</section>
229263

0 commit comments

Comments
 (0)