XarTM - Xaraya Translation Memory

Table of contents

Using XarTM

Overview

Once you have finished importing the Xaraya locale files, (see Installation) you can start translating.

  1. Point your browser to http://host/dir/WebGUI.php
  2. Choose your locale and switch to it (better set in config.inc.php)
  3. Navigate in the project tree, find what you want to work on (or just Click Xaraya, then "Next missing")
  4. Select strings to edit, use the buttons to save and navigate

XarTM page overview and navigation options

General overview of XarTM

Currently supported navigation options. Most options have a hotkey.

Whenver you choose a string to edit, the "Search results" area will update and display similar strings to the selected English string. Use the "toggle strings" (hotkey: t) to quickly move these search results into the viewport (hides current project's strings).

A darker red background marks the currently edited string, both on current file's strings list and search results.

A Project in XarTM means any directory of file which contains either other directories/files or strings to be translated. In Xaraya, every single locale file is a "project", so are all the directories containing them. Note, xartm is not limited to translating Xaraya.

Automatic finding of similar strings.

Search results

Click on a translation to move it to the current edit field. You can use hotkey 0-9 for the marked search results to take the translation.

Save to multiple strings

Search results display similar strings to the edited one, based on how many words of various sentences in the system match the words of the edited string. Better results (more matching words) are displayed on the top of the list. This gives a good chance to display repated entries of the same string collected at the top of the list.

You can use the checkboxes next to search results to select the strings where you want to save the current translation, then press "Save to all checked" button. This saves the current string too, even if that is not checked.

Select multiple strings to translate them at once

Select mulitple save destinations on search results

Using Stack - Translate similar strings in batch

If you notice very similar strings in the search results, you may want to translate them in one pass, instead facing the repeats while working.

Push the search result entries to the stack using "Push" link, and use "Save + pop" (hotkey: p) button to edit them quickly.

Update similar strings, by help of basic copy(once)/paste/edit

Strings pushed into the stack

Stack is basically a bookmark list, where you can push strings and take them out in reverse order. (A nicer bookmark system may be added later.) The "Push" button pushes the current string in the stack, so you can navigate elsewhere, to another module or a search result entry you wish to correct, and then return to your original work by pressing "Pop". (FILO - First in Last out.)

Stack displays old stack entries with gray background, while entries you added since the last page load have no gray background.

Browser form history

If you have enabled form history in your browser, this will offer translations of previously translated exact copies of an English string. XarTM makes sure, only translations entered for the same English string are offered.

For example, if you repeatedly see the same string, you can simply double click the field and Firefox will list the previously saved values for the same string. Also if you start typing.

Browser form history remembers translations

Browser form history in work

Compare changes - Diff

When you see an English string, which has lost translation but has a similar result, it may be difficult to find whether something important or only a typo was edited. Use the "(?)" icon to display a visual diff. (The "(?)" icon disappears when used.)

Visual diff - a typo has been fixed (administration)

Diff colors the differences

Diff uses the following markers: Red: only in currently edited string. Green: only in the compared result.

Currently there is no option to compare localized strings.

Obsolete files and strings

Obsolete files and strings are the ones which were not found by the latest import. This is decided by updating a "last seen" time stamp of each file and string while importing. Thus if a string has older "last seen" than the root "Xaraya" project, it is considered dead, outdated. This is why you must not stop import process.

These dead strings are marked gray, cannot be edited, can be deleted. Dead files can be deleted only if all dead strings from it are deleted in advance.

Note that in most cases you want to keep these dead strings, as they may be useful translations if the feature was moved to another location! Keep them at least until you reuse them to the new location or decide they won't be needed anymore.

Outdated, dead string

Dead strings are grayed out

Plus (+) signs mark dead strings and files. These strings and projects won't appear in exported language pack.

Export translations to Xaraya

To export your translations use the ./export.php command line script (prints help), or the "Export" button on the bottom of the page, if you enable this feature in config.inc.php. You can copy the exported directory to your Xaraya var/locales directory to test it, or you can direcly export to that location.

To update your translation database to newer Xaraya releases, please read Installation.

NEVER IMPORT old skeletons after you made translations in XarTM, because you will lose your work! You should import only if you exported the pack, installed it to your Xaraya and generated the skeletons over those exported files!

Notes

  1. There is no sense editing strings in fuzzy.xml files. They are good only for filling data to translation memory. (To save previous translations.)
  2. Reload button is safe, almost anytime, saves the string again. (After Del operation it fails.) Browser back is also safe, but try to understand what you do if you press these.
  3. Qt GUI will be supported later using php_qt.

Hotkeys

Hotkeys or access keys provide very fast operation, especially for repeated tasks. Hotkeys are underlined on buttons and links in XarTM.

Various browsers handle hotkeys on different ways:

Hotkeys

You can very often repeat s-t-0/9-e and again.

Table of contents