Warnung
[en] Acrolinx has started to phase out support for this configuration option. But don’t worry! We've replaced it with Targets. If you have Targets enabled, you already have an easier way to manage your guidance. Visit How Acrolinx Scores Are Calculated to learn how Acrolinx now calculates the Acrolinx Score.
[en] When you check with an Acrolinx Integration, you get an Acrolinx Score for the content. The Acrolinx Score expresses the average of all category scores as a standardized score out of 100. The higher the score, the higher the quality of the content. To influence the calculation of the Acrolinx Score, you can configure the weighting of category scores.
[en] Content scores help you to quantify the quality of a document and compare it with other documents. The Acrolinx Score expresses the overall quality of your content as a score between 1 and 100. You also get similar scores for how well you did in each of the quality categories such as spelling or style. The overall Acrolinx Score is simply an average of your individual category scores.
[en] Each individual quality category is calculated based on the following formula:
[en] Normalized document length / (Normalized document length + issue count)
[en] This formula contains the following variables:
-
[en] Document length
[en] The number of words in the document.
-
[en] Normalized document length
[en] The number of words in the document divided by a factor of 75.
-
[en] Issue count
[en] The number of issues that Acrolinx found in the quality category, such as spelling.
[en] The following table shows you what the calculation steps would be for a document with 1000 words and 12 spelling issues.
[en] Step |
[en] Calculation |
[en] Result |
---|---|---|
[en] Calculate the normalized document length |
1000 / 75 |
13.33 |
[en] Add the normalized document length and the issue count |
13.33 + 12 |
25.33 |
[en] Divide the normalized document length by the result of the previous step |
13.33 / 25.33 |
0.5263 |
[en] Express the result as a percentage and round it to the nearest whole number |
[en] 0.5263 * 100 |
53 |
[en] The Acrolinx Score is the average of all the category scores rounded down to the nearest whole number. For example, suppose that you check a document, open your Scorecard, and see the following scores:
[en] Category |
[en] Score |
---|---|
[en] Terminology |
57 |
[en] Spelling |
71 |
[en] Grammar |
71 |
[en] Style |
33 |
[en] Clarity |
75 |
[en] Conversational Tone |
77 |
[en] If you take the average of all the category scores and round it down to the nearest whole number, you get a final Acrolinx Score of 64.
Tipp
[en] If you're on an Acrolinx Private Cloud instance and are interested in these configurations, contact us and we'll set them for you! Keep in mind that you can only configure the thresholds features if you haven't enabled Targets.
[en] You can configure Acrolinx to increase or decrease the influence that a category score has on the Acrolinx Score. Weighting a category score helps writers prioritize the issues to correct in a document.
[en] For example, suppose that you want to encourage writers to remove all spelling issues in their content before they address other issues. You set the weighting for the spelling category to 200%.
[en] This way, the spelling category score counts twice as much as the same number of issues in any other category.
[en] To configure the weighting for a category score, follow these steps:
-
[en] Open your overlay of the following file:
thresholds.xml
[en] If you haven’t yet created an overlay of this file, create a new version of the file at the following location:
<config directory>/server/www/xsl
-
[en] Edit the
projectThreshold
element:<projectThreshold yellowQuality = "80" redQuality = "60" styleWeight="100" grammarWeight="100" termsWeight="100" termsAdmittedWeight="50" spellingWeight="100" reuseWeight="100" voiceGuidanceWeight="100" />
[en] Enter a new weighting value for one or more of the category weight attributes.
[en] For example, to change the weighting for spelling, update the value for the attribute
spellingWeight
.Anmerkung
[en] All voice categories share the same weight setting:
voiceGuidanceWeight
. -
[en] Save your changes and restart the Acrolinx Platform.
[en] The Acrolinx Scorecard displays the Acrolinx Score and the category scores with colored bars. These colors reflect the range of acceptability of the Acrolinx Score and the category scores respectively. The color coding is as simple as a traffic light, so you can quickly see how you scored.
[en] The Acrolinx Score and the category scores bars can have one of three colors:
-
[en] Green - excellent
-
[en] Yellow - acceptable
-
[en] Red - unacceptable
[en] The category score colors appear below the Acrolinx Score on the Scorecard.
[en] You can use color thresholds to configure the minimum Acrolinx Score or category score necessary to display a specific color.
[en] To configure the colors for the quality and category scores, follow these steps:
-
[en] Open the following file:
thresholds.xml
[en] You can find this file in the following location:
<config directory>/server/www/xsl
-
[en] To change the color for the Acrolinx Score, edit the
projectThreshold
element.[en] It should look something like this:
<projectThreshold yellowQuality = "80" redQuality = "60" styleWeight="100" grammarWeight="100" termsWeight="100" termsAdmittedWeight="50" spellingWeight="100" reuseWeight="100" voiceGuidanceWeight="100" />
[en] Update the following attributes:
redQuality="<THRESHOLD>" yellowQuality="<THRESHOLD>"
[en] Enter a new Acrolinx Score threshold for the yellowQuality and redQuality attributes.
Tipp
[en] The color changes when the scores are lower than the specified threshold. If the Acrolinx Score is equal to, or higher than the yellow threshold, the Acrolinx Score color defaults to green.
[en] For example, suppose that you wanted Acrolinx Scores lower than 10 to show up as red, and scores that are lower than 50 to show up as yellow. In this case, you'd configure the
projectThreshold
element as follows:<projectThreshold yellowQuality = "50" redQuality = "10" styleWeight="100" grammarWeight="100" termsWeight="100" termsAdmittedWeight="50" spellingWeight="100" reuseWeight="100" voiceGuidanceWeight="100" />
-
[en] To change the color for a category score, edit one or more of the elements with the naming convention
<CATEGORY_NAME>Threshold
. For example, you'd update thespellingThreshold
element as follows.<spellingThreshold yellowQuality="60" redQuality="40"/>
Anmerkung
[en] All voice categories share the same weight setting:
voiceGuidanceWeight
. -
[en] Save your changes and restart the Acrolinx Platform.