Configuring Languages

Scope(s): repository, project

You can optionally configure Polarion to support multiple human language translations of Work Items. When correctly configured, a Title and Description field for one or more additional languages appear in the Work Item form in tracker views (Table, for example), and users can switch languages in Documents to view translated Work Items.

Multi-language support can be configured globally for the repository and per project. You can optionally configure different languages for different Work Item types, and multiple languages for a single type. There are 2 configuration steps:

Defining Custom Fields

The first step in multi-language configuration is to define custom fields to store translated text of Work Item titles and descriptions. The procedure is the same as described in the Administrator's Guide topic Configuring Custom Fields.

You need to define 2 custom fields for each language you want to support: one for the translated Work Item title, and one for the description. The field for the title should be of type string. The field for description should be of type Rich Text (multi-line). You need to define this field pair for each Work Item type that needs to support multiple languages, and in each Work Item custom field configuration you need this field pair for each language that must be supported.

For example, suppose that for Requirement type items you need to support translations for German and Japanese. In the Custom Fields configuration for Requirement, you would need to specify:

  • Two fields for German, with IDs like requirement_title_de (string field for the German title), and requirement_descr_de (multi-line rich text field for the German description). The Name property can be something like Title (DE) and Description (DE), or the value could be in the target language (e.g. Titel and Beschreibung).

  • Two fields for Japanese: with IDs like requirement_title_jp and requirement_descr_jp, and Names like Title (JP) and Description (JP) (or the words in Japanese).

Configuring Multiple Languages

You perform this configuration in the Administration topic Portal > Languages in the scope you want to configure. There are 2 configurations you can perform on this page:

  1. Default Language label

  2. One or more translation languages for Work Items.

Default Language Label

The first item in the table on the Languages page is the configured label for the Document Editor control that enables users to switch from a translation to the portal default language. In English versions of the Polarion portal, the value is the English string "Default Language".

To change the default, click the Create button on the table row. Then on the Default Language page, change the value of the label and click the Save button.

Adding a Language

Before adding a language to the configuration, be sure you have performed the step of creating custom fields for the translated Title and Description for the target language.

To add a new language:

  1. On the Languages page, click the Add New Language button.

  2. In the Add New Language dialog, enter a name for the language. This name will appear to end users in the Languages menu of the Document Editor, which enables them to switch to a different translation of the document. For example, if the language you are configuring is German, you might enter German or Deutsch. Click Next to proceed. The language configuration page appears.

  3. In the language page, select a Work Item type in the Work Item Type list.

    If you choose All Types, the configuration will apply to new Work Items of all types, but not to existing Work Items of any type. If you want the existing items to have translation fields for this language, you will need to configure the specific type(s).

  4. In the Title column, select the name of the custom field configured for this language for the translated Work Item title.

  5. In the Description column, select the name of the custom field configured for this language for the translated Work Item description.

  6. If you want to configure this language for additional Work Item types, click the icon and repeat the previous 3 steps.

  7. Click Save when finished.

You should repeat this configuration for each language for which you want to support translations.

On the Languages page you can edit any existing language configuration, or delete a language configuration. Note that deleting a language configuration will simply remove the language item from the Switch Language menu. It will not remove any translation data that has been added to Work Items. If you wanted to remove the data, you would need to remove the custom fields from the Work Items configuration and re-index the system.

See also: User Guide: Viewing Work Item Translations.