author | Wuzzy |
Sun, 27 Nov 2016 04:37:17 +0000 | |
changeset 940 | 8c4a529edddb |
parent 923 | afa2ae557fb3 |
child 974 | 67928dabac03 |
permissions | -rw-r--r-- |
365 | 1 |
#summary This is a guide for new translators. |
2 |
||
751 | 3 |
= Translations = |
4 |
== Introduction == |
|
365 | 5 |
|
6 |
This is a guide for translators. In order to translate Hedgewars into another language you are going to need: |
|
7 |
||
8 |
# The latest Hedgewars localization files |
|
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
9 |
# A text editor like Notepad++, Geany, Vim, etc. |
365 | 10 |
# Qt4 Linguist. To download the Qt4 Linguist you have to download the Qt4 SDK. |
11 |
||
751 | 12 |
== Getting the localization files == |
365 | 13 |
|
14 |
To get the Hedgewars localization files there are 4 possible ways. |
|
15 |
||
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
16 |
* *A*. Clone the Hedgewars source repository. |
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
17 |
* *B*. Download the latest Hedgewars source code. |
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
18 |
* *C*. Find the localization files in your current Hedgewars installation. |
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
19 |
* *D*. Download only the specific files to be translated. |
365 | 20 |
|
21 |
The *A* is maybe the most convenient way to include the translations in the next Hedgewars release as you can easily produce a patch to provide it to the Hedgewars developers. Note that a fast internet connection is desired as you probably will clone the whole game sources. The other advantage of this way is that it can be used to translate the latest game version that is going to be released. |
|
22 |
||
23 |
The *B* way is a lot like the *A* way but more limited. |
|
24 |
||
25 |
The *C* is probably the fastest way and the more convenient for the translator. |
|
26 |
However, it has the limitation that one can only translate the most recent Hedgewars release (the one currently installed) and not the version that is going to be released. |
|
27 |
||
798
30c5f1ebd552
global replace of http with https for hedgewars.org wiki links
nemo
parents:
751
diff
changeset
|
28 |
The *D* way is to download the desired files from [https://hg.hedgewars.org/hedgewars/raw-file/default/share/hedgewars/Data/Locale/ here]. |
365 | 29 |
|
30 |
Above I am going to discuss the *C* way (Find the localization files in your current Hedgewars installation). |
|
31 |
||
751 | 32 |
=== Finding the localization files === |
365 | 33 |
|
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
34 |
In GNU/Linux you have to look into `/path-to-Hedgewars/Data/Locale where path-to-Hedgewars` is the path to your Hedgewars installation. |
365 | 35 |
|
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
36 |
In Windows you have to look into `c:\path-to-Hedgewars\share\Hedgewars\Data\Locale` where path-to-Hedgewars is the path to your Hedgewars installation. |
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
37 |
|
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
38 |
For example in an Arch Linux box the path is `/usr/share/Hedgewars/Data/Locale`. |
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
39 |
In a Windows 8 box the path is `C:\Program Files (x86)\Hedgewars 0.9.19\Data\Locale`. |
365 | 40 |
|
751 | 41 |
== Translation files == |
922 | 42 |
Here is a list of the different localization files of the English language that you should use as your translation reference/template as it should be the most accurate and up to date. The file locations are relative to the top directory of the Hedgewars source code. You can edit all these files with a text editor, but for some files special editors are available. |
365 | 43 |
|
923 | 44 |
=== Engine (in-game stuff) === |
45 |
* `/share/hedgewars/Data/Locale/en.txt`—This contains the core in-game strings, such as the mission panel, the messages at the top, ammo names and descriptions |
|
46 |
* `/share/hedgewars/Data/Locale/stub.lua`—Strings used by Lua scripts, which includes campaigns, missions and game styles |
|
47 |
||
48 |
=== Frontend (main menu) === |
|
49 |
* `/share/hedgewars/Data/Locale/hedgewars_en.ts`—Contains most strings of the frontend and you can edit it with Qt Linguist |
|
670 | 50 |
* `/share/hedgewars/Data/Locale/missions_en.txt`—This is the [Missions mission] description strings |
51 |
* `/share/hedgewars/Data/Locale/campaigns_en.txt`—This is the campaign description strings |
|
52 |
* `/share/hedgewars/Data/Locale/tips_en.xml`—This contains the tips shown in the main menu. This file is *not* in XML format! |
|
669 | 53 |
|
923 | 54 |
==== Mission map descriptions ==== |
55 |
The map selection shows brief descriptions for mission maps below the preview image. Those can be translated and you find those texts in: |
|
883 | 56 |
|
57 |
* `/share/hedgewars/Data/Maps/<map name>/desc.txt` |
|
58 |
||
921 | 59 |
Replace “`<map name`>” with the name of any mission map. To translate these, add a line of the format `language code=description` (e.g. “en=This is an example.” for English). Since version 0.9.23, you must use the following special character sequences for new lines, commas and underscores: |
60 |
||
61 |
|| *Written text* || *Is replaced by* || |
|
62 |
|| `_n` || New line || |
|
63 |
|| `_c` || Comma || |
|
64 |
|| `__` || Underscore || |
|
883 | 65 |
|
923 | 66 |
=== Metadata === |
67 |
The following files are not used by Hedgewars itself, but they contain translatable metadata about Hedgewars: |
|
68 |
||
69 |
* `/share/hedgewars/Data/misc/hedgewars.desktop`—[https://wiki.freedesktop.org/www/Specifications/desktop-entry-spec/ Desktop Entry] file for the Hedgewars application |
|
70 |
* `/share/hedgewars/Data/misc/hwengine.desktop.in`—Desktop Entry file for the Hedgewars engine for playing savegames and demos |
|
71 |
* `/share/hedgewars/Data/misc/hwengine.desktop`—*Do not translate*! This file will be automatically generated from `hwengine.desktop.in` when building Hedgewars |
|
72 |
* `/share/hedgewars/Data/misc/hedgewars-mimeinfo.xml`—Description of Hedgewars file types |
|
73 |
||
751 | 74 |
== Updating an existing translation == |
365 | 75 |
|
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
76 |
That is relatively easy. Just edit the existing file. You can edit every file with your favorite editor and the `.ts` file with Qt Linguist. |
365 | 77 |
|
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
78 |
The `en.lua` file doesn’t exist. The strings are hard coded in the code. |
365 | 79 |
|
751 | 80 |
== Creating a new translation == |
365 | 81 |
|
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
82 |
That is easy, too. Make a copy of the English file and rename it to use the initials of your language. |
368
2982cf17f347
Edited wiki page Translations through web user interface. Mention stub.lua
pntanasis@gmail.com
parents:
367
diff
changeset
|
83 |
|
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
84 |
The `en.lua` file doesn’t exist. Use `stub.lua` instead as your template. |
368
2982cf17f347
Edited wiki page Translations through web user interface. Mention stub.lua
pntanasis@gmail.com
parents:
367
diff
changeset
|
85 |
|
365 | 86 |
Here are 3 examples: |
87 |
||
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
88 |
* For French copy `en.txt` to `fr.txt` |
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
89 |
* For Spanish copy `en.txt` to `es.txt` |
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
90 |
* For Greek copy `en.txt` to `el.txt` |
365 | 91 |
|
751 | 92 |
== Testing the translations == |
365 | 93 |
|
94 |
When finished you have just to start Hedgewars and choose your language from the Game Preferences, Advanced tab. |
|
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
95 |
|
365 | 96 |
If a translation is missing then the string is going to be displayed in English. |
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
97 |
Note that you should restart the frondend for the language changes to take effect. |
365 | 98 |
|
751 | 99 |
== Sharing the translations == |
365 | 100 |
|
496
24ffc984d617
Copy editing, add tips_en.xml to list of translation files
almikes@aol.com
parents:
368
diff
changeset
|
101 |
In order to share your translations with Hedgewars community there are 3 possible ways: |
365 | 102 |
|
905 | 103 |
# Give them the files and tell them where to place them. Of course this is the less convenient way but it is maybe a good approach to let other players double-check your translations |
906 | 104 |
# Talk with a Hedgewars developer in order to include it in [https://hedgewars.org/content.html DLC] |
905 | 105 |
# Talk with a Hedgewars developer in order to include it in the next Hedgewars release |
365 | 106 |
|
751 | 107 |
== Things to have in mind == |
365 | 108 |
|
109 |
If you are going to make a translation for a next Hedgewars release strings may not be frozen yet and change before the release. Better ask in irc in cases like that. |