|Acrolinx for Oxygen XML Web Author||1.1|
What You Should Know Before Installing
Before you install Acrolinx for Oxygen XML Web Author, make sure you've installed the following:
|Acrolinx||5.3.1 or later|
|Oxygen XML Web Author||19.0, 19.1, 20.0|
Check our compatibility guide if you want to know whether Acrolinx for Oxygen XML Web Author works with your local platforms.
You can use Acrolinx for Oxygen XML Web Author to include content quality checks into your CMS workflow. This article covers the main steps to get you working comfortably with Acrolinx for Oxygen XML Web Author. If you're looking for help to install Acrolinx for Oxygen XML Web Author take a look at our Acrolinx for Oxygen XML Web Author Administrator Guide.
To get started, take a look through the following tasks and concepts:
Once you've installed Acrolinx for Oxygen XML Web Author, open a document. You'll see an Acrolinx dropdown in the right-side menu panel. Click it to make the Acrolinx Sidebar appear.
Acrolinx for Oxygen XML Web Author checks your XML and DITA documents.
Currently, DITA map checking isn't supported.
By default, the Sidebar appears in English. If your Oxygen XML Web Author language is German, French, or Japanese, then your Sidebar will also appear in this language.
If your Acrolinx administrator enables Embed Check Data, Acrolinx saves check data as a processing instruction at the end of your XML or DITA document.
Here’s an example of how embedded check data looks for XML documents:
acrolinxCheckData score="82" scorecardUrl=">SERVER_ADDRESS</output/en/gear_pump_xhtml_admin_38616c5a5ff3e6fe_1_report.html" timeStarted="2017-10-10T06:24:03Z" status="green"
To learn more about activating and using the Embed Check Data function, see our article on Embed Check Data for Sidebar Edition Integrations.
For more information on using the Sidebar, take a look at the article Get Started With the Sidebar.