CheckMate - Usage

From Okapi Framework
Jump to: navigation, search

A typical session with CheckMate is often made of the following steps:

Selecting the types of checks to perform:

  1. Click the Configuration button in the main window.
    Or: Select Edit Configuration in the Issues menu.
  2. Both commands open the Quality Check Configuration dialog where you can specify the checks to perform.
  3. Go through the different tab of the dialog box and set or unset the options as needed.
  4. Click OK.

Adding a document to the session:

  1. Drag and drop the document you want to add on to the main window of CheckMate.
    Or: Select Add Document in the File menu, and select the document to open.
  2. Both actions will bring up the Add Document dialog. Enter the filter configuration corresponding to the document. For example: okf_tmx for TMX files, okf_xliff for XLIFF files, okf_ttx for TTX files, etc. Most of the time the default will be set for you. You can also click on the button near the field to open the Filter Configurations dialog and select the configuration from there.
  3. Enter the default encoding for the file. This encoding is used if the application does not have a way to auto-detect the encoding. You can ignore this parameter in all XML-based formats.
  4. Enter the code of the source locale, for example en-us for US English.
  5. Enter the code of the target locale to process, for example fr for french.

Note: All documents in the session must be for the same language pair. All documents must be bilingual/multilingual translated documents (for example: XLIFF, PO, TMX, TS, etc).

Performing the checks:

  1. Simply click on the Check All button in the main window.