TMGMT Zanata

Synopsis

TMGMT Zanata is a plugin for Drupal's Translation Management Module TMGMT. The plugin allows TMGMT to send content to a configured Zanata project for translation, and can download translations as they are ready.

Zanata is a web-based system for translators, content creators and developers to manage localisation projects (see zanata.org).

Requirements

Module requirements

TMGMT Zanata requires the Translation Management Tool module (TMGMT) to be enabled. TMGMT depends on a number of modules, listed at Preparation | TMGMT. TMGMT also requires some other modules to be enabled, listed at Setting Up TMGMT.

Usage requirements

To configure and use TMGMT Zanata, you need an account on a Zanata server. You will also need to create a project on the Zanata server and link the project in the plugin configuration. See the setup section for more information.

Installation

Install as you would any Drupal module.

Setup

Enable translation for content types

To make each content type translatable, the publishing options for the content type must be set appropriately. To do so:

1. In the administration menu, navigate to "Structure" > "Content types".
2. Find the content type you wish to make translatable and open its edit page.
3. Change to the "Publishing options" tab
4. Under "Multilingual support, select "Enabled, with translation".
5. Click "Save content type"

Add languages

To allow translation, your site must have one or more languages enabled, in addition to the default language.

To enable a language:

1. In the administration menu, navigate to "Configuration" > "Regional and language" > "Languages".
2. Open the "Add language" page
3. Select an existing language or enter details for a custom language.
4. Click "Add language" or "Add custom language"

Enable the TMGMT Zanata plugin module

Once the code for the plugin module has been installed, enable the module. To do so, open "Modules" in the Administration menu, scroll to the "Translation Management" section, and ensure that "Zanata translator" is checked. Also ensure that TMGMT and its dependencies are checked (see "Requirements" on the TMGMT homepage).
Click "Save configuration" to finalize the change.

Configure the TMGMT Zanata plugin module

Before the module can be used, it must be configured with some details about your Zanata user and the project on Zanata. These are set on the translatior configuration page.

If you do not yet have a Zanata username or API key, or you have not yet created a project or project-version on Zanata for your website, use the following instructions to do so before you continue:

• To get a Zanata account, see Signing Up.
• For instructions on finding your API key, see "User Configuration" on the Configure the Client help page.
  • User settings are accessed through the Dashboard.
  • Note that you do not need to create any config files for this plugin.
• For help creating a project, see Project Creation.
• For help creating a version, see Version Creation.

To open the translator configuration page and enter configuration:

1. Open the Administration menu
2. Navigate to "Configuration"
3. Navigate to "Regional and language"
4. Navigate to "Translation Management Translators"
5. You will see a list of translator plugins that have been added to TMGMT. Look for "Zanata translator" in the list.
   • If you see an auto-created Zanata translator, open the configuration page by clicking "edit".
   • If you do not see an auto-created Zanata translator, create one. To create a Zanata translator, click "Add translator", enter an appropriate label such as "Zanata translator", and in "Translator plugin" select "Zanata translator". When you select "Zanata translator" its configuration page will be displayed below.
6. If you do not wish to perform translation review in Drupal, for example if review will be done in Zanata, ensure that "Auto accept finished translations" is checked. This setting can be changed later.
7. Ensure that the Zanata server URL shows the correct Zanata server on which you have an account and have created a project for your website. To find the full URL, open the Zanata server and click the Zanata logo to open the homepage. The URL shown in your browser address bar is the server URL, but do not include a / at the end. For example, the homepage for the main Zanata server is at "http://translate.zanata.org/zanata/" so the URL for this server is "http://translate.zanata.org/zanata".
8. Enter your username, your API key, your project ID and your project-version ID. Be careful to use your Zanata username rather than your display name, and the Project ID rather than the Project Name. See the links above for directions that may help to find this information.
9. Click "Save translator" to complete the configuration.
10. You are now able to create translation jobs that use Zanata translator.

Usage

TMGMT Zanata is a plugin for the Translation Management Tool (TMGMT), so most of the directions for creating and interacting with translation jobs can be taken directly from TMGMT's documentation. See TMGMT How-To's.

In addition to the standard TMGMT features, TMGMT Zanata adds 2 operations to the translation job management page, both in the "Translator information" page.

Update translation info

The "Update translation info" button fetches the latest information about your translations from Zanata, and will download any translations that are ready. Once downloaded, translations will be available for review. If you have configured the Zanata translator to Auto accept finished translations, the translations for a document will automatically be approved as soon as they are all available.

Resubmit to translator

The "Resubmit to translator" button sends all the source text to Zanata again. This may be useful in case there was an undetected problem when it was sent initially, or if you have changed the setting for Segmentation in the Zanata translator configuration and need to send the source text with the newly selected segmentation style. It is safe to submit source text as many times as you like, it will not create any duplicate data on Zanata.