Use the Sidebar in Acrolinx for Oxygen to check DITA maps and HTML, Text, and Markdown files.
What You Can Check
When you edit a document in Acrolinx for Oxygen, you can use the Sidebar to check HTML, Text, and Markdown files. Your Acrolinx administrator can also extend the file types that Acrolinx checks. See Configure Acrolinx to Recognize Your File Type to learn more.
You can use the Sidebar with the Author and Text views, but the Sidebar works best with the Author view. The Sidebar won't work with the Grid and Table views. We recommend switching off track changes before you run a check. Otherwise, you might see some unexpected behavior.
Sometimes, Acrolinx highlights an issue that has multiple tag types. Acrolinx doesn't support mixed-tag text like this. Cards with highlighted text that contains multiple tag types get grayed out when you click on them.
DITA Maps and References
Acrolinx for Oxygen supports DITA map checks. When you check a DITA map, the Sidebar doesn't highlight issues in the text or replace issues for you. Instead, you can edit your issues directly and use all the other features of the Sidebar. The cards give you all the information you need to correct your content. This includes the file name of the DITA topic.
If you use a custom DITA Content Profile, you’ll need to edit it before you can see the topic file name in your Sidebar cards.
You can make this change to Core Platform versions 2021.05 and earlier as long as your Core Platform version and Oxygen Sidebar version support DITA map checking.
To make sure you can see this information, do the following:
- Open the Acrolinx Dashboard
- Navigate to Guidance Settings > Content Profiles
- Find the DITA Content Profile and click on it.
- Navigate to Issue Location > ditaMapTopicRefFileLocation
- In the Variable box, replace
You can check DITA referenced content in the Author view. This isn't possible in the Text view, since Oxygen itself doesn’t resolve these references there.
Make sure you can see your referenced content when you open your DITA map. If you can't see it, neither can Acrolinx. In the toolbar, go to DITA Maps > Open Map in Editor with resolved topics.
For referenced content, you'll get inactive Sidebar cards that influence the Acrolinx Score. This means you might get a different score when you check your content in the Text view compared to the Author view.
Supported DITA references:
Support for DITA references and DITA maps is available starting with Core Platform 2019.10, but you'll get the best results with Core Platform 2020.03 and later.