Why Embed Check Data?
To get insight into the quality of a piece of content, writers and managers might like to see the Acrolinx Score with a link to the Scorecard directly in the content management system (CMS). If your Acrolinx administrator enables embed check data, then your CMS administrator can show the metadata for each document. You can get an overview of the quality of all content in a glance and even use this information to make business decisions such as readiness for publishing or translation.
Embed Check Data
When you embed the checking data into an XML document, and run a check on the whole document, Acrolinx inserts a processing instruction containing the checking data.
acrolinxCheckData score="82" scorecardUrl= "<SERVER_ADDRESS>/output/en/gear_pump_xhtml_admin_38616c5a5ff3e6fe_1_report.html" timeStarted="2017-10-10T06:24:03Z" status="green"
Your documentation environment tracks the status of the document throughout its life cycle.
To use the embedded checking data, make sure that you've configured your content management system correctly. If you're not sure, ask your CMS administrator.
To embed the checking data in documents, follow these steps:
Open your overlay of the core server properties file.
You'll find the overlay for the core server properties file in the following location:
Add the following property:
- Save your changes and restart the core server.