Getting Started with the Batch Checker
Running the Acrolinx Batch Checker
We deliver the Batch Checker as a Jar file which means that you don't have to install anything. It's ready to use.
However, make sure that you run the Batch Checker from the directory where you intend to keep it.
Why? Well, when you run it for the first time, the Batch Checker extracts all the required configuration files into the same directory as the JAR file. If you move it somewhere else, and run it from there, it will create and use a fresh set of configuration files. This could cause confusion if you've made a lot of changes to your configuration files in the meantime.
To run the Acrolinx Batch Checker, follow these steps:
- If you're running the Batch Checker on Windows or a Unix-based operating system, just double-click the JAR file.
If you're running the Batch Checker on Mac OS X, open a command-line window and enter the following commands:
cd <PATH_TO_JAR_FILE> java -XstartOnFirstThread -jar batchchecker-<VERSION>.jar
For example, the command might look something like this:
cd /Users/admin/Files java -XstartOnFirstThread -jar batchchecker-2.9.0-mac.jar
graphics l10n licences logs profiles system.properties
Connecting to an Acrolinx Server and Signing in
Before you can check documents you'll need to connect to an Acrolinx server and sign in.
To connect to an Acrolinx server and sign in, follow these steps:
- Enter a server address in the Server field and press ENTER or click Test Connection .
- When you are prompted, type your user ID.
If you are prompted, type your password.
The Batch Checker shouldn't take any more than a few seconds to connect. If it seems to be taking a while, click Cancel and double check your server address. The Batch Checker eventually times out with an error if it can't connect to your server.
The Document Options
To prepare for your first check, you'll need to tell the Batch Checker where to find your files and what type of files they are. Depending on what file type you select, you'll see a few extra settings that help the Batch Checker to interpret your documents correctly.
When a check is performed on HTML or XML files, the settings in a CSD (context segmentation definition) file determine the segmentation rules.
Before performing a check, the you select a CSD.
|Text, HTML, GML||File Encoding||
The encoding to ensure that special characters are rendered correctly for checking.
If you check files with the wrong encoding configuration, some text might be flagged incorrectly.
|Text||Preprocess Exported Word||
The sentence boundaries appear as double-pipe symbols '||' in the
Input Text Preview
tab and the
This option ensures that each line is treated as an individual sentence during checking.
|Re-concatenate hyphenated words||To merge word fragments that are separated by hyphens, select Re-concatenate hyphenated words . The Re-concatenate hyphenated words option does not change the original file.|
|Use alternative text extraction.||
If you notice that words are still fragmented when previewing text on the
Input Text Preview
tab, try the option
Use alternative text extraction
Use this option carefully and compare the input text preview for a document before and after you have selected this option.
This option might solve extraction problems with some documents but can make text extraction worse for other types of documents.
|TMX||TMX Language Selection||
The TMX Language Selection list box is populated with the languages available in the TMX file
The Check Options
Before you start checking, make sure that you have the right check options.
Selecting Files to Check
The easiest way to get started, is to have all your files in one directory and use the Batch Checker to scan that directory. However, if you want to batch check files across a set of directories, there's an option for that too . It just requires a bit more configuration. For now, let's assume you have all your files in one directory.
To select the files to check, follow these steps:
- On the Document Options tab, select the document type Files if it isn't selected already.
Click the file selection button
, browse to the folder that contains the files and click
You can also enter paths directly into the directory path field. When you enter paths into the directory path field, surround each path with quotation marks.For example, like this:
"C:\Documents and Settings\user\My Documents" "C:\test"
- Click Find Files .
If the directory contains files which you don't want to check, first select the unwanted files.
Tip: If the directory contains mostly unwanted files, press CTRL+A to select all files in the list, deselect the files that you want to keep, then press Delete. You deselect files by clicking the file names while pressing CTRL.
Starting a Batch Check
Viewing an Aggregated Report
You 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.