How to Create a TMX File from a Transifex Project

From Okapi Framework
Jump to: navigation, search

To create a TMX file (or other types of bilingual output) from a Transifex project you first need to have a login in the Transifex server where the project is located.

For this example, we will assume you have an account on the public Transifex.net server at http://www.transifex.net. If you do not, you can register here: http://www.transifex.net/accounts/register/.

Note: You do not need write permission (i.e. be part of the translation team) to access public projects if you do only read operations (like in this example).
If your process includes modifying the files, you do need to have write permission for the given project.

Once you have an account:

1. Open your favorite text editor and create a new text file named myFile.txp. You will need to save the file as UTF-8 if you have any extended characters in it.

2. In the file enter the following:

host=http://www.transifex.net
user=myUserName
password=myPassword
projectId=django

Where myUserName is your login name on http://www.transifex.net, and myPassword is the corresponding password.

For this example we will use the Django project, one of the project hosted in this server. The project identifier can be found in the URL of the project's main page. It is the last part of the URL. For example for http://www.transifex.net/projects/p/django/ is it django. Note that the project identifier and the project name are not always the same.

3. Save the file and close your editor.

Using Rainbow

1. Start Rainbow and drop myFile.txp in the Input List 1 window. The okf_transifex filter configuration is automatically associated to it.

2. Go to the Languages and Encoding tab and enter the source and target locales you want to work with.

The source locale for Django is English, so en is your code for the source (not en-us).

This project is translated in many languages, we will pick Russian for this example: ru.

Project dialog prompted by the Transifex Filter (Windows 7)

3. Select Utilities > Conversion Utilities > File Format Conversion. This opens a pre-defined pipeline that has the following steps:

= Raw Document to Filter Events Step
+ Format Conversion Step

In the options for the last step, select TMX Document in the Output format list.

Enter the full path of the TMX file to create in Output path. For example: C:\Tmp\DjangoStrings.tmx.

4. Click Execute. At this point, the filter reads your project file and fetch the list of all resources for the given project. It may take a few seconds.

Once it's done, a dialog box named Transifex Project pops up.

5. This dialog box lists all the resources for Django for which the source is English. They are all selected by default. You can un-select any of them by un-setting the check box corresponding to the resource.

Only the selected resources will be processed. In this example we want to process all of them.

6. Click OK to start the process. The filter fetch each resource and executes your steps. It may take a few seconds.

7. When it is done, you should have a TMX file with all the Django English to Russian translations in the output file.

Using Tikal

1. Start a DOS prompt or a shell console from where you can run Tikal.

2. Type the following command:

tikal -2tmx myFile.txp -sl en -tl ru

3. When it is done, you should have a file name myFile.txp.tmx with all the Django English to Russian translations in the output file.