Before you start, make sure that your Acrolinx Sidebar version and Acrolinx Integration support batch checking. You can start batch checking with Acrolinx Platform version 2021.12 and Acrolinx for Oxygen XML Editor and Oxygen Eclipse versions 2.0.
When you have a lot of content, it can help to get an overall sense of its quality. Since checking each file isn't always an option, Acrolinx offers other solutions. For example, you can check a complete DITA map in one go.
Let's learn how to start a check before we go into more detail about how to review your results.
You might notice that the Acrolinx Scores from a batch check are a little different than the ones in the Sidebar. This is because the Sidebar only extracts and checks editable content from the current view. The batch check, on the other hand, checks the underlying file structure.
Open a document or file that has more content components, such as a DITA map.
To start a batch check, follow these steps:
Navigate to the drop-down menu next to the CHECK button.
The BATCH CHECK button only appears when you open a document that has references to other documents.
Click BATCH CHECK. Acrolinx then lists all document components.
Wait for Acrolinx to check the components. You can see the status of each check in an associated Sidebar card.
Waiting for a check
The down arrow icon means that this component is in the check queue.
Check in progress
The Acrolinx check mark will appear when the check is running.
After a check, the score will appear on the right side of the component card in the typical color coding.
Acrolinx couldn’t check this content
Hover over the warning icon to get more information.
After a batch check, you'll see the individual Acrolinx Scores for all checked components in the respective Sidebar cards. To get a sense of how your content is doing overall, view the average component score in the top right of the Sidebar.
For more detailed information on the issues Acrolinx found in your content, click on the score. This will open the Content Analysis dashboard.
Not familiar with the Content Analysis dashboard? Learn more about it in the Content Analysis dashboard documentation.