aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorY. Wang <yw05@forksworld.de>2022-11-01 20:20:55 +0100
committerY. Wang <yw05@forksworld.de>2022-11-01 20:20:55 +0100
commita6fc6497e7f187f8fac1d72d826ac893b689f2f6 (patch)
tree379ce859137a522e64754e8603efbda3845c6253
parented7e3249b0d20e5e36ab258be6aa74b2ad15ebe6 (diff)
downloadadvtrains-a6fc6497e7f187f8fac1d72d826ac893b689f2f6.tar.gz
advtrains-a6fc6497e7f187f8fac1d72d826ac893b689f2f6.tar.bz2
advtrains-a6fc6497e7f187f8fac1d72d826ac893b689f2f6.zip
Reformat l10n README
-rw-r--r--advtrains/locale/README.md58
1 files changed, 47 insertions, 11 deletions
diff --git a/advtrains/locale/README.md b/advtrains/locale/README.md
index 19114e5..ec4d4c7 100644
--- a/advtrains/locale/README.md
+++ b/advtrains/locale/README.md
@@ -2,22 +2,58 @@
Please read this document before working on any translations.
## Getting Started
-If there is a translation file for your language (e.g. German), you can edit the file directly. Please read [the documentation on the translation file format](https://minetest.gitlab.io/minetest/translations/#translation-file-format) for more information.
-If the translation file for your language needs to be created, create it by copying `template.txt` to `advtrains.XX.tr`, where `XX` is replaced by the language code.
+If there is a translation file for your language (e.g. German), you can
+edit the file directly. Please read [the documentation on the
+translation file format][tr-format].
+
+Alternatively, Advtrains provides a script named `gui` that can be used
+to, among other things, edit translation files. The script requires
+Tcl/Tk 8.6, which is provided by most Linux distributions.
+
+If the translation file for your language does not exist, create it by
+copying `template.txt` to `advtrains.XX.tr`, where `XX` is replaced by
+the language code.
+
+Feel free to use the [discussion mailing list][srht-discuss] if you
+have any questions regarding localization.
+
+You can share your `.tr` file directly or [as a patch][gsm] to the [dev
+mailing list][srht-devel]. The latter is encouraged, but, unlike code
+changes, translation files sent directly are also accepted.
+
+[tr-format]: https://minetest.gitlab.io/minetest/translations/#translation-file-format
+[srht-discuss]: https://lists.sr.ht/~gpcf/advtrains-discuss
+[srht-devel]: https://lists.sr.ht/~gpcf/advtrains-devel
+[gsm]: https://git-send-email.io
## Translation Notes
-* Translations should be consistent. Use translations in Minetest as a reference.
+* Translations should be consistent. You can use other entries or the
+translations in Minetest as a reference.
+* Translations do not have to fully correspond to the original text -
+they only need to provide the same information. In particular,
+translations do not need to have the same linguistical structure as the
+original text.
* Replacement sequences (`@1`, `@2`, etc) should not be translated.
-* Certain abbreviations or names, such as "Ks" or "Zs 3", should generally not be translated.
+* Certain abbreviations or names, such as "Ks" or "Zs 3", should
+generally not be translated.
### (de) German
-* Verwenden Sie die neue Rechtschreibung und die Sie-Form
-* Mit der deutschen Tastaturbelegung unter Linux können die Anführungszeichen „“ durch AltGr-V bzw. AltGr-C eingegeben werden.
+* Verwenden Sie die neue Rechtschreibung und die Sie-Form.
+* Mit der deutschen Tastaturbelegung unter Linux können die
+Anführungszeichen „“ mit AltGr-V bzw. AltGr-C eingegeben werden.
### (zh) Chinese
-(This section is written in English to avoid writing the note twice or using only one of the variants, as most of this section applies to both the traditional and simplified variants.)
-* Please use the 「」 quotation marks for Traditional Chinese and “” for Simplified Chinese.
+(This section is written in English to avoid writing the note twice or
+using only one of the variants, as most of this section applies to both
+the traditional and simplified variants.)
+
+* Please use the 「」 quotation marks for Traditional Chinese and “”
+for Simplified Chinese.
* Please use the fullwidth variants of: , 、 。 ? ! : ;
-* Please use the halfwidth variants (i.e. variants used with Latin alphabets) of: ( ) [ ] / \ |
-* Please do not leave any space between Han characters (including fullwidth punctuation marks).
-* Please leave a space between Han characters (excluding fullwidth punctuation marks) and characters from other scripts (including halfwidth punctuation marks). However, do not leave any space between Han characters and Arabic numerals.
+* Please use the halfwidth variants of: ( ) [ ] / \ |
+* Please do not leave any space between Han characters (including
+fullwidth punctuation marks).
+* Please leave a space between Han characters (excluding fullwidth
+punctuation marks) and characters from other scripts (including
+halfwidth punctuation marks). However, do not leave any space between
+Han characters and Arabic numerals.