This topic is written guidance administrators who have advanced knowledge of Acrolinx. See also the article on how to update a CSD in this help center. If you need help with this task, don't hesitate to contact Acrolinx support (firstname.lastname@example.org)!
Acrolinx uses extraction settings to determine what to check and what to exclude. If Acrolinx finds issues in content that should be excluded, then you'll need to modify the extraction settings.
To modify your extraction settings, follow these steps:
1. Find out which extraction settings Acrolinx currently uses.
2. Create a new CSD or modify an existing CSD for your use case.
Which extraction settings is Acrolinx using?
To find out which extraction settings (CSD) are applied, look in the Administrative Information section of a scorecard.
How do I edit a default CSD?
By default, Acrolinx browser integrations use a CSD called browser-default, which you can see in the Dashboard under Guidance Settings > CSDs.
Make a copy of the default browser CSD and customize it for your use case.
1. In the Dashboard, navigate to Guidance Settings -> CSDs.
2. Download browser-default.properties.
3. Rename the file so that you know what web application it's for. For example, we've created a CSD called "browser-Zendesk.properties" that we've modified to check only relevant content on web pages in Zendesk.
4. You'll also need to update the "csd_name" and "dtd.source_reference" to work for the content from your particular web application.
How does Acrolinx Read My Content?
Acrolinx for Chrome and Firefox collect content from all editable fields into one HTML document. To see this HTML document, follow these steps:
1. In the Dashboard, navigate to:
Maintenance -> Server Workload Capture
2. Click START.
3. Check SharePoint content with Acrolinx for Chrome.
4. Open Scorecard.
5. Rename *report.html to *request.txt and hit Return to load the file in your browser.
-> This shows you the HTML of your content as Acrolinx reads it.
Note: When you are finished updating your settings, we recommend disabling Server Workload Capture.
How do I exclude content?
To decide which parts of your content to exclude, you'll need to review the request.txt.
0. Have both the the CSD open in a text editor and the request.txt open in a browser.
1. In the request.txt, find an example of an issue that Acrolinx found in content that should be excluded.
2. Then look to see in which HTML element or attribute that content occurs.
3. In your modified CSD file, add the name of that element in a comma separated list after the property called "exclusion_elements".
4. Upload the modified CSD file and restart the server.
5. Check the same content again and see if the content is excluded.