User Interface

From Ocelot
Jump to: navigation, search

This page describes the Ocelot user Interface.



The UI is divided into three main panels, plus the menu bar.


Segment View

The majority of the main window is taken up by the segment view.


This view contains a number of columns, which will be explained in order.

  • The segment index column ('#') contains the index of the segment within the document. This number is assigned by Ocelot and does not necessarily correspond to the ID of the segment within the XLIFF document. The segment index starts at 1 and is incremented for each additional segment. If segments are filtered via the Rules UI (as in this screenshot), the indices may appear non-sequential. Additionally, this column is color-coded based on state-qualifier rules, as in this screenshot.
  • The Source column contains the source of the trans-unit in the XLIFF.
  • The Target column contains the target of the trans-unit in the XLIFF. The target value may be edited, as long as the segment is in a phase that allows editing.
  • If the trans-unit's target has been modifed in Ocelot, the Target Original column contains the original value of the target. Ocelot will store this value in XLIFF as an alt-trans element. Differences between the original and current targets will be highlighted: deletions will be marked with red, additions in blue.
  • There are 5 flag columns, any number of which may contain a flag. Each non-empty flag column identifies a Rules rule that matched the metadata on this trans-unit, due to the presence of language quality issue data, provenance data, MT confidence data, or some combination of the three.

Metadata View

The upper-left pane contains information about segment metadata. This is a tabbed view, so it contains different information depending on what tab is active.

Document Statistics

The "Doc Stats" tab displays aggregate information about the ITS metadata contained in the document.


This table provides a count of how many times each type of ITS metadata appears in the current document.

  • For language quality issues, severity ranges will be combined in order to convert multiple occurrences into a single row.
  • For provenance data, each provenance category and distinct value is split off into its own row.


The "LQI" tab displays information about the language quality issue data attached to the segment that is currently selected in the Segment View.


This table contains type, severity, and comment fields for all LQIs on the segment. LQIs are displayed even if they are not matched by a rule.


The "Prov" tab displays information about the provenance data attached to the segment that is currently selected in the Segment View.


The table contains the six categories of provenance data defined by ITS. Most provenance records won't contain values for all six of these fields.

Other ITS Metadata

The "Other ITS" tab displays additional ITS metadata attached to the segment that is currently selected in the Segment View.


This includes metadata that is neither LQI-related nor provenance information. (Most commonly, this is [[XLIFF#MT_Confidence|MT confidence] data.)

Detail View

The lower-left pane contains context-dependent details that varies depending on the action being performed elsewhere in the UI.

Segment Details

When a segment is selected in the Segment View, information about that segment appears in the details segment. Currently, the only additional information that is shown is the edit distance between the Target and Original Target (if present) fields. This data is read-only.


LQI Details

When an LQI is selected in the #LQI tab of the Segment View, its details appear for editing in the Details View.


These fields may be edited, but changes won't persist unless the "Save" button is clicked. Clicking "Cancel" or selecting another LQI will discard the current changes. LQI can't be deleted from the document, but they can be disabled, which will mark them as disabled in the XLIFF file.

Context Menus

Certain areas of the UI support a context menu that appears when the user right-clicks (or Ctrl-clicks on a one-button mouse). Currently, these areas support context menus:

  • The segment view
  • The metadata view, when the "LQI" pane is selected

The context menu supports the following options (not all of which may be available, depending on where the menu is used). All items correspond to items in the Segment menu.

  • Add Issue - Select "Add Issue" to add a new LQI to a segment.
  • Reset Target - Select "Reset Target" to revert the target of a segment to its "Original Target" value.
  • Remove Issue - Select "Remove Issue" to remove an LQI from a segment entirely. This option is only available when the context menu is clicked on an LQI in the metadata view.