RadixWare Programmer Guide/Translator Workplace

From RadixWiki
Jump to: navigation, search

Translator Workplace

The translator workplace enables to translate the captions displayed in the application interface (the names of objects and their properties, page headers, etc.). The developer defines all captions by means of a special control element (refer to Multilanguage String). After that, the translator can translate the captions which were not translated or correct the existing translation defined by the developer. It is also possible to correct the original text of the caption.

Translator Workplace Startup

To open the translator workplace, select the Window | Multilanguage Strings Editor menu item.

Starting the translator workplace for the first time opens the dialog box for selecting the languages to translate from and translate to.

ml-editor-languages.jpg

The dialog box contains the following parameters:

  • Languages to translate from. The list of source languages. To define the parameter, use the Product languages list and the buttons with arrows. If the list does not contain any language, the OK button is not available and the "Source language is not selected" warning is displayed in the lower part of the dialog box.
  • Languages to translate to. The list of target languages. To define the parameter, use the Product languages list and the buttons with arrows. If the list does not contain any language, the OK button is not available and the "Target language is not selected" warning is displayed in the lower part of the dialog box.
  • Layers. The layers / ADS modules that must be translated. If the parameter is not defined, all layers will be used.

Clicking the OK button opens the multilanguage strings editor (refer to User Interface of Multilanguage Strings Editor).

User Interface of Multilanguage Strings Editor

The multilanguage strings editor looks as follows:

Ml-editor-window.jpg

The editor consists of three panes:

  • Upper pane - multilanguage strings pane used to select the multilanguage strings.
  • Middle pane - translation pane used to translate the multilanguage string to all supported languages.
  • Lower pane - hint pane used to display the context of the current multilanguage string, to view the comment and the hint from the phrase book.

Multilanguage Strings Pane

The upper part of the editor displays the toolbar and the list of multilanguage strings.

List of Multilanguage Strings

The list of the multilanguage strings is presented as a table. The State column displays the state of the multilanguage string in a form of the icon. It is possible to change the status of the multilanguage string by clicking the icon. At that, the statuses of all translations are changed. It is not possible to set the status of the string to Checked if at least one translation is not defined for it.


The question.png icon indicates that the multilanguage string is not defined in at least one of the languages or that at least one of the translations does not have the Checked status.

If all the phrases of the multilanguage string have the Checked status in all languages, this string also has the Checked status and is marked with the done.png icon.


The exclam.png icon indicates that the source text is not checked. In this case, it is not possible to change the translation status; clicking such icon displays the respective message.

Other columns contain the multilanguage strings in the source languages. The multilanguage string edited by the translator is highlighted. The strings whose status has been changed from Checked to Not checked are highlighted in light-yellow.

The toolbar is used to configure the display of the multilanguage strings list. The toolbar elements are described in the table below:

Button

Name

Description

load-strings.png

Load Strings

Loads the multilanguage strings according to the defined output mode.

choose-dfn.png

Choose Definition

Opens the dialog box for selecting one or several definitions. The multilanguage strings from these definitions will be added to the list.

change-langs.png

Change Languages

Opens the dialog box for selecting the languages to translate to and translate from (refer to Translator Workplace Startup).

stats.png

Show Statistics

Opens the dialog box containing the translation statistics. This dialog box contains the Use all strings/Use filtered strings radio button (Show filter.jpg) to disable / enable the use of filtered strings only when calculating the statistics. The button is available if at least one filter is applied to the multilanguage strings list (except for the Layers filter).

add-to-pb.png

Add to Phrasebook

Opens the dialog box with a list of opened phrase books. Selecting this menu item will add the current string to the respective dictionary.

view-html.png

View Html

Opens the dialog box displaying HTML of the string.

Export strings1.jpg

Export Strings

Exports the multilanguage strings to a file of XLS format. The dialog box of command execution contains the following parameters:

  • Output location. The path to a file on the local drive of the workstation the strings will be exported to.
  • The parameters used to filter the strings to be exported:
  • Layers. The filter by ADS and DDS layers / modules. If the filter is not configured, the strings of all layers defined in the development branch will be exported.
  • Last modified by. The filter by the user who last edited the string.
  • Date From/To. The filter by the period within which the string was edited.
  • String type. The filter by the string type (the string of a certain type will be exported if the respective flag is set):
  • Title. The strings of this type contain the names of parameters, headers of dialog boxes, etc.
  • Event code. The strings of this type contain messages displayed in the trace.
  • Description. The strings of this type describe the purpose of definitions.
  • Tooltip. The strings of this type describe pop-up hints for parameters, selector fields and other interface elements.
  • Code. The strings of this type are present in the program code (i.e. the strings are defined in software, not in the editor). They can include strings displayed in the trace, hints, headers.

Export filter.jpg

Import strings.jpg

Import Strings

Imports the multilanguage strings from a file of XLS format. For details, refer to Importing Multilanguage Strings from File.

prev.png

Go to Previous Value
(Ctrl+<)

Goes to the previous string.

next.png

Go to Next Value
(Ctrl+>)

Goes to the next string.

prev-q.png

Go to Previous Unchecked Value (Ctrl+K)

Goes to the previous unchecked string.

next-q.png

Go to Next Unchecked Value (Ctrl+L)

Goes to the next unchecked string.

-

Search

Searches for a string in the list. To start searching, enter the text fragment in the Search field.

Show filter.jpg

Show Filters

Opens the dialog box used to define the filter parameters. If at least one filter is configured for multilanguage strings (except for Layers), the Show filters button is displayed pressed.

Setting up Filters

To set up the multilanguage string filter, use a special dialog box that looks as follows:

Set filter1.jpg

The dialog box contains the following elements:

  • Additional filters area:
  • Layers. The filter by ADS and DDS layers / modules. If the filter is not configured, all the layers defined in the development branch will be used.
  • The filters used to show / hide the strings by a certain attribute. The strings are displayed in the list if the respective flag is set:
  • Show only published definitions. Shows the strings contained in public definitions. The flag is not set, by default.
  • Show commented strings. Shows the strings that are not displayed in the interface (these strings are commented in the source code). The flag is set, by default.
  • Show empty strings. Shows the strings containing empty phrases. The flag is set, by default.
  • Show not empty strings. Shows the strings containing phrases defined in all languages. The flag is set, by default.
  • Created area:
  • From / To. The start date and the end date for the period when the multilanguage strings were created.
  • Created by. The user who created the multilanguage string.
  • Status changed area used to configure the filter by the status change from Checked to Not checked:
  • From / To. The start date and the end date for the period when the string status was changed.
  • The type of the language for the phrases whose status was changed within the specified period. The parameter is available if the period is specified. The value is selected from the predefined list. Available values:
  • Source languages
  • Target languages
  • All languages. All languages available in the layers selected for translation.

If the Select language flag is set, the language is selected from the drop-down list of available languages.

  • String type area used to configure the filters by the string type. The strings of a certain type are shown in the list if the respective flag is set (all flags are set, by default):
  • Title. The strings of this type contain the names of parameters, headers of dialog boxes, etc.
  • Event code. The strings of this type contain messages displayed in the trace.
  • Description. The strings of this type describe the purpose of definitions.
  • Tooltip. The strings of this type describe pop-up hints for parameters, selector fields and other interface elements.
  • Code. The strings of this type are present in the program code (i.e. the strings are defined in software, not in the editor). They can include strings displayed in the trace, hints, headers.
  • XSD element description. The strings of this type describe XSD schema elements.
  • Last modified area:
  • From / To. The start date and the end date for the period when the strings were edited.
  • The type of the languages used when editing the strings within the specified period. The parameter is available if the period is specified. The value is selected from the predefined list. Available values:
  • Source languages
  • Target languages
  • All languages. All languages available in the layers selected for translation.

If the Select language flag is set, the language is selected from the drop-down list of available languages.

  • Last modified by area:
  • The name of the user who last edited the multilanguage string.
  • The type of the languages used when editing the strings by the specified user. The parameter is available if the user is specified. The value is selected from the predefined list. Available values:
  • Source languages
  • Target languages
  • All languages. All languages available in the layers selected for translation.

If the Select language flag is set, the language is selected from the drop-down list of available languages.

  • Show mode area used to configure the filters by strings with unchecked phrases:
  • Show strings with unchecked source. If the flag is set, the list will contain the strings with the phrases unchecked in the source languages. The flag is set, by default.
  • The field used to define the list of strings to be displayed. Available values:
  • All multilanguage strings. Displays all the strings.
  • Not checked in <Language> (where <Language> is the target language). Displays the strings with the unchecked phrases in the specified target language.

Importing Multilanguage Strings from File

To import multilanguage strings from an XLS file, use the Import Strings command (Import strings.jpg button) on the toolbar of the multilanguage string editor. The dialog box of command execution contains the following parameters:

  • File location. The path to the import file.
  • Mark as checked. If the flag is set, the Checked status will be set for all strings being imported. When setting the Mark as agreed flag, this flag is set automatically and is unavailable for editing.
  • Mark as agreed. If the flag is set, all strings being imported will be marked as agreed.

Import phases.jpg

The command specifics is as follows:

1. An import file should be a file the strings have been previously exported to using the Export Strings command, containing the modified strings. To ensure correct import, the file structure should remain unchanged. It is only possible to edit the phrases in the multilanguage strings.

2. When the import is performed, the strings from the file are searched for in the multilanguage string editor; the new values in the file are written to the strings found in the editor. If a multilanguage string to be updated during the import is not found, the Output window will display the respective message containing information on this string.

3. If the same phrase is edited in the multilanguage string editor and in the XLS file after the strings have been exported, a conflict will occur. To resolve conflicts occurred during the import, use a special dialog box:

Import Conflicts wiki.jpg

This dialog box contains a table with the list of conflict strings including:
  • String ID and name of the definition where this string is used
  • The Current value column contains the value of the phrase from the multilanguage string editor and information on this phrase (language, date when the phrase was last modified and user who last modified it).
  • The Value from file column contains the value of the same phrase from the file and information on this phrase (language, date when the phrase was last modified and user who last modified it).
The list can contain several conflict phrases in different languages for the same multilanguage string.

For unresolved conflicts, the phrases both from the editor and from the file are marked with Question.png icon. After the conflict is resolved, the accepted phrase is marked with Done.png icon and the declined one - with Cancel command.jpg icon.

To resolve a conflict, select the correct value using one of the following methods:
  • Double-click on the cell with the required value.
  • Select the required value and click Done.png (Accept Value).
  • Accept all the values from the multilanguage string editor by clicking AcceptAllCurrentValues.jpg button (Accept All Current Values).
  • Accept all the values from the file by clicking AcceptAllValuesFromFile.jpg button (Accept All Values from File).
Note.jpg If the string contains conflict phrases in different languages, it is possible to select the correct value for each language. For example, it is possible to leave the current value from the editor for Russian and apply the value from the file to the phrase in English.
To move to the previous / next string, use Prev.png (Previous Conflict) and Next.png (Next Conflict) buttons.
To apply the changes made when resolving the conflicts, click the OK button that becomes active after all the conflicts have been resolved. The changes are not made to the conflict strings when clicking Cancel, the Output window will display the respective message.

4. After executing the command, save the changes in the modified strings.

Translation Pane

The translation pane is used to define and edit the translations of the multilanguage strings. The upper part of the pane displays the source text of the multilanguage string; the fields used to define the translations are located below. It is possible to edit both translations and texts in the source language.

The fields change their size depending on the number of strings in the text.

It is possible to change the translation status by clicking the icon above the respective text field.

The table below describes the supported keyboard shortcut:

Keyboard Shortcut

Action

Ctrl+Enter

Marks the current translation as "checked" and goes to the next translation. If all translations are marked, the multilanguage string status will be set to "checked".

Ctrl+L

Goes to the next translation without changing the status of the current one.

Ctrl+K

Goes to the previous translation.

Ctrl+>

Goes to the next unchecked translation.

Ctrl+<

Goes to the previous unchecked translation.

Hint Pane

The hint pane is used to get additional information for translation. It contains the Context, Phrases and Time/Author Info pages. The Context page provides the information on the context of the current multilanguage string. Clicking the name of the current definition opens the definition editor.

The Phrases page contains the toolbar and the table containing a list of possible translations from the loaded phrase books for the current translation language (the language with the cursor in the translation field). If the text of the multilanguage string was translated and marked as "checked", such translation will be also displayed in the list.

The table below describes the toolbar buttons:

Button

Name

Description

open-pb.png

Open Phrase Book

Opens the definitions search dialog box where it is possible to select one or several phrase books. At that, the multilanguage strings from the selected phrase books are displayed as a hint in the table.

edit-pb.png

Edit Phrase Book

Opens the menu with the lists of all opened phrase books. When selecting one of the menu items, the editor of the respective phrase book is displayed.

close-pb.png

Close phrase book

Opens the menu with the list of all opened phrase books. When selecting one of the menu items, the respective phrase book is closed, i.e. its multilanguage strings are not displayed as a hint in the table.

The hint table consists of three columns. The first column contains the texts of multilanguage strings in the source languages and the icons displaying the hint location (the phrase book or one of the previously translated multilanguage strings). The second column displays the translation, the third one displays the comments to the multilanguage string.

The hints from the phrase books can be edited. For this purpose, select the Edit item from the string context menu. At that, the phrase book definition editor will open.

To insert one of the suggested variants into the translation field, double-click the list element and select the Accept item from the string context menu. At that, the text translated into the respective language will be inserted in the field.

The Time/Author Info page provides the information on the date and the author of the last modification. The table contains the following columns:

  • Language. The target language for multilanguage strings.
  • Last modified by. The name of the user who last edited the phrase in the specified language.
  • Last modified. The date and time when the phrase was last edited.
  • Status changed by. The name of the user who last changed the phrase status from Checked to Not checked.
  • Status changed. The date and time when the status was last changed from Checked to Not checked.

The Created by and Creation date parameters in the lower part of the page contain the information on the user who created the string and the date when the string was created.

The Warnings page contains the list of warnings for the current translation:

  • The "&" character was lost in the translation or in the source text.
  • The punctuation mark ("!", "?", ".", ":") was lost at the end of the translation or the source text.
  • The hint from the phrase book was ignored.
  • The translation format does not match the source text format, or vice versa.
  • The tag was lost: if the source text or translation is html (it starts with "<html>"), the system checks whether the respective tags are present in the source text or translation.
  • If the source text contains the following characters: %1, %2, …, %n, the translation must also contain %1, %2, …, %n, and vice versa.

This page is displayed only if there are warnings for the current translation.