# 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.xx 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. As a translator, having a quick look at the guide for translators is sufficient.

You can download Qt Linguist as a part of the Qt Framework (SDK), which is available as a free download from the Qt download site. You should pick the "Qt SDK" and download the "Online installer" (∼15 MB), but you do not need to worry about a "commercial" license. In the Qt SDK Setup wizard, make sure you select the "Custom" install type. Then un-check all components, except for "Qt SDK" ⇒ "Development Tools" ⇒ "Qt Liguist". Alternatively, if you don't want to install the Qt SDK on your computer, you can find Qt Linguist for Windows as a stand-alone download at this location (only ∼4 MB). The stand-alone Linguist version has been built using static Qt libraries and thus should work "out of the box", just unzip the ZIP file and run the "linguist.exe" file.

### 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, Qt 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 to. 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 Code for the representation of names of languages (for example the German translation is saved as "LameXP_DE.ts", because the corresponding ISO 639-1 code is DE). 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
After you have chosen a file from the directory tree, you can download the file by right-clicking on "raw" an choosing "Save Link Target As...".

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 continuously, as the development proceeds.

### Language file editing rules:

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

- The translated string should not be significant longer (or shorter) than the original string, so the layout isn't destroyed.
- Strings don't have to be translated literally, as long as the original meaning is retained.
- Do not use any HTML-style tags, like `<b>…</b>`, `<i>…</i>` or `<u>…</u>` in your translated text, except when present in the original string.
- Take care of the C printf syntax: All the `%s` and `%d` placeholders must remain in the translated strings, at the appropriate position.
- All Qt-style placeholders, like `%1`, `%2` and so on, must remain in the translated strings, at the appropriate position.
- Once the translation for a string is finished, please click the 'mark item as done' button, so the item (string) gets a green ✔ icon.
- Note that the red ! icon and the yellow ✔ icon indicate that there is some problem with your translation, which needs to be resolved!

### Testing your translation:

LameXP v4.xx needs to be re-built from the sources in order to integrate a new translation or to update one of the "built-in" translations. However there is an easy method to test your translation file without re-building LameXP: Open your current translation (TS) file in the Qt Linguist application and goto "File" ⇒ "Release As...", which allows you to save your translation as a "release" (QM) file. Once saved as a QM file, you can load your translation in LameXP. Just goto "View" ⇒ "Language" ⇒ "From File..." and choose the desired QM file. Your translation should be in effect immediately. If you notice that your translation needs further modifications, go back to the TS file for editing. Then, for your next test run, create a new QM file from the updated TS file.

### Submitting your translation:

Once you are done with your translation (i.e. all items and all contexts have a green ✔ icon), you can submit it, so it can be integrated into the next LameXP release. You can contact me by e-mail:
mulder2[at]gmx[dot]de

Please do not submit translations that have any items/context with ✔, ?, ? or even ! icon left. Also do not submit QM files, do not compress the submitted file (ZIP, RAR, etc) and do not attach a flag icon file. It is sufficient to submit the translation (TS) file.

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

### Personalization:

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

Thanks in advance !!!