CheckMate - Main Window

From Okapi Framework
Jump to: navigation, search

The main window is divided in two parts:

  • The upper part shows the source and target text of the item where the issue currently selected is located.
  • The lower part shows the list of issues detected. Which issues are displayed depends on several options.

Table

The table displays the issues found with the documents in the session. Use Check All to re-process the documents if you fix or modify one.

  • Column 1 indicates if the issue is enabled (check mark set) or disabled (check mark not set). An issue that is enabled is considered valid (i.e. a real problem), while an issue that is disabled is, in the context where it occurs, not a problem (i.e. a non-issue), a false positive. CheckMate remembers the issues you have disabled, so it keeps them disabled each time you re-process the documents.
  • Column 2 indicates the potential severity of the warning: Reg: high, Orange: medium, Yellow: low. This information is a mix of how confident the tool is about the error and how dangerous this type of error is. For example: missing a pattern like "%s" is both easy to detect and certainly dangerous, so its severity can be rated "high". On the other hand, a translation missing parentheses is easy to detect, but may or may not correspond to a translation problem, so its severity should be rated "low".
  • Column 3 (Text Unit) displays the ID of the text unit where the issue occurs. If the text unit has a native name (e.g. an ID in a propertis file) it is also displayed between parentheses.
  • Column 4 (Seg) displays the ID of the segment where the issue occurs, or nothing if the warning is for the whole text unit.
  • Column 5 (Description) shows the warning message for the issue.

Sort — You can sort the issues in the table by clicking on the header of each column. Note that the Text Unit and Seg columns are sorted by a combination of the document ID, the text unit ID and the segment ID. These IDs are alphanumeric, not numeric (e.g. the ID can be "tu1" not always "1"). When the IDs happen to be using only numbers, the sort may look strange as "101" comes after "1001" (where you may expect to see 101 to come before 1001).

Context Menu

You can right-click on an issue listed in the table to obtain a context menu. It offers the following commands:

Open Document — Select this command to open the document where the selected issue is located. This opens the file using whatever program is associated by the system with the type of the input document.

Open Containing Folder — Select this command to open the folder containing the document where the selected issue is located.

Edit Configuration — Select this command to edit the parameters for the verification.

Check All — Select this command to run the verification on all documents in the session.

Check Current Document — Select this command to run the verification only on the document currently select in the drop-down list of documents.

Add Document — Select this command to add an input document to the session.

Copy Text Unit Extraction ID — Select this command to copy to the Clipboard the extraction ID of the text unit for the current issue. This can be useful to locate quickly an entry in file formats like XLIFF or Java properties.

In addition, depending on the issue currently selected you may have additional commands available:

Copy Text Unit Resource ID/Name — If the text unit of the current issue has a name associate (i.e. resname in XLIFF) select this command to copy it to the Clipboard. This name is listed between parentheses in the Text Unit column.

Allow "<code>" as a Missing Code — If the issue indicates one or more codes missing in the target, the menu shows this command for each missing code. Select this command to add the given code to the list of codes that are allowed to be missing from the target segments. You can manage the complete list in the Quality Check Configuration dialog.

Allow "<code>" as an Extra Code — If the issue indicates one or more extra codes in the target, the menu shows this command for each extra code. Select this command to add the given code to the list of codes that are allowed to be extra in the target segments. You can manage the complete list in the Quality Check Configuration dialog.

Enabling/Disabling Issues

Which issues are displayed in the table is driven by the two list-boxes below the table on the right-hand side:

The first one selects the types of issue to display: Choose <All types of issues> to display issues of any types.

The second one selects where to display enabled and disabled issues. Usually you want to display only the issues that are enabled.

To toggle the status of a given issue between enabled or disabled, simply check or uncheck its corresponding check mark. You can click on the check box, or select the issue and press the Space key. You can select multiple issues at the same time by holding the Shift key pressed while moving the cursor up or down.

You can re-enabled all issues with the command Reset All Disabled Issues from the Issues menu.

List of the Documents

The list of the documents for which there is one or more issues is displayed above the table. The list is always set to the document of the issue currently selected.

You can select another document in the list to move to the first issue for that document in the issues currently displayed.

Buttons

Check All — Click this button to run the verification on all documents in the session.

Check Document — Click this button to run the verification only on the document currently select in the drop-down list of documents.

Session — Click this button to open the Session Settings dialog, where you can add or removed the documents in the session, and edit other parameters.

Configuration — Click this button to open the Quality Check Configuration dialog, where you can specify what kind of verifications to perform.

Status Bar

At the bottom of the main window, the status bar indicates:

  • the current issue selected
  • how many issues are listed in the table
  • how many issues there are in total (listed and hidden)

For example: "5 / 17 / T=23" indicates that you are on the fifth issue of the table, which lists 17 issues, and that there are 23 issues in total.