What's New in Oxygen XML Publishing Engine 22.1

May 19, 2020

Version 22.1 of the Oxygen Publishing Engine provides more improvements and new customization possibilities for WebHelp Responsive and DITA to CSS-based PDF output.

Oxygen XML WebHelp provides a few fixes and updates.

DITA to CSS-based PDF transformations provide more customization options, such as styling embedded SVG, controlling the title and captions for tables, showing tracked changes and comments as change bars, better handling of white space, hyphenation, and line wrapping, as well as improved error reporting to help you troubleshoot issues.

There are changes in:

WebHelp Output

Improved Integration with Oxygen Feedback

The Oxygen Feedback offers a modern comment management platform that provides a simple and efficient way for your community to interact and offer you feedback. One of its design goals was to enable user feedback on the published WebHelp output and allow you to integrate it back into the documentation source. The WebHelp was updated to generate additional information that makes it easier to precisely locate the original source document that corresponds to any particular comment added in the output. This is helpful when you use an easy-to-install add-on to integrate Oxygen Feedback with Oxygen XML Editor or Oxygen XML Author.

Bootstrap Version 4.4.1

The bundled version of Bootstrap was updated to 4.4.1.

Bug Fixes and Security Updates

As a maintenance build, various bug fixes and security updates were implemented.

PDF Output

Improved Error Reporting

When publishing to CSS-based PDF output, errors detected by the Chemistry processor are now reported in the Results panel along with the other DITA-related errors. The additional types of errors include font issues, text bleeding, and more.

Show Tracked Changes and Comments as Change Bars

A new parameter called show.changes.and.comments.as.changebars can be used to control whether or not tracked changes and comments are shown as change bars in the PDF output. When the parameter is set to yes (default) and the show.changes.and.comments parameter is also set to yes, the comments and tracked changes are shown as change bars.

Show Change Tracking Content as Sticky Note Annotations

A new parameter called show.changed.text.in.pdf.sticky.notes.content is available for controlling what information about tracked changes is presented as sticky note annotations. If it is set to yes, the content of insertion or deletion changes is shown in the annotation, while only the inserted and deleted labels are show if the parameter is set to no.

Control the Title Rendering for Tables

Two new parameters were added for CSS-based PDF transformations that control how table titles are presented. The table.title.placement parameter can be used to control whether the title appears at the top or bottom of the table, and the table.title.repeat parameter can be used to specify whether or not the table caption should be repeated when the table spans on multiple pages.

Control Embedded SVG Customization

The rendering of an SVG (which is basically an XML) can be customized with CSS. A new parameter called use.css.for.embedded.svg can be used to specify whether or not custom CSS is applied to embedded SVG elements in CSS-based PDF transformations.

Improved Line Breaks Handling in Codeblocks

break-word is now the default value of the overflow-wrap CSS property for <codeblock> elements. This will help prevent problems with content in code blocks bleeding off the page.

Better Support for Hyphenated and Wrapped Words on Search and Copy/Paste

The behavior of search and copy/paste operations for hyphenated and wrapped text now takes all spaces into account, helping to prevent unwanted word combinations.

Improved Handling of Change Bars

Duplicate change bars painted on parent and child blocks have been removed. Change bars are also placed in better locations within the page, avoiding text overlaps.