WebIssues/Translation

From MiMec
< WebIssues
Revision as of 08:38, 3 January 2011 by Mimec (talk | contribs) (Translation Files)
Jump to: navigation, search

WebIssues use the Qt Linguist application for translating both the desktop client and the web client applications. In both cases the process looks very similar.

Translation Files

Translators operate mainly on the .ts files which are located in translations directory in case of the Desktop Client and common/data/translations directory in case of the Web Client. There is one .ts file for each language, for example webissues_pl.ts for Polish and webissues_pt_BR.ts for Brazilian Portuguese translation. There is also one webissues_untranslated.ts file which can be used for creating new translations.

In order to translate phrases in the .ts file you will need the Qt Linguist application which is shipped with the Qt Framework and available for all platforms including Linux, Windows and Mac OS. The detailed user guide can be found in the Qt documentation.

If you are using Windows and don't want to download and install the entire Qt framework, you can use the stand-alone version of Qt Linguist: Linguist.zip.

Translation Process

A week or two before a planned release a "string freeze" is announced, meaning that code cannot be added or modified if that changes any user visible strings. All .ts files are updated to reflect changes in the code made since the previous version and that causes some new untranslated strings to appear. The updated .ts files are sent to the translators responsible for each language and they should send back the completed files. Finally, binary files are generated from the .ts files and included in the release packages.

Desktop Client

In case of the desktop client, standard lupdate and lrelease tools from Qt Framework are used to update and compile the translation files. For testing purposes translators can manually release the translation files (this can be done directly using the Qt Linguist). The latest version of the sources must be then downloaded from the SVN repository and recompiled.

When translation for a new language is created, the new .ts file needs to be added to the TRANSLATIONS list in the src/src.pro project file. Also the name and code of the language must be added to src/dialogs/settingsdialog.cpp, near line 70, where the addLanguage function is called for each language.

Web Client

A special set of tools, called lupdatephp and lreleasephp, were created to support translation of the web client application (for the development version of WebIssues 1.0). They work almost the same as their standard counterparts, but they understand the coding conventions used in the PHP application and use a different format of the compiled file (which is more efficient to use with PHP that the binary format). These tools can be found in the trunk/tools directory in the SVN repository. You can also download Windows binaries if you don't want to compile them manually: LinguistPhp.zip.

When a new translation is created, the common/data/locale.ini file on the server needs to be modified with additional information. The code and name of the new language must be added to the languages section. Also a section with the same name as the language code must be created, containing the format of numbers, dates and times and the first day of week (counting Sunday as 0) for that culture.