Oxygen XML Editor Enterprise V25.0

DITA Authoring

• Modified Maps in the DITA Maps Manager are Automatically Saved - By default, local DITA maps that are edited in the DITA Maps Manager are automatically saved whenever a modification is made.
• Improvements for Working With DITA-Compatible Resources - Various improvements have been added to enhance your experience when working with DITA-compatible resources (Microsoft Word, Microsoft Excel, OpenAPI, HTML and Markdown) that are referenced in DITA maps and dynamically published:
  • Added the possibility to insert a topic reference to a DITA-compatible resource in the DITA Maps Manager.
  • The title for each referenced resource is now presented in the DITA Maps Manager.
  • When inserting topic references, cross references, or content references to content inside DITA-compatible documents, the insertion dialog box now presents a list of DITA-specific IDs from the target document.
  • Utilizing the Validate and Check for Completeness action, DITA-compatible documents that are referenced in the DITA map are now converted to DITA topics in the background and validated the same as any other DITA topic.
  • When transforming DITA maps that have DITA-compatible documents referenced, the transformation now converts the documents to normal DITA output on the fly.
• Expand Map and Topic References On Demand - If the Display referenced content option is not selected in the Author preferences page, when a DITA map is opened in the main editor area in the Author visual editing mode, references to topics or sub-maps can now be expanded on demand by clicking the small expansion button located on each element. If the Allow referenced content to be edited option is selected, referenced topics and sub-maps that are expanded on-demand can also be edited directly.
• Expand Content References On Demand - When opening a topic in the main editor area in the Author visual editing mode, content references and content key references can now be expanded on demand by clicking the small expansion button located on each element (in the main editor area).
• Easy Access to DITA Metrics Report - A new Generate Metrics Report action has been added to the toolbar in the DITA Maps Manager and in the DITA Maps menu. It generates a metrics report that contains useful statistics for the current DITA map (e.g. the number of maps/topics, content reuse percentages, the number of elements/words/characters, processing instructions, external links, and more).
• Define Conditional Profiling Attribute Groups in a Subject Scheme Map - It is now possible to contribute conditional profiling attribute groups by defining them in a subject scheme map.
• New Action in DITA Reusable Components View Makes it Easy to Insert Images Inside Figures - In the contextual menu of the DITA Reusable Components view, a new action (Insert as Figure) has been added that saves you some steps when inserting images inside figures.
• Performance Improvements When Opening DITA Maps - Various speed improvements have been implemented for opening large DITA maps in the DITA Maps Manager or opening large maps in the editor with all the referenced topics resolved.
• Enable Inline Insertion Actions in DITA Maps - A new Inline insertion actions CSS style is now available in the Styles drop-down toolbar menu when editing a DITA map in Author mode that makes it easier to insert new topic references.
• Improvements for Editing DITA Open Toolkit Project files - All 'includes' now appear expanded in-place and each deliverable has a play button that can be used to publish it individually.
• Drag and Drop Resource Improvements in the Text Editing Mode - When topic references from the DITA Maps Manager view are dragged and dropped inside a DITA topic in Text editing mode, specific DITA elements that contain either direct or key references to the resources are now properly inserted.
• Set the Type for Notes Using a New In-place Action - When a DITA topic contains a <note> element, an in-place pop-up action located next to the note type icon can now be used to easily change the note type.
• Set the Syntax Highlight Language for Codeblocks Using a New In-place Action - When a DITA topic contains a <codeblock> element, an in-place pop-up action can now be used to easily change or set a syntax highlight language (@outputclass attribute) for the code block content.
• DITA Preview for Markdown Documents More Permissive - When editing Markdown documents, the DITA preview pane is now more permissive, allowing documents that start with a high heading level or where heading levels increase by more than one unit (the heading level skips one or more levels).

DITA Map Validation

• Report Related Links Whose Target Topic is Not Referenced in the DITA Map - The DITA Maps Manager view's Validate and check for completeness action now reports related links defined in relationship tables whose target topics are not referenced in the DITA map.
• Report Validation Errors for Relax NG based DITA Topics - The Validate and Check for Completeness action has been improved to report validation errors according to the schema in Relax NG-based DITA topics even when the Batch validate referenced DITA resources option is not selected.

DITA Publishing

• Dynamically Convert OpenAPI Documents to DITA During Publishing - The Dynamic Non-DITA Resource to DITA Converter now includes the option to convert OpenAPI documents (in either JSON or YAML format) to DITA during the publishing process.
• Generate Google Structured Data - You can now generate Google Structured Data in DITA WebHelp Responsive output. Google uses structured data to better understand the contents of the page and display special search results in a Google Search.
• Improved Publishing Speed - The speed of DITA transformations has been improved when publishing from an Oxygen kit bundled with Java 17, or when using the Oxygen Publishing Engine from the command line using Java 9 or newer.
• Syntax Highlights in Codeblocks Now Supported For New Content Types - Syntax highlights now appear in the output when publishing DITA <codeblock> elements that contain YAML, Microsoft PowerShell, DTD, or CMD (Microsoft Windows-style command script) content.
• Default Validation Now Works on RNG-based Topics and Maps - By default, the publishing engine now reports errors if RNG-based topics or maps are invalid according to the associated schema.
• Publish All Deliverables for a DITA OT Project File in Author Mode - When a DITA Open Toolkit project file is open in Author mode, there is now a play button next to the project file name that can be used to publish all deliverables specified in the file.
• Make Documents PDF/A-Compliant - For CSS-based PDF transformations, a new pdf.archiving.mode transformation parameter can now be used to make PDF documents archive-able. The possible values are: PDF/A-1a, PDF/A-1b, PDF/A-2a, PDF/A-2b, PDF/A-2u, PDF/A-3a, PDF/A-3b, PDF/A-3u.
• Filter Glossary to Show Only Referenced Entries in PDF Output - For CSS-based PDF output, a new filter.unused.glossentries parameter can now be set to yes to filter the glossary to only display referenced glossary entries in the output. If the parameter is set to no (the default), all glossary entries are displayed.
• Scaling in Image Maps Improved - When working with image maps, adding the @scale attribute on the <imagemap> element now scales the image and its areas in both WebHelp and PDF output.

DITA Questions/Answers

• New Action to Insert Intent Question Within DITA Topic - A new action named Insert Intent Question is now available in various menus (in the Insert submenus within the DITA menu, contextual menu, and a drop-down menu on the toolbar) and it can be used to insert a DITA intent question (inside the prolog section). The action inserts a question (that could be asked by a user) and its answer is found in the current topic.
• New Questions and Answers DITA Topic Type - Added the ability to create a new DITA topic type named Questions and Answers (Relax NG). It is useful for creating frequently asked question documents that contain multiple question/answer groups. Such documents are used during the publishing process for creating Google Structured Content metadata.

Author Visual Editing

• Smart Editing in Author Mode Improved - The smart editing mechanism in Author mode has been improved so that when you start typing in a location where text is not allowed, Oxygen will search for the closest applicable context that accepts text.
• Expand xi:include References On Demand - A Display referenced content option found in the Author preferences page can now be deselected to make it possible for xi:includes to be expanded on demand by clicking a small expansion button that is located next to each element that contains such a reference in the main editor area.
• Support for Custom Values for the 'list-style-type' CSS Property - The Author visual editing mode now renders custom string values for the list-style-type CSS property defined in the CSS for list items.

JSON

• JSON Schema Version 2020-12 Support in Oxygen - Support has been added for the latest JSON schema version 2020-12. This includes:
  • Validating JSON schemas version 2020-12 accordingly to the specification.
  • Content completion proposals when editing JSON schemas version 2020-12.
  • Validating JSON/YAML documents against a JSON schema version 2020-12.
  • Converting older JSON schemas to version 2020-12.
  • A specific framework that will allow you to edit JSON schema documents in Author mode.
• JSON Schema in Document Type Configuration - You can now associate a JSON schema with a set of documents by defining it in the Document Type configuration dialog box.
• New Version for JSON Schema Documentation Generator Tool - This tool (available after installing the add-on) includes support for generating documentation for JSON schema version 2020-12 and 2019-09, as well as various fixes and improvements.
• JSON Instance Generator Tool Now Supports JSON Schema Version 2020-12 and 2019-09 - This means that it now handles properties such as: $defs, minContains, maxContains, prefixItems, dependentSchemas, unevaluatedItems, unevaluatedProperties.
• Generate JSON Schema Tool Now Supports JSON Schema Version 2020-12 - You can now generate a JSON schema version 2020-12 from a JSON instance.
• New JSON Schema Converter Tool - A new Convert JSON Schema action is now available. It provides a simple tool for converting older versions of JSON schema documents to the latest versions (Draft 2019-09 or Draft 2020-12).
• Content Completion Improved for Pattern Properties - The content completion support has been improved for JSON documents based on the JSON schema when pattern properties are used. Oxygen now determines the definition to be used in the content completion even if the pattern property does not match the property exactly.
• Multi-Line Values Now Allowed in Author Mode - Multi-line values are now allowed and preserved when editing JSON schema documents in the Author visual editing mode.

JSON Schema Design

• JSON Schema Version 2019-09 and 2020-12 Now Supported - Support has been added for the latest JSON schema versions (Draft 2019-09 and Draft 2020-12) in Design mode. This includes automatic detection of the version, validation, contextual menu actions have been updated with the new components, and the Palette view has been updated to include the new components.
• Search and Refactoring Actions Added in JSON Schema Design Mode - New search and refactoring actions have been added in the contextual menu of the JSON schema Design mode to improve the handling of JSON definition type components. The new actions are:
  • Search References - Searches all references of the selected definition in a scope determined by the schemas referenced in the file and the main schemas declared in validation scenarios.
  • Search References in - Searches for all references of the selected definition in a defined scope.
  • Search Occurrences in file - Searches all occurrences of the currently selected definition in the current file.
  • Rename Component in - Allows you to rename the selected component name.
  • Extract definition in another file - Extracts a definition to a new file.
• JSON Schemas Now Support using a Reference ($ref) in Conjunction with Other Keywords - When building a JSON schema, you can now use a reference ($ref) in conjunction with other type-specific keywords (such as properties or items) for stricter validation.
• Containers Now Automatically Created When Dragging From Palette View to JSON Schema Design Editor - When dragging and dropping a property/definition or pattern property from the Palette view to the JSON schema editor, if the component does not have the corresponding group component (properties, definitions, patternProperties), it will now automatically be created.

OpenAPI/AsyncAPI/JSON-LD

• Edit and Validate OpenAPI Documents - Oxygen now offers built-in support for automatic validation, content completion, and editing OpenAPI documents (versions 2.0, 3.0, and 3.1) in Text or Author mode.
• Edit and Validate AsyncAPI Documents - Specific support for AsyncAPI documents is now provided with the addition of a new framework. This includes support for content completion, automatic validation, and editing AsyncAPI documents in Text or Author mode. New document templates are also available for AsyncAPI 1.x and AsyncAPI 2.x documents.
• Support for JSON-LD Documents - A specialized framework has been added for working with JSON-LD files. This support includes automatic validation, new document templates, the content completion mechanism offers valid proposals for these types of documents, and when editing these types of documents, you have access to the various editing features and actions that are available for normal JSON documents.
• New Version for OpenAPI Documentation Generator - The OpenAPI Documentation Generator tool can be used for generating documentation for OpenAPI documents in HTML format, including annotations and cross references. Various improvements have been added in this release:
  • Redesign - The documentation output has a new design to make it easier to read and understand the OpenAPI specification.
  • OpenAPI 3.1 Support - Support has been added to generate documentation for OpenAPI 3.1 documents.
  • Supports for YAML Files - The input file used for generating the documentation can be in either YAML or JSON format.
• New Version for OpenAPI Tester - Various improvements have been made to the OpenAPI Tester add-on:
  • A new Run OpenAPI Test Scenario tool is available in the Tools->JSON Tools menu. It provides you with the capability of running a test suite for an OpenAPI document.
  • Syntax highlights are now rendered in the Request body and Response area to help make the code more readable.
  • Undo/redo support has been added in the Request body and Response area.
• New OpenAPI Test Scenario Framework - A new framework for OpenAPI test scenario files has been added. This helps you to create and edit test scenarios more easily by offering automatic validation, content completion, and a visual editing interface in the Author visual editing mode.
• New Author Mode CSS Style to Render Markdown Syntax Highlights for OpenAPI and AsyncAPI Documents - When editing OpenAPI or AsyncAPI documents in Author mode, a new Markdown Syntax Highlight CSS style can now be selected from the Styles drop-down menu (available on the toolbar). It makes it easier for you to visualize descriptions with Markdown style syntax highlights.

XSLT/XQuery

• XSLT Transformation and Debugging - The Saxon built-in XSLT processor used for XSLT transformations and debugging has been updated to version 11.4.
• XQuery Transformation and Debugging - Updated the Saxon XQuery processor used for XQuery transformations and debugging to version 11.4.
• New Saxon Extension Functions - Saxon added more extension functions that are now supported and included in the list of proposals of the content completion assistant.
• Dropped Saxon Functions - The saxon:path() function has been dropped, but you can use the standard fn:path() function instead.
• Syntax Highlights for xsl:package Improved - Syntax highlights are now rendered in text value templates when used inside the xsl:package element.
• Template Priority Added in Index for XSLT Stylesheet Documentation Generator - When using the XSLT Stylesheet Documentation generator tool, the priority of the template is now generated in the template reference from the index (that is also sorted by priority).
• XSLT 4.0 Support - Validation and transformation support has been added for XSLT 4.0 documents. Also, the content completion assistant now includes proposals for XSLT 4.0 elements, attributes, and XPath functions.

Add-ons

• Semantic Versioning For Add-ons - The version defined for an add-on in the XML descriptor file can now have either the usual MAJOR.MINOR.PATCH form or the semantic version form (MAJOR.MINOR.PATCH-PRE_RELEASED_VERSION), making it easier for developers to create add-on builds for pre-release versions.
• Git Client Improvements
  • A new Validate each file before committing option has been added in the Git Client preferences page. Selecting this option enables automatic validation of each file before each commit.
  • A new Validate all files from the project's "Main Files" folder before pushing option has been added in the Git Client preferences page. Selecting this option enables automatic validation of the files located in the Main Files folder before the push operation processes.
  • The integrated JGit library has been upgraded to version 6.3, which brings support for ssh-agent forwarding.
• Batch Documents Converter Improvements
  • You can now convert JSON or YAML files that use and conform to the OpenAPI specification (versions 2.0, 3.0, or 3.1) to DITA documents and there is a Create DITA maps from OpenAPI documents option that can be selected to instruct the converter to split the documents into separate topics that are referenced in a DITA map.
  • Word to DITA or HTML conversion improvements:
    • The Word styles mapping configuration has been improved by inheriting the style configuration of the custom style from the base style.
    • SVG images embedded in Word documents are now preserved as SVG.
    • IDs that result from image and table bookmarks are now handled better to find the correct location.
    • IDs generation has been improved for topics and sections by using the text from headings.
    • Handling of tables has been improved by preserving header row information during the conversion when converting Word to DITA or HTML.
  • For HTML to DITA conversions:
    • Conversion of object elements from HTML has been improved by adding a proper @outputclass attribute in the DITA result.
    • Added an option in the conversion dialog box that allows you to decide whether or not the <div> elements will be ignored.
  • For Markdown to DITA conversions, support has been added for Markdown abbreviations.
  • For HTML to XHTML conversions, the formatting of <pre> elements is now prevented.
• Terminology Checker Improvements - Various improvements have been added to the Terminology Checker add-on:
  • XPath Context - You can now define simple XPath expressions for particular defined rules to match or skip specific elements.
  • Part of Speech Tagging - When scanning for terminology problems, the problem is now presented only if the term's part of speech matches the one specified in the defined rule (available only for the English language).
  • Phases - In the terminology configuration file, you can now set the phase in which incorrect terms are detected (editing/validation/always). Performance improvements have also been implemented when checking files.
  • Load Terms Provided by Other Add-ons - Any Oxygen add-on (plugin) can now contribute terminology files to be used by the Terminology Checker. The contributed terminology files will be loaded and used if the contributor add-on is enabled.

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.
  • New Command Line Launcher for Validating Files or Directories - It is now possible to validate files or directories from a command line interface. You can check that your documents are valid from an integration server and you can generate reports in several formats (text, XML, JSON, or an HTML visual format).
    • You can specify a certain schema file to validate against.
    • You can validate using the schema(s) that are internally associated within files.
    • You can validate using the default Oxygen validation scenarios for respective file types.
    • You can specify a validation scenario name to be referenced from either a scenarios file or a project file.
  • Batch Convert OpenAPI Documents to DITA - The Batch Converter script now includes the option to convert multiple documents from OpenAPI to DITA.

Other

• Syntax Highlights in DocBook 'programlisting' Element Now Supported For New Content Types - Syntax highlights now appear in Docbook-based WebHelp Classic output when publishing <programlisting> elements that contain JSON, XQuery, YAML, PowerShell, DTD, or CMD (Windows-style command script) content.
• Basic Editing Support and Syntax Highlights Added for PowerShell Files - Basic editing support and syntax highlights are now provided for working with PowerShell files in Oxygen.
• Folders can be Added to the Main Files Directory - Normal folders can now be added to the Main Files directory when the Main Files Support is enabled.
• Control Indentation in Code Blocks - It is now easier to add indentation in code blocks by using the Tab or Shift+Tab keyboard shortcuts.
• XPath in Files Speed Improvements - The speed for the XPath in Files mechanism has been improved when running XPath over XML documents with associated DTDs, XML Schema, or Relax NG Schemas.

Component Updates

• Java 8 is no longer officially supported. Java 11 is now the minimum officially supported version.
• The Windows 11 operating system is now officially supported.
• The version of OpenJDK that is bundled with the installation kits for providing the Java Runtime Environment has been updated to version 17.0.4.1 from Eclipse Adoptium.
• The OpenJDK distribution of Oxygen for Apple macOS is now universal, as the same distribution now runs on both Intel Macs and Apple Silicon Macs.
• The Windows ZIP distribution of Oxygen XML Editor/Author/Developer now bundles the 64-bit version of the OpenJDK (17+) JRE. Previously, the Java 8u202 32-bit version was bundled.
• Updated the Eclipse plugin to support version 4.25.
• The Eclipse plugin now requires a minimum of Eclipse version 4.5.
• Support for using MathFlow when rendering and editing MathML equations in the Author visual editing mode is now officially deprecated. It will be replaced soon by a new integration with MathType, developed by Wiris.
• The DITA Open Toolkit version that is bundled with Oxygen has been updated to version 3.7.3.
• Updated the bundled TEI schemas to version 4.4.0.
• Updated the bundled TEI XSLT stylesheets to version 7.53.0.
• Updated the Apache FOP library to version 2.7.
• Updated the Apache Batik toolkit to version 1.15.
• Updated the Calabash engine to version 1.5.1-110.
• Updated the JSON Schema Validator library from Everit to version 1.14.1.
• Updated the third-party Jackson libraries to version 2.13.2 to help prevent vulnerability issues. Specifically, the jackson-annotations, jackson-core, and jackson-dataformat-yaml libraries have been updated to version 2.13.2 and the jackson-databind library has beenupdated to version 2.13.2.2.
• Updated the JSON-Java (org.json) package to version 20220320.
• Updated the built-in Saxon processor that is used for XSLT and XQuery transformations and debugging to version 11.4.
• Updated the XML Resolver component to version 4.5.0.
• Updated the saxon-sql library to version 11.4.
• The Saxon 10 transformer add-on has been updated to version 10.8. This allows you to validate and transform XSLT and XQuery documents with the Saxon 10.8 engine.
• Updated the Xerces XPath 2.0 processor to version 1.2.1.
• Updated the Mozilla Rhino JavaScript engine to the latest stable 1.7.14 version.
• The XProc Calabash engine has been updated to version 1.5.0 for Saxon 11.
• The SnakeYAML library has been updated to version 1.31.

API

• Display Syntax Highlights for Various Code Languages - A new API method (OxygenUIComponentsFactory.createTextArea()) has been added for creating a custom Swing JTextArea-based component that can be used to display syntax highlights for various code languages. The OxygenUIComponentsFactory.changeContentType() method can be used to change the syntax highlight type for a previously created text area.
• Validate Certain XML Resources - A new addition is now represented by the PluginWorkspace.getValidationUtilAccess() API method that can be used to validate and return validation problems for an arbitrary list of resources.
• Obtain List of Main Files - ProjectController.getMainFileResourcesIterator() is a newly added API method that can be used to obtain the list of resources placed in the project's Main Files folder.
• Author Operations to Start and Stop Transformation Scenarios - The new ExecuteCustomizableTransformationScenarioOperation and StopCurrentTransformationScenarioOperation predefined Author operations allow you to start a transformation scenario with a set of custom parameters or to stop a running a transformation scenario.
• Access to Author Content as Char Sequence - A new API method (AuthorDocumentController.getContentCharSequence) has been added to allow access to the char sequence that contains all text nodes and marker characters from the Author visual editing mode.
• Create Editor Panes - The OxygenUIComponentsFactory.createHTMLEditorPane(String, boolean) API method has been added to allow you to create an editor pane capable of rendering HTML code that looks similar to the panes implemented in Oxygen.