Viewing a Report Summary for a Checked Document
After you perform a batch check, you can see a summary report for each document that was checked.
To see a report summary for a checked document, follow these steps:
- In the file list in the Batch Checker window, select a document.
tab on the lower right side of the window.
You see the results for the checked document in the tab window.Important: There is no report summary for TMX files.
Viewing a Scorecard for a Document
After you perform a batch check, you can see a detailed report for each document that was checked.
To see a Scorecard for a document, follow these steps:
- In the file list, select the document for which you want to see a Scorecard.
(Alt+R) to display the Scorecard in a web browser window.
Important: Scorecards are not available for TMX files.
The scorecard contains the following sections. Some sections are only displayed if the corresponding checking option was selected for the check.
|Quality||The overall Acrolinx Score for your content. If you're curious about how it's calculated, check out the section How the Acrolinx Score is Calculated .|
|Categories||Scores that show you how well you did for each of the issue types. You only get scores for the issue types that are selected in your Acrolinx options.|
|Voice||Scores for each of the characteristics that make up the tone of your content. There's more information about these characteristics at the bottom of the Scorecard.|
|Document Information||Information about the checked document. For example, this section displays the document name, the number of words and sentences, and other statistical information about your document.|
|Administrative Information||Information about the Acrolinx configuration that was used for the check. For example, this section displays information about the user who ran the check and the Acrolinx server and client versions.|
Information about the check. For example, this section displays the language of the document and the rule and term sets that were used for the check. Additionally, this section can also display the reuse leverage and the Flesch Reading Ease score.
About Reuse Leverage
Reuse leverage is relevant if your organization uses the Reuse module. The reuse leverage percentage indicates the proportion of validated sentences that you have used in your document.
The percentage is calculated from the number of sentences in the checked text that have an exact match against a representative sentence in the reuse repository. This value is only shown when the checking option Reuse was enabled.
About the Flesch Reading Ease Score
The Scorecard does not display the Flesch Reading score by default. However, your administrator might configure the Scorecard to display the Flesch Reading Ease score so that you have an additional score for measuring the quality or your content.
The scorecard displays a separate section for each issue type. Each of these sections contains detailed information about the detected issues together with suggestions on how to resolve the issue. If we found issues in read-only sections, the scorecard displays a padlock icon next to the detected issue.
In the following sections, you can change the way the information is presented or perform a followup action:
Style and Grammar
|Voice Descriptions||Information about the different voice scoring characteristics, for example readability, informality, or liveliness.|
Viewing an Aggregated Report
When you run a batch check, an aggregated report is generated that contains a summary of the results of all the individual Acrolinx Scorecards.
You can open the aggregated report to assess the overall quality of the documents that you checked and to view a breakdown of the statistics by flag category and rule type.
To see an aggregated report, follow this step:
Show Aggregated Report
Important: Aggregated reports and Scorecards are not available for TMX files.
The aggregated report contains the following sections.
The Summary tab includes:
- Totals for the number of files, words and flags.
A breakdown of the flags and checking scores for each flag category.
The aggregated report does not include statistics for valid terms unless your Acrolinx administrator has enabled the admitted terms flag type.
The Results tab includes:
- A list of all checked files with links to the individual Scorecards for each file.
- A breakdown of the checking score and flag count by category for each file as well as totals for each file.
Style and Grammar Summary Tab
A count of the style and grammar flags broken down by rule name.
Viewing the Flags in a Document
When the Acrolinx Batch Checker checks a document, parts of the text that possibly need corrections are marked with flags . You can see the flags in each document that was checked.
To see the flags in a document, follow these steps:
Display the document. In the file list, perform one of the following actions:
- Double-click the document.
Select the document. Then in the
Show Flags in Document
Attention: Large documents may take a few moments to appear. This option is not available for TMX files.
The Checked Document window displays the document and the flagged text:
If some flags are difficult to see, you have the following options:
- Make the text bigger by using the ' + ' and ' - ' keys on your keyboard to zoom in and out on the text.
- Display the flags with an underline by pressing in the ' u ' key.
To see more information about the flags, you can perform the following actions:
- Click the Previous Flag and Next Flag buttons , OR
Use the keyboard shortcuts:
- Alt+N to see the next flag in the document.
- Alt+P (English interface) or Alt+V (German interface) to see the previous flag in the document.
A shortcut menu gives a short description of each flag:Tip: You can also right-click a flag to see the shortcut menu.
- To see a Scorecard for the document, use the keyboard shortcut Alt+R or click the Show Scorecard button .
Contributing Terms to the Terminology Database
If your organization uses the Terminology Manager, you can contribute new terms to your terminology database when you view the flags in the document.
To use this function you must select a rule set with term harvesting enabled and activate the checking option New terms .
The Acrolinx Server administrator configures the required properties and privileges for this feature. You must have the appropriate privileges to contribute terms.
To contribute a term to the terminology database, follow these steps:
- Run a check and show the flags in the document.
Click a new term flag and click
in the shortcut menu that appears.
The Term Contribution page opens and the fields are prepopulated with information about the term you selected.