From 8903bb4f03af485c7079ac1c068ca311ada17904 Mon Sep 17 00:00:00 2001 From: lordmulder Date: Wed, 5 Jan 2011 22:54:31 +0100 Subject: [PATCH] Added guide for translators. --- doc/translate.html | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 doc/translate.html diff --git a/doc/translate.html b/doc/translate.html new file mode 100644 index 00000000..7124b892 --- /dev/null +++ b/doc/translate.html @@ -0,0 +1,43 @@ + + + +Howto: Translate LameXP v4.xx + + + +

Howto: Translate LameXP

+

If you are willing to contribute a new LameXP v4.xx translation or update/fix an existing translation, then this guide will help you to do so :-)

+
+

Prerequisites:

+

LameXP v4.00 is a complete re-write of LameXP. This time LameXP is developed in C++ and it is based on the Qt cross-platform application framework. The good news for translators is that Qt provides full Unicode support, which was also one of the main reasons for the re-write. Consequently there will be no more headache with different Codepages! Furthermore the Qt framework provides a sophisticated translation system, which allows for easy internationalization and localization. There even is an easy-to-use graphical tool for translating Qt application, the Qt Linguist. So before you start translating, you should make yourself familiar with the Qt Linguist application first. As a translator, having a quick look at the guide for translators should be sufficient.

+

You can download Qt Linguist as a part of the Qt Framework, which is available as a free download from the Qt download site. You should pick the "LGPL" version and the "framework only" download.

+
+

Editing the language file:

+

LameXP v4.xx translations are created as TS (translation) files, which can be edited using the Qt Linguist application. For new translations an empty TS file ("Blank.ts") is provided in the LameXP Git repository. When you open the empty TS file for the first time, Linguist will ask for some basic settings. Here you must keep the "Source language" options at "English" and "Any Country". Change the "Target language" options to whatever language (region) you are going to translate too. Once you have edited all (or some) text strings, you can save your work to a TS file again. It is recommended to save your work to "LameXP_XX.ts", where XX should be replaced with the suitable upper-case ISO 639-1 country code (for example the German translation is saved as "LameXP_DE.ts"). You can re-open your TS file at any time in order to continue with your work. In case you want to improve an existing LameXP translation, simply download the corresponding TS file from the LameXP Git repository and edit it using the Qt Linguist tool.

+

The latest translation (TS) files can always be found in the LameXP Git repository at:
https://github.com/lordmulder/LameXP/tree/master/etc/Translation

+

Important: Before you start translating, always make sure your download the latest "Blank.ts" file from the LameXP Git repository. If you want to edit an existing translation, including translations you have created yourself, make sure your download the latest TS file from the LameXP Git repository. Never ever do any translations based on an old working copy (TS file) from your local system! The translation files in the repository will be updated, as the development proceeds.

+
+

Language file editing rules:

+Only language files that have been edited according to the following rules can be accepted: + +
+

Personalization:

+

Usually all translators will be mentioned in the "About..." dialogue. If you don't want your name and/or e-mail address to appear there, please tell us how you want to be credited!

+
+

Testing your translation:

+

Currently LameXP v4.xx needs to be re-built from the sources in order to integrate and test new translations. A more convenient method will be added soon.

+
+

Submitting your translation:

+

Once you are done with your translation, you can submit it, so it can be included in the next LameXP release. You can contact me by e-mail:
mulder2[at]gmx[dot]de

It is sufficient to submit the translation file (*.ts). You don't need to compress the language file (ZIP, RAR, etc) and you don't need to attach a flag icon file.

+

(Note: Advanced translators can get write-access to the Git repository on request, so they can keep their translations up-to-date easily)

+
+
+Thanks in advance !!! + +