Translations: Explain the syntax of txt files
authorWuzzy
Thu, 21 Sep 2017 17:06:31 +0100
changeset 1034 f55656ceb224
parent 1033 ea42a17739d0
child 1035 8d69a25f70cc
Translations: Explain the syntax of txt files
Translations.wiki
--- a/Translations.wiki	Thu Sep 21 00:57:30 2017 +0100
+++ b/Translations.wiki	Thu Sep 21 17:06:31 2017 +0100
@@ -42,10 +42,32 @@
 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.
 
 === 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
+ * `/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)
 
-==== .lua files ====
+==== `.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”.
+
+Each line follows this format:
+
+`XX:YY=Translation`
+
+For example:
+
+`00:00=Grenade`
+
+See `en.txt` for the English original texts. Note that some of the numbers may be missing in your file, so you need to add them on your own.
+
+The group `02` is special because texts can be repeated here. These texts are used for event messages like the death of a hedgehog (`02:00`). Hedgewars will randomly use any of these messages in the same group. Each language can have its own set of messages for this. Translations can be rather flexible here.
+In `02`, you don't need to translate every English message, but try to do your best. It is OK to omit messages if a direct translation wouldn't make sense (e.g. for weird English idioms). You can also invent your messages which are more appropriate for your language. If you're in a hurry, you can just add single a single message for each of the `02` groups (`02:00`, `02:01`, `02:02`, etc.), but don't forget to finish it later. Hedgewars will only use the messages in your language file here.
+
+In the `04` and `05` groups, you can use two special characters:
+The `|` character is used as a line break.
+Also, for each line, all text written before a colon (`:`) including the colon itself will be highlighted.
+
+Don't forget to test these texts in-game to make sure everything looks fine.
+
+==== `.lua` files ====
 In a `.lua` file you will find many lines like this:
 
 ```["Rubber Band"] = "", -- Construction_Mode```