• 2022

    24.1
    Version 24.1 - March 10, 2022
  • 2021

    24.0
    Version 24.0 - October 18, 2021
  • 23.1
    Version 23.1 - March 4, 2021
  • 2020

    23.0
    Version 23.0 - November 19, 2020
  • 22.1
    Version 22.1 - May 19, 2020
  • 22.0
    Version 22.0 - February 12, 2020
  • 2019

    21.1
    Version 21.1 - May 23, 2019
  • 21.0
    Version 21.0 - February 22, 2019
  • 2018

    20.1
    Version 20.1 - June 15, 2018
  • 20.0
    Version 20.0 - March 16, 2018
  • 2017

  • 19.0
    Version 19.1 - September 29, 2017
    Version 19.0 - April 5, 2017
  • 2016

  • 18.0
    Version 18.1 - October 18, 2016
    Version 18.0 - April 21, 2016
  • 2015

  • 17.0
    Version 17.1 - October 20, 2015
    Version 17.0 - May 5, 2015
  • 2014

  • 16.0
    Version 16.1 - October 7, 2014
    Version 16.0 - May 20, 2014
  • 2013

  • 15.0
    Version 15.2 - January 22, 2014
    Version 15.1 - October 7, 2013
    Version 15.0 - June 7, 2013
  • 2012

  • 14.0
    Version 14.2 - February 13, 2013
    Version 14.1 - October 19, 2012
    Version 14.0 - June 27, 2012
  • 2011

  • 13.0
    Version 13.2 - January 12, 2012
    Version 13.1 - October 26, 2011
    Version 13.0 - August 29, 2011
  • 2010

    12.0
    Version 12.2 - May 19, 2011
    Version 12.1 - January 12, 2011
    Version 12.0 - September 14, 2010
  • 2009

  • 11.0
    Version 11.2 - March 16, 2010
    Version 11.1 - December 17, 2009
    Version 11.0 - October 9, 2009
  • 2008

    10.0
    Version 10.3 - June 29, 2009
    Version 10.2 - April 15, 2009
    Version 10.1 - February 25, 2009
    Version 10.0 - October 23, 2008
  • 2007

  • 9.0
    Version 9.3 - July 2, 2008
    Version 9.2 - May 9, 2008
    Version 9.1 - December 18, 2007
    Version 9.0 - November 2, 2007
  • 2006

    8.0
    Version 8.2 - May 7, 2007
    Version 8.1 - January 25, 2007
    Version 8.0 - November 20, 2006
  • 7.0
    Version 7.2 - June 6, 2006
    Version 7.1 - March 2, 2006
    Version 7.0 - January 13, 2006
  • 2005

  • 6.0
    Version 6.2 - September 19, 2005
    Version 6.1 - July 19, 2005
    Version 6.0 - May 22, 2005
  • 2004

    5.0
    Version 5.1 - January 18, 2005
    Version 5.0 - October 15, 2004
  • 4.0
    Version 4.2 - July 15, 2004
    Version 4.1 - June 10, 2004
    Version 4.0 - April 30, 2004
  • 3.0
    Version 3.1 - February 6, 2004
    Version 3.0 - January 14, 2004
  • 2003

  • 2.0
    Version 2.0.4 - September 19, 2003
    Version 2.0.3 - August 14, 2003
    Version 2.0.2 - June 9, 2003
    Version 2.0.1 - May 15, 2003
    Version 2.0 - April 2, 2003
  • 2002

  • 1.0
    Version 1.2.4 - December 17, 2002
    Version 1.2.3 - November 27, 2002
    Version 1.2.2 - October 22, 2002
    Version 1.2.1 - September 27, 2002
    Version 1.2 - June 27, 2002
    Version 1.1.9 - June 15, 2002
    Version 1.1.8 - June 5, 2002
    Version 1.1.7 - May 27, 2002
    Version 1.1.6 - May 24, 2002
    Version 1.1.5 - May 20, 2002
    Version 1.1 - May 15, 2002
    Version 1.0 - April 15, 2002

What's New in Oxygen XML Editor 24.1

March 10, 2022

Related version: 24.0    

Oxygen XML Editor version 24.1 is an incremental release for the industry's most advanced bundle of tools used by technical writers, developers, collaborators, and publishers everywhere. The focus of this release was to expand upon the new features and improvements that were added in version 24.0.

This release includes productivity improvements for DITA authors and publishers. The innovative JSON Schema Design mode that was recently introduced in version 24.0 received a lot of further enhancements. Some of the existing JSON tools were also improved. Add-ons were a major focus of this release, with many of the most popular ones receiving lots of updates (including the Git Client, Batch Documents Converter, OpenAPI Documentation Generator, OpenAPI Tester, and more). An interesting new Smart Autocomplete add-on is also available that helps writers create content by providing text completions. XSLT and XQuery transformations and debugging features were enhanced with an update to the Saxon engine, and this release includes various other component updates, bug fixes, and security enhancements.

There are changes in:

DITA Authoring

Move and Rename Non-DITA Resources

Non-DITA resources that are referenced in a DITA map can be renamed directly in the DITA Maps Manager by using the Move or Rename contextual menu actions. You also have the option to update all the references of the resources during the move/rename operation.

Performance Improved When Opening DITA Maps with Content Expanded

Performance was improved when opening a DITA map with all of the referenced topic content expanded and editable. It now takes less time to open the map, even when it contains a large number of referenced topics.

DITA Publishing

DITA Open Toolkit Updates and Improvements

The DITA Open Toolkit version that is bundled with Oxygen has been updated to version 3.7.0. Lots of small extra bug fixes are also part of the updated publishing engine.

Absolute Positioning Now Supported

For CSS-based PDF transformations, the processor now supports absolute positions for inline elements. For example, you can now define custom CSS rules to display an image in a certain absolute position within the document or paragraph.

Replace Media with Links

For CSS-based PDF transformations, you can display media objects with an external link instead of graphic by using the new (show.media.as.link) transformation parameter.

Sort Glossary Alphabetically and Grouped by First Letter

It is now possible to have the glossary entries sorted alphabetically and grouped by the first letter of the word. This can be done for CSS-based PDF transformations by setting the new sort.and.group.glossentries transformation parameter to yes. By default, they are inserted based upon the document order.

JSON Schema Design Mode

JSON Schema Design mode Drag and Drop Support

Now you can design your JSON Schema in the Design mode by using drag-and-drop support. You can move or reorder components just by dragging and dropping into the correct location. Oxygen will display a connector to help you visualize the drop location and will highlight the connector with red when the component is not allowed in that particular location.
JSON Schema Design mode Drag and Drop Support

New Palette View Makes Schema Building Very Easy in JSON Schema Design Mode

The newly implemented Palette view is designed to offer quick access to JSON Schema components and to improve the usability of the JSON Schema diagram builder. The Palette can be used to easily drag and drop various components into the JSON Schema diagram built in the Design mode.

New Actions to Mark Properties as Required or Optional

New contextual menu actions were added in the JSON schema Design mode to make it very easy to mark a property as being either required or optional in the parent object. By default, the defined properties are not required in the JSON schema. However, you can set a list of required properties in the required keyword value.

Convert Between Object Schema and Boolean Schema

New contextual menu actions are available in the JSON schema Design mode that give you the possibility to convert the object schema for a property or definition into a boolean schema with the value of true or false, and vice versa.

Extract Definition

A new Extract Definition action was added within the Refactoring sub-menu in the contextual menu of JSON schema Design mode. The action allows you to extract a definition into the global definitions and reference it. It can be used to extract the definition of a property as a global definition, or extract a local definition globally.

Go to Definition

A new Go to Definition contextual menu action was added in the JSON schema Design mode that enables you to quickly navigate to the referenced schema component.

Content Completion Now Supported for In-place Editing

The content completion assistant is now available for in-place editing within the JSON schema Design mode. For example, when editing properties, you can use Ctrl+Space to invoke the content completion window and the proposals are offered based on the defined JSON schema, according to the version used.

JSON Tools

Mark Properties to be Required in JSON Schema Generator Tool

When using the JSON Schema Generator tool, an option (Make all properties required) is now available to specify that all properties be required in the generated schema.
Mark Properties to be Required in JSON Schema Generator Tool

Control the Conversion of Empty Elements in the XML to JSON Converter

A new option (Covert empty elements to structures of type) was added in the XML to JSON converter dialog box that allows you to choose the data type that empty elements will be converted to during the conversion. The possible values are object, string, or array.

Diagrams Generated for References Schemas in JSON Schema Documentation

If you choose to display diagrams in the generated documentation when using the JSON Schema Documentation tool, diagrams are now also shown for components from files that are referenced in the schema document.

Added Hyperlinks for Diagrams in JSON Schema Documentation

When using the JSON Schema Documentation tool, you can choose to include hyperlinks for the diagrams displayed in the generated documentation. Each hyperlink will navigate to the particular component.

OpenAPI

OpenAPI Tester Tool

A new OpenAPI Tester tool is available to help you to easily inspect OpenAPI request responses and to ensure they work as expected. It can be used for OpenAPI 3.0 in JSON or YAML format. The tool is available in the Tools->JSON Tools menu. It requires an add-on to be installed but you have the option to automatically install it the first time you select the tool.

OpenAPI Tester Tool

OpenAPI Documentation Generator

A new OpenAPI Documentation generator tool is available to help you to easily generate full documentation for OpenAPI components in HTML format, including comprehensive annotations and cross references. The documentation is presented in a visual diagram style with various sections, hyperlinks, and filtering options. The tool is available in the Tools->Generate Documentation menu. It requires an add-on to be installed but you have the option to automatically install it the first time you select the tool. Some example can be found here.

XSLT/XQuery

XSLT Transformation and Debugging

The Saxon built-in XSLT processor used for XSLT transformations and debugging has been updated to version 10.6. The Saxon 10 release is currently considered as the most stable and reliable release.
XSLT Transformation and Debugging

XQuery Transformation and Debugging

Updated the Saxon XQuery processor used for XQuery transformations and debugging to version 10.6.

New Option Added in the Compile XSLT for Saxon Tool

A new option was added in the Compile XSLT Stylesheet for Saxon dialog box that allows you to set the default namespace for unprefixed element names. It can be used to control the -ns (uri|##any|##html5) Saxon parameter that defines the handling of unprefixed element names that appear as name tests in path expressions and match patterns in the stylesheet.

Saxon XSLT and XQuery Transformer Add-on for Saxon version 11.2

A new Saxon transformer add-on is available that adds support for the Saxon transformer version 11.2. This allows you to validate and transform XSLT and XQuery documents with the Saxon 11.2 engine.

Updated Saxon 10 XSLT and XQuery Transformer Add-on to Version 10.7

The Saxon 10 transformer add-on was updated to version 10.7. This allows you to validate and transform XSLT and XQuery documents with the Saxon 10.7 engine.

Markdown

Added Support for Underlining Content

The Markdown editor now supports the ++abc++ syntax that is used for underlining content.

Security

Removed Apache Log4j Dependency

Removed the dependency on Apache Log4j to help prevent security vulnerabilities. The SLF4j API and Logback libraries are now used instead.

Add-ons

There are available a variety of add-ons for Oxygen that extend the functionality of the application. Many of the existing add-ons were updated and improved, while a new Smart Autocomplete experimental add-on is available that helps writers create content by providing text completions.

Smart Autocomplete Add-on (Experimental) Introduced

A new Smart Autocomplete experimental add-on is available that helps writers create content by providing text completions. Once the add-on is installed, a side-view becomes available where you can access its features. You can choose between a Built-in or OpenAI engine for generating the proposals for text completion. The Built-in engine analyzes all XML, HTML, or Markdown files in a project and then offers completion proposals when editing text content within the project. The OpenAI engine offers the ability to use language models provided by the OpenAI company. This engine not only offers text completion proposals, but it also contributes various configurable actions that can be used to transform the selected text in the editor, and it allows you to create your own language models by using a process called fine tuning. Some examples of the actions that are available to transform the selected text include grammar corrections, paraphrasing, translating content into other languages, adding markup, creating ordered lists, and many more.

For more details, see the Smart Autocomplete Add-on section in our user guide.

Add-on Documentation Structure Improved

All of the add-ons from the official Oxygen repository are now divided into categories in the user guide (Add-ons Chapter) to make it easier to find the types of add-ons that you want to read about.

Quick Install Button Added

There is a new easier installation method for all of the add-ons. The user guide topics now have a new Install button in a Quick Installation section that can simply be dragged and dropped into the main editor in Oxygen to initiate the installation process.

Git Client Improvements

Various improvements were made to the Git Client add-on:
  • The History view now includes a new revision graph that helps you to understand how commits connect with one another.
  • The Stash dialog box now has a column that shows the creation time for each stash.
  • A new Checkout action was added to the contextual menu of the History view. It checks out a branch at a specific commit (either in detached head form or by creating a new branch at that commit).
  • The Git Staging view toolbar was simplified to only display the most common actions, while all actions are easily accessible in a new ellipsis (three vertical dots) menu. This menu also includes some new actions. For example, you now have the ability to manage remote repositories (add, edit or delete), track a remote branch for the current branch, or to edit the repository's configuration file. Most of the actions are also available in a new Git menu that was added in the main menu bar.
  • Performance was improved by optimizing the process of checking the status of the repository.
  • Integrated various bug fixes, component updates, and performance enhancements.

For a complete list of updates added in the Git Client, see https://github.com/oxygenxml/oxygen-git-plugin/releases.

Git Client Improvements

Batch Documents Converter Improvements

Various improvements were made to the Batch Documents Converter add-on:
  • You can now convert HTML documents exported from Atlassian Confluence into DITA.
  • You can now convert one or multiple DocBook documents into DITA and an option called Create DITA maps from DocBook documents containing multiple sections can be used to convert all sections into individual DITA topics and referenced in a new DITA map.
  • A new preferences page was added to provide options for configuring the mappings between elements for certain types of conversions. For example, you can use the Word styles mapping option to customize the mapping between Word elements and styles to the corresponding HTML elements when converting from Word to XHTML, DITA, or DocBook.
  • A better handling of tables that contain cell spans when converting Markdown documents to DITA.
  • Various small bug fixes and conversion improvements.

For a complete list of updates added in the Batch Documents Converter, see https://github.com/oxygenxml/oxygen-resources-converter/releases.

OpenAPI Tester Add-on Improvements

The OpenAPI Tester add-on was updated to version 1.1 and its improvements include:

  • You can now use the testing tool for OpenAPI documents represented in YAML format, as well as in JSON format.
  • Added basic support for the OpenAPI 3.1.0 Specification (except for webhooks).
  • The layout of the view was improved.
  • Various bug fixes and improvements.

DITA Prolog Updater Add-on Improvements

Various improvements were made to the DITA Prolog Updater add-on:

  • A new option was added for controlling where to store the options from the Add-on preferences page (either in global options or in project-level options).
  • Fixed an issue where the prolog element was inserted in documents that do not allow it.

XSpec Helper View Add-on Now Bundles XSpec 2.2.4

The XSpec Helper View add-on was updated to include XSpec version 2.2.4.

Other

New Setting To Control Initial View Mode for Tracked Changes in the Author Visual Editing Mode

A new Initial display mode setting was added in the Preferences->Editor / Edit Modes / Author / Review preferences page to control the initial display mode for tracked changes in the Author visual editing mode.

New Option to Return the Results of a Search as a PDF

A new Include the contents of these binary files option was added in the Preferences->Open/Find Resource preferences page and it returns the results of a search in the Open/Find Resource dialog box/view as a PDF, if the PDF contains the searched text.

Component Updates

DITA Open Toolkit Version 3.7.0

Updated the DITA Open Toolkit version that is bundled with Oxygen to version 3.7.0.

macOS 12 (Monterey)

Oxygen has been fully tested on macOS 12 (Monterey), which is now officially supported.

OpenJDK 17.0.2

Some of the installation kits bundle OpenJDK as the Java Runtime Environment and this was updated to version 17.0.2.

Jackson 2.12.6

Updated the third-party Jackson libraries to version 2.12.6 to fix a security vulnerability.

Xerces 2.12.2

Updated the Xerces library to version 2.12.2.

XSpec 2.2.4

Updated the built-in XSpec framework to version 2.2.4.

Official Support for eXist-db Version 6.0.1

Oxygen has been tested and officially supports eXist-db version 6.0.1.

Calabash XProc 1.3.2-100

Updated the Calabash engine to version 1.3.2-100. The bundled Calabash XProc engine is now integrated with the Saxon 10 library.

Eclipse 4.22

Updated the Eclipse plugin to support version 4.2.

Scripting

The all platforms distribution of Oxygen is bundled with a scripts sub-folder that contains scripts for automating and running various utilities from a command line interface. To run any of these scripts, you need to purchase a scripting license.

The main focus for this release was various additions and improvements for the Batch Converter script.

Use Custom Settings File for Batch Converter Script

When using the Batch Converter script, you can use a new argument (-cs converterSettingsFile) to specify a file that contains settings for the conversion. It can be an .xpr file that contains project options or an XML file that contains global options.

Batch Converter Script Now Has Option for DocBook to DITA Conversions

You can now convert HTML documents exported from DocBook into DITA using the Batch Converter script.

Batch Converter Script Now Has Option for Confluence to DITA Conversions

You can now convert HTML documents exported from Atlassian Confluence into DITA using the Batch Converter script.

Batch Converter Script - Other Improvements

Other improvements made to the Batch Converter script include:

  • A better handling of tables that contain cell spans when converting Markdown documents to DITA.
  • Various small bug fixes and conversion improvements.