Summary

This release updates Oxygen compatibility. Support for Oxygen XML 28 has been added, and support for Oxygen XML 26 has been removed.

Changes

• Added support for Oxygen XML 28 – You can now use this version with the latest Oxygen XML Editor.
• Removed support for Oxygen XML 26 – This version is no longer supported.

Summary

This release removes the Logback dependency from Oxygen, along with the Open Log File feature. As a result, if you want to enable logging, you'll need to configure logging in your host editor.

Changes

• Removed Logback dependency – The Logback dependency, previously used for custom logging and the Open Log File feature, has been removed. You can now configure logging within your host editor.

Summary

Release date: 23 January 2025

Bug fix

• Issue with highlight and replace - A lingering bug was affecting highlight and replace behavior in Acrolinx. We've found the source and fixed the issue.

Summary

Release date: 20 January 2025

This release introduces support for the latest version of Oxygen. It also comes with a couple of bug fixes.

Changes

• Added support for Oxygen 27 - We now support version 27 of Oxygen Standalone and the Eclipse plugin.
• Dropped support for Oxygen 25 - With Acrolinx for Oxygen Standalone and the Eclipse plugin 2.4, we've dropped support for Oxygen 25.

Bug fixes

• Issue with highlight and replace - Sometimes Acrolinx in Oxygen didn't highlight the correct issue text and inserted suggestions with extra spaces or characters. This is now fixed.

Summary

Released 3 September 2024

Bug fix

Wrong Content Profile selected - When you ran a batch check in the Oxygen Sidebar, Acrolinx used the wrong Content Profile for the check. We've fixed this.

Summary

Released 19 July 2024

This release fixes a couple of bugs.

Bug fixes

• AI suggestions issue - When you tried to use an AI suggestion in a paragraph with multiple suggestion cards, the other AI suggestion cards in that paragraph wouldn't work. We've fixed this.
• Wrong sidebar-sdk-java version - We've fixed a small bug that caused the wrong sidebar-sdk-java version number to appear in the "About" dialog.

Summary

Released 21 May 2024

We've added support for Oxygen version 26 and removed support for Oxygen version 24 and earlier.

Improvements

• Support for Oxygen v26 - Acrolinx now works with the latest Oxygen release. We've upgraded the minimum required Java version to Java 11 with the JavaFX runtime environment.

Summary

Released 30 October 2023

This service release addresses a bug where the Sidebar wouldn't launch in the Eclipse editor.

Platform Support

We recommend that you use:

• Acrolinx Platform version 2022.05 or later to highlight referenced content
  • If you want to check referenced content, but don't need the to highlight the issues themselves, you can use Acrolinx Platform version 2021.12.1 or later.
• 23.x, 24.x, 25.x (Standalone and Eclipse)
• Eclipse version 4.19 and above

Summary

Released 29 September 2023

This is a small service release to address a bug.

Platform Support

We recommend that you use:

• Acrolinx Platform version 2022.05 or later to highlight referenced content
  • If you want to check referenced content, but don't need the to highlight the issues themselves, you can use Acrolinx Platform version 2021.12.1 or later.
• 23.x, 24.x, 25.x (Standalone and Eclipse)
• Eclipse version 4.19 and above

Bug Fixes

• Check Selection - We've fixed a bug where the Check Selection feature wasn't available.

Summary

Released 11 September 2023

This is a small service release to address a bug.

Platform Support

We recommend that you use:

• Acrolinx Platform version 2022.05 or later to highlight referenced content
  • If you want to check referenced content, but don't need the to highlight the issues themselves, you can use Acrolinx Platform version 2021.12.1 or later.
• 23.x, 24.x, 25.x (Standalone and Eclipse)
• Eclipse version 4.19 and above

Bug Fixes

• Batch check got stuck when checking DITAmap files - This could happen when the content contained escaped XML tags.

Summary

Released 7 June 2023

This is a large service release to address a handful of bugs.

Platform Support

We recommend that you use:

• Acrolinx Platform version 2022.05 or later to highlight referenced content
  • If you want to check referenced content, but don't need Acrolinx to highlight the issues themselves, you can use Acrolinx Platform version 2021.12.1 or later.
• 23.x, 24.x, 25.x (Standalone and Eclipse)
• Eclipse version 4.19 and above

Bug Fixes

• Acrolinx Couldn't Replace Some Special Characters - You can now replace symbols and umlauts from the Sidebar.
• Sidebar Batch Check Didn't Work in Third-Party CMSs - Checking with the Batch Check Sidebar works as expected.
• Acrolinx URL Inserted into Document - No more mysterious Acrolinx URLs in your content when you sign in after copying and pasting your Acrolinx URL.
• Blank Sidebar When Opened in Oxygen - Fixed! The Sidebar won't disappear on you anymore.

Summary

Released 28 December 2022

This is a small service release to update our libraries and officially add support for Oxygen 25.

Platform Support

Acrolinx for Oxygen requires:

• Acrolinx Platform version 2022.05 or later to highlight referenced content
  • If you want to check referenced content, but don't care about highlighting the issues themselves, you'll need Acrolinx Platform version 2021.12.1 or later.
• 23.x, 24.x, 25.x (Standalone and Eclipse)
• Eclipse version 4.19 and above

Dropped Support

We have dropped support for the following:

• Oxygen 22.x

Improvements

Added Support for Oxygen 25

Another year is around the corner, which means a new Oxygen version. We have officially added support for this new version, Oxygen 25.

Regular Maintenance

We updated our libraries.

Summary

In our Acrolinx for Oxygen 2.0 release, we made it possible to check referenced content within a DITA topic. With this release, we've enhanced it a little more. We're excited to introduce issue highlighting in referenced content! You'll also get a small UX improvement and a bug fix.

Platform Support

Acrolinx for Oxygen requires:

• To highlight referenced content, you'll need Acrolinx Platform version 2022.05 or later.

  If you want to check referenced content, but don't care about highlighting the issues themselves, you'll need Acrolinx Platform version 2021.12.1 or later.

• 22.x, 23.x, 24.x (Standalone and Eclipse)
• Eclipse version 4.19 and above

Improvements

Issues Highlighted in Referenced Content Say goodbye 👋 to manually finding issues within DITA topics. Acrolinx now highlights these issues for you. When you click on an issue card in the Sidebar, Acrolinx will highlight and scroll to that issue in your content.

Improved Sidebar UX Whether you're an experienced user or you're just getting started with the Sidebar, a little extra UX help never hurts. We've added a new message to the Oxygen Sidebar that reminds you to open a document or file before you run a check.

Added Support for XInclude We can now check more of your content! We've added support for XInclude elements, which means that you can use Acrolinx to check, highlight, and replace issues in XInclude elements.

For this to work, you'll need the right Content Profile. XInclude is an external reference that isn't editable with the Acrolinx Sidebar. That's why XInclude references should be marked as READ_ONLY. Most Content Profiles include the setting for XInclude by default. If needed, you can set this yourself for Acrolinx for Oxygen 2.1.

To make sure you can check XInclude, do the following:

1. In the Acrolinx Dashboard, navigate to Guidance Settings > Content Profiles.
2. Find the DITA or XML Content Profile and click on it.
3. Go to Context and select READ_ONLY. (If the context READ_ONLY doesn't exist, you need to create it. See the Content Profiles Reference Guide for more information.)
4. Click the plus icon and add ACROLINX_EXTERNAL_CONTENT under READ_ONLY.
5. Under Extraction, add XInclude to the table as an empty element

Bug Fixes

Blank Sidebar in Unsupported Oxygen Versions In some cases, you would see a blank Acrolinx Sidebar when an unsupported version of Oxygen was used. This was confusing as it because it looked like a bug that wouldn't let you check your content. We've fixed this issue so that the Sidebar can't be installed on an unsupported version of Oxygen.

Important for Oxygen Eclipse Users

Some Windows Instances Require WebView 2

Windows users that aren't on Windows 11 and use Acrolinx for Oxygen Eclipse need to download and install WebView 2 from Microsoft. This is because we've updated the Sidebar to use Microsoft Edge Chromium instead of Internet Explorer.

You can download WebView 2 from the page WebView2 - Microsoft Edge Developer. Linux and macOS users don't need WebView 2.

Summary

We're excited to release the new Acrolinx for Oxygen. With version Acrolinx for Oxygen 2.0,we present the brand-new Sidebar batch checking feature. This feature lets you use the Sidebar to batch check DITA maps directly in your editing environment. Plus, you can now check for all issues in referenced content.

Platform Support

Acrolinx for Oxygen XML Editor and Author requires:

• Acrolinx Platform version 2021.12 or later
• Oxygen versions22.x, 23.x, 24.x (Standalone and Eclipse)
• Eclipse Version 4.19 and above

Dropped Support We no longer support Acrolinx for Oxygen XML Editor and Author version 1.5.

Features

Batch Checking We wanted to make it easy to keep an overview with the check results of a DITA map. So, we came up with a feature that lets you check a DITA map. On top of that, it accurately displays how each DITA topic within that map scores.

And voilà! You can batch check a DITA map and get an overview of each DITA topic's content quality directly in the Sidebar. From there, you can click the DITA topic cards to start taking action on the low-scoring DITA topics!

Learn more about how it works in Batch Check Your Content with the Sidebar.

Full Support for DITA References With the Acrolinx for Oxygen 1.5 release, we made it possible to check for the following referenced content tags: conkeyref, conref, keyref, and topicref.

But we want it all! That's why you can now check all references within a DITA map. Note that checking referenced content works in the Author view only. In the Text view, Oxygen itself doesn't resolve references.

Acrolinx for Oxygen is currently the only integration that resolves DITA references. So, don't be surprised if you get a slightly different score when you check the same content in a different integration, like the Content Analyzer.

Important for Oxygen Eclipse Users

Some Windows Instances Require WebView 2

Windows users that aren't on Windows 11 and use Acrolinx for Oxygen Eclipse need to download and install WebView 2 from Microsoft. This is because we've updated the Sidebar to use Microsoft Edge Chromium instead of Internet Explorer.

You can download WebView 2 from the page WebView2 - Microsoft Edge Developer. Linux and macOS users don't need WebView 2.