WesWorkshop / Wiki / translations

Published Translations

The following translations are already available:

English (English)*
Italian (Italiano)*

Starred elements are distributed with the program.

How to...

Check the translations folder;
Create a new translation;
Compare two translations;
Use a translation released outside the program;

Note: the following paragraphs have been copied from http://wesworkshop.altervista.org/translation.php.

Check the translation folder

From v1.2 -Black Pawn- you can compare two translations. This option has been thought to help translators.From WesWorkshop go to the Tool menu and select the Translations checker option.A window will be opened. The window is vertically divided into two blocks.

The translations folder checker is the left block, titled "Check translations folder".

The translations folder checking process scans the locale.xml file and the translations folder.It signals as error languages registered in the locale.xml file with no corresponding folder.Languages folder extra files are signaled as errors too. Non ini files are signaled as errors too. Languages folder sub-directories which are not registered in the locale.xml file are signaled as warnings.
By default the tool checks WesWorkshop locale folder. You can change the checked translations by clicking the button marked with an opened folder. The scan process starts as soon as you have selected a folder.

Create a new translation

Creating new translations is quite easy. Go to your locale folder and choose the folder from which you will translate. The folders are named using the first three letters of the proper language name (ex. English ⇒ eng, Deutch ⇒ deu -German-, Italiano ⇒ ita -Italian-). Copy the folder you have chosen and translate each file. Each folder contains some ini files. Each file contains rows like key=value. To make your own translation you have to change the strings value. You mustn't change the key value nor the file names because your strings would not be loaded. To add a completed translation read the next paragraph.

VERY IMPORTANT: if your string contains non ascii characters (such as accented letters) format the string using html.An example:
Original:
Choose which specials are associated to this attack.
Translated (it):
<html>Scegli quali specialità sono associate a questo attacco.</html>
Result:
Scegli quali specialità sono associate a questo attacco.

Without the html encoding the result is not assured. The same example can produce different results:
Without html (it):
Scegli quali specialità sono associate a questo attacco.
Result (bad parsing):
Scegli quali specialit¿ù? sono associate a questo attacco.
Result (good parsing):
Scegli quali specialità sono associate a questo attacco.

Which result is shown depends on the translated file char encoding. UTF encoding will lead to bad parsing, ASCII encoding will lead to good parsing. To be sure of the result please use html fortmatting and html encoding.

Compare two translations

The translations comparator is the right block, titled "Compare translations".

The default reference is the english translation. You can change it by clicking the left button marked with an openedfolder. By clicking the right button marked with an opened folder you can choose the translation to be compared.To select a translation you have to select the folder containing it.The translations comparison will begin as soon as you have set the second translation.The tool will scan the two translations looking for differences. The translation comparison works as follow:

The tool scans the two translation folders;
If a file is stored in the first folder but not in the second one it's signaled as an error for the second translation: file X is missing;
If a file is stored in the second folder but not in the first one it's signaled as an error for the first translation: file X is missing;
If both translations contain the file X the tool opens the two files and checks the two key sets:

Each key stored in the first file but not in the second one is signaled as an error for the second translation: filed Y is missing,
Each key stored in the second file but not in the first one is signaled as an error for the first translation: filed Y is missing,
If the field is stored in both files no message is shown;

If both files have the same keys the files are signaled as ok.

Use a translation released outside the program

If you want to add a translation which wasn't included with the program you have to follow the following steps:

copy the translation folder to your locale folder;
edit the file locale.xml stored in the locale folder by adding the following fields before the last line (</locale>):
1. <language>;
2. <name>;
3. language proper name, this value will be shown in the locale menu. Use the proper name of the language (ex. English ⇒ English, German ⇒ Deutch, Italian ⇒ Italiano);
4. </name>;
5. <file>;
6. translation file name, use the folder name or your translation won't be loaded. Usually translation folder names are the first three letters of the proper language name (ex. English ⇒ eng, Deutch ⇒ deu -German-, Italiano ⇒ ita -Italian-);
7. </file>;
8. <icon>;
9. the name of the flag file, this is used to set the icon of the language in the locale menu. A complete list of available flags can be found in the image folder, flag file names start with "flag_". If the language flag of the new translation is not available leave this field empty;
10. </icon>;
11. </language>;

An example is:

<language>
 <name>Italiano</name>
 <file>ita</file>
 <icon>flag_italy.png</icon>
</language>

WesWorkshop Wiki

Create units and attacks for Wesnoth!

translations