Translations: Add overview
authorWuzzy
Sat, 21 Oct 2017 14:16:47 +0100
changeset 1085 f90f098fb347
parent 1084 37eb1e994b1f
child 1086 3333fe1e418d
Translations: Add overview
Translations.wiki
--- a/Translations.wiki	Sat Oct 21 13:55:07 2017 +0100
+++ b/Translations.wiki	Sat Oct 21 14:16:47 2017 +0100
@@ -41,9 +41,24 @@
 == Translation files ==
 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.
 
+=== Overview ===
+These are all files which contain translatable text. Replace “ZZ” with the [https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ISO 639-1 language code] (e.g. “de” for German).
+
+ * `/share/hedgewars/Data/Locale/ZZ.txt`—In-game strings
+ * `/share/hedgewars/Data/Locale/ZZ.lua`—Script transations
+ * `/share/hedgewars/Data/Locale/hedgewars_ZZ.ts`–Frontend
+ * `/share/hedgewars/Data/Locale/missions_ZZ.txt`—Mission names and descriptions
+ * `/share/hedgewars/Data/Locale/campaigns_ZZ.txt`—Campaign names and descriptions
+ * `/share/hedgewars/Data/Locale/tips_ZZ.xml`—Main menu tips
+ * `/share/hedgewars/Data/Maps/<map name>/desc.txt`—Mission map descriptions
+ * `/share/hedgewars/Data/misc/hedgewars.desktop`—[https://wiki.freedesktop.org/www/Specifications/desktop-entry-spec/ Desktop Entry] file for Hedgewars
+ * `/share/hedgewars/Data/misc/hwengine.desktop`—**Do not translate!**
+ * `/share/hedgewars/Data/misc/hwengine.desktop.in`—Desktop Entry file for the engine
+ * `/share/hedgewars/Data/misc/hedgewars-mimeinfo.xml`—File type descriptions
+
 === Engine (in-game stuff) ===
- * `/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 (see below)
- * `/share/hedgewars/Data/Locale/stub.lua`—Strings used by Lua scripts, which includes campaigns, missions and game styles (see below)
+ * `/share/hedgewars/Data/Locale/ZZ.txt`—This contains the core in-game strings, such as the mission panel, the messages at the top, ammo names and descriptions (see below)
+ * `/share/hedgewars/Data/Locale/ZZ.lua`—Strings used by Lua scripts, which includes campaigns, missions and game styles (see below)
 
 ==== `.txt` files ====
 A `.txt` file is organized in lines and string identifiers. Each string is identified with two numbers like `01:05`. The first number is called the “group”.
@@ -87,10 +102,10 @@
 Note to programmers: These `.lua` files are actually containing real Lua source code.
 
 === Frontend (main menu) ===
- * `/share/hedgewars/Data/Locale/hedgewars_en.ts`—Contains most strings of the frontend and you can edit it with Qt Linguist
- * `/share/hedgewars/Data/Locale/missions_en.txt`—This is the [Missions mission] description strings
- * `/share/hedgewars/Data/Locale/campaigns_en.txt`—This is the campaign description strings
- * `/share/hedgewars/Data/Locale/tips_en.xml`—This contains the tips shown in the main menu. This file is *not* in XML format!
+ * `/share/hedgewars/Data/Locale/hedgewars_ZZ.ts`—Contains most strings of the frontend and you can edit it with Qt Linguist
+ * `/share/hedgewars/Data/Locale/missions_ZZ.txt`—This is the [Missions mission] description strings
+ * `/share/hedgewars/Data/Locale/campaigns_ZZ.txt`—This is the campaign description strings
+ * `/share/hedgewars/Data/Locale/tips_ZZ.xml`—This contains the tips shown in the main menu. This file is *not* in XML format!
 
 ==== Mission map descriptions ====
 The map selection shows brief descriptions for mission maps below the preview image. Those can be translated and you find those texts in:
@@ -122,15 +137,15 @@
 
 == Creating a new translation ==
 
-That is easy, too. Make a copy of the English file and rename it to use the initials of your language.
+That is easy, too. Make a copy of the English file and rename it to use the language code. For the files in the `misc` directory, you need to add an additional line for your language (if it is missing).
 
 The `en.lua` file doesn’t exist. Use `stub.lua` instead as your template.
 
-Here are 3 examples:
+Exampl for French:
 
- * For French copy `en.txt` to `fr.txt`
- * For Spanish copy `en.txt` to `es.txt`
- * For Greek copy `en.txt` to `el.txt`
+ * Copy `en.txt` to `fr.txt`
+ * Copy `stub.lua` to `fr.lua`
+ * Copy `hedgewars_en.ts` to `hedgewars_fr.ts`
 
 == Testing the translations ==