Wiki Navigation

Transolution XLIFF Editor documentation

Version:	0.1
Date:	2005-07-24
Authors:	Fredrik Corneliusson

Contents

Introduction

img-xliffeditor

The editor user interface consists of 2 main parts, the TU view (1) and Document view (2). The Document view is used to navigate between TU's in the document and provides context. The TU view is used to edit the actual translations. The editor has 2 modes; document navigation mode and TU editing mode. Document mode is the default and used when no TU is open. When you open a TU you enter TU editing mode. In this mode the document view and navigation is locked. When you close the TU you will return to the document navigation mode.

Basic UI philosophy

The editor only shows information if it's there to keep the UI as clean as possible. So TU notes, properties, alt-trans and TM matches will only show if there are any.

img-xliffshowall

Document view

The document text view consists of translation units and text surrounding the TUs if the XLIFF provides it.

img-tu_highlight

Selecting TU

The next/previous TU actions selects TU closest to the Cursor. When a TU is selected it is highlighted in yellow.

Ways to select TU

Use the accelerator ALT+arrow right/left, this will also set the document view in focus.
If the document view has focus you can simply use arrow up/down or right/left.
Double clicking on a TU with the mouse.

TU filter

The filter setting is used by next/previous TU operations and helps to locate relevant TU's.

img-tufilter

TU navigation filters available:

None: (default) jump to the next/previous TU in the document.
Untranslated: jump the the next/previous untranslated TU.
Unapproved: jump to next/previous unapproved TU.

Note

The page up/down/home/end keys does not change the selected TU it only moves the cursor and view.

Editing TU segments

To edit a TU you have to open it.

Open TU

You open a TU by selecting it in the Document view and execute the TU open operation TU|Open (ALT+HOME) .

img-opentu

When you open a TU you enter the TU edit mode. Now you can edit the Translation in the target text widget. In this mode the Document view is locked.

In the Document view the opened TU indicated by the color magneta.

You are now in the TU edit mode. The target text widget works just as you would expect a text widget to do. The only special thing is the tag protection. Cut/copy/paste works and undo/redo works for most operations (until the TU is closed).

You have the following TU wide options:

Copy source: This will copy the source content to the target. Useful if only minor changes are needed to the source.
Copy from TM: If interactive TM lookup (Using Translation Memory ) is enabled and you get a match this operation copies the best match to the target.
Copy AltTrans: If the TU has any AltTrans (Non interactive TM) matches this operation allows you to select one and copy it to the target.

Handling tags

Tag protection and handling is one of the key features of the editor. So you better read this ;-)

Inserting and moving tags

You can use copy/paste for text and tags from the source and target widgets but this is not recommended as the editor provide better ways of handling tags.

To copy all tags present in the source with Tags|Insert all tags.

Individual tags can be copied from the source by using the accelerator ALT+TagID. This only works for tags with id's between 1-9 if there are tags with other id's you use Tags|Insert tag (ALT+0) and you will be able to specify the id of the tag to insert. If tags are paired and have same id (eg. <b>bold</b>) both start and end tag will be inserted.

If tags with the same id already exists in the target you will be asked if you want to insert a new copy (with uniqe ID) or move the existing tag.

img-taginsertdialog

Deleting tags

To delete tags you have to disable tag protection. Then you select the whole span of the tag and delete it as you would with text (delete or backspace keys).

Edit tag content

If you need to alter a tags contents you do this by recursing into it. This is done by placing the cursor at the start of the tag and use the "Open TU or tag"-operation.

img-open_a_tag

This will open the tag for editing. This can be repeated as long as there are tags in the content you open.

img-edittag

When you Commit and close you will return to the parent segment.

img-changed_tag

Closing TU

When you are done editing the TU you will need to close it.

You have the following choices when closing a TU:

Commit & Close: Accept the changes done to the TU. It will also add the translation to the TM if it is enabled.
Cancel & Close: Revert all changes done to the TU.
Remove target and close: Remove the translation (target) of the TU and leave it untranslated.
Commit & open next: Do a Commit & Close and open the next untranslated TU.

Using Translation Memory

The Editor needs a TM server to connect to. Please see the TM server documentation for more info on how to start it.

Connecting to TM server

Make sure a TM server is running. Check the TM|setup setting, it should be set to http://localhost:6315 by default. This is OK if you run the TM server on the same machine and the default port. Then enable the TM|Active option. A dialog should popup saying that Transolution TM server v0.1 is connected.

TM Lookup

To automatically look for matches in the TM when you open a TU check TM|Automatic TM lookup.

Insert TM match

To insert a match from the TM select TU|Copy from TM from the menu or ALT+CTRL+INS accelerator.

Adding TU to TM

If the TM is active (TM|Active) the editor automatically adds the opened TU to the TM if you commit it.

Configuration

img-view_menu

Document view Configuration

In the View menu you can set how you want the Document view it to be displayed.

TU

You can choose to display the TU's source, target or both.

Source: Always show the source segment
Target: Display the target segment if there is one, otherwise display source
Both: Display both source and target and use <}{> characters to separate them. If there is no target it just displays the source.

Context (Skeleton)

Some XLIFF filters like Transolutions sgml filter and Sun's OLT filters provide a skeleton file. This file provides contents between TU's that should be locked from translation. Depending on the original file format it can provide helpful context (html,docbook) or be in the way (OO).

The following view modes are avaliable for the context (skeleton):

Full: display everything.
Minimal: only show context as <> and add newlines if the context has any. This helps to see the text flow even if there is a lot of unnecessary tags.
None: don't display any non TU context information.

Navigation