Translating Mudlet - Revision history

Kebap at 16:49, 5 September 2025

2025-09-05T16:49:43Z

Kebap at 16:47, 5 September 2025

2025-09-05T16:47:14Z

Kebap: Adding hints for translators

2025-09-05T16:46:22Z

Adding hints for translators

Kebap: Adding hints for translators

2025-09-05T06:40:02Z

Adding hints for translators

Zooka at 07:09, 23 May 2024

2024-05-23T07:09:27Z

Kebap: Add Arabic plural as example

2022-01-25T19:23:50Z

Add Arabic plural as example

FloXire: Fix French plural error for the zero case

2022-01-24T01:27:58Z

Fix French plural error for the zero case

Slysven: Update to "Special notes on separate translations - Plural forms in (American) English"

2022-01-22T01:00:56Z

Update to "Special notes on separate translations - Plural forms in (American) English"

Kebap: /* English (American) translation */ Update instructions

2021-10-18T10:36:21Z

English (American) translation: Update instructions

Vadi at 11:16, 7 November 2020

2020-11-07T11:16:32Z

@@ Line 80: / Line 80: @@
 [[File:Commit changes.png|500px|border]]
-=== Plural forms in (American) English translations ===
+= Notes for Mudlet developers =
 The plural forms in Mudlet's original American English texts need to be handled internally, as the CrowdIn system does not allow for this as a special case where one target locale only contains the plural form whereas the remainder of the source texts are in the required language already. The translation file thus consists only of translations that contain a '''numerus''' (quantity-dependent) translation where the source text varies depending on a quantity.
@@ Line 99: / Line 102: @@
-=== Adding hints for translators ===
+== Adding hints for translators ==
 You should add hints for translators as noted in Mudlet Contributing notes: https://github.com/Mudlet/Mudlet/blob/development/docs/CONTRIBUTING.md

@@ Line 1: / Line 1: @@
 <languages/>
 {{TOC right}}
 <translate><!--T:1--> Thanks for helping translate Mudlet to your language! Mudlet is a free, open-source project and helping it speak your language means a lot to us. :)</translate>

← Older revision		Revision as of 16:46, 5 September 2025
Line 112:		Line 112:
	Especially helpful will be if you use placeholders like %1 and <code>.arg()</code> constructs. Please explain what will go in and how the whole text will read.		Especially helpful will be if you use placeholders like %1 and <code>.arg()</code> constructs. Please explain what will go in and how the whole text will read.

−	Please note Crowdin ~~will~~ mangle your comments, in that it will display <code>"</code> character like <code>"</code> instead, making it harder to read, unfortunately.	+	Please note Crowdin seems to mangle your comments, in that it will display <code>"</code> character like <code>& quot;</code> instead, making it harder to read, unfortunately.

@@ Line 79: / Line 79: @@
 [[File:Commit changes.png|500px|border]]
-== Special notes on separate translations ==
+== Notes for Mudlet developers ==
-=== Plural forms in (American) English ===
+=== Plural forms in (American) English translations ===
 The plural forms in Mudlet's original American English texts need to be handled internally, as the CrowdIn system does not allow for this as a special case where one target locale only contains the plural form whereas the remainder of the source texts are in the required language already. The translation file thus consists only of translations that contain a '''numerus''' (quantity-dependent) translation where the source text varies depending on a quantity.
@@ Line 98: / Line 96: @@
 # Fill in (and accept!) the translations - you do not have to leave the %n in the translated texts for the singular case, but the tool may moan slightly about it not being there...
 The resulting translations will then be converted into the binary file <code>./translations/translated/mudlet_en_US.qm</code> to be included into the main Mudlet resources along with the other translations when the project is next compiled.

@@ Line 20: / Line 20: @@
 == How to get a gold star? ==
-Translating a language above 95% will earn it a gold star. If a language has a gold start, Mudlet will automatically use it for a new player first time they open it!
+Translating a language above 95% will earn it a gold star. If a language has a gold star, Mudlet will automatically use it for a new player first time they open it!
 [[File:Translation Star.png|frame|In Mudlet general preferences, golden star means 95%+ translated]]

@@ Line 89: / Line 89: @@
 Example: The text "You have just destroyed %n room(s)...!" in English needs two plural forms: One for the can of "one" single room, and the other for all "other" quantities (many or no rooms). Therefore this text would require two translations "You have just destroyed a room...!" and "You have just destroyed %n rooms...!".
-Other languages may have more or other cases than the English "one" and "others". For instance Japanese has only one form for all quantities. On the other hand French doesn't use an additional "s" in the "zero" case. In comparison Russian has a more complex system with three cases. See [https://doc.qt.io/qt-5/i18n-plural-rules.html Qt: Translation Rules for Plurals] for more details.
+Other languages may have more or other cases than the English "one" and "others". For instance Japanese has only one form for all quantities. On the other hand French doesn't use an additional "s" in the "zero" case. In comparison Russian has a more complex system with three cases, and Arabic even differentiates between six different plural cases: Zero, One, Two, Few, Many and Other. See [https://doc.qt.io/qt-5/i18n-plural-rules.html Qt: Translation Rules for Plurals] for more details.
 To add these translations as a ''developer'' when you have added or modified a source string with an ''%n'' and a third, integer, argument to a ''QObject::tr(translatable string, comment string, count)'' method call:

@@ Line 85: / Line 85: @@
 {{Note}} This section is for Mudlet developers only :)
-The plural forms in Mudlet's original American English texts need to be handled internally, as the CrowdIn system does not allow for this is a special case where one target locale to only contain the plural form when the remainder of the source texts are in the required language already. The translation file thus consists only of translations that contain a '''numerus''' (quantity-dependent) translation where the source text varies depending on a quantity.
+The plural forms in Mudlet's original American English texts need to be handled internally, as the CrowdIn system does not allow for this as a special case where one target locale only contains the plural form whereas the remainder of the source texts are in the required language already. The translation file thus consists only of translations that contain a '''numerus''' (quantity-dependent) translation where the source text varies depending on a quantity.
 Example: The text "You have just destroyed %n room(s)...!" in English needs two plural forms: One for the can of "one" single room, and the other for all "other" quantities (many or no rooms). Therefore this text would require two translations "You have just destroyed a room...!" and "You have just destroyed %n rooms...!".
@@ Line 91: / Line 91: @@
 Other languages may have more or other cases than the English "one" and "others". For instance Japanese has only one form for all quantities. On the other hand French uses an additional "s" in both the "zero" and the "more than one" case. In comparison Russian has a more complex system with three cases. See [https://doc.qt.io/qt-5/i18n-plural-rules.html Qt: Translation Rules for Plurals] for more details.
-To add these translations as a ''developer'':
+To add these translations as a ''developer'' when you have added or modified a source string with an ''%n'' and a third, integer, argument to a ''QObject::tr(translatable string, comment string, count)'' method call:
 # Ensure you are using the latest version you can of the following Qt utilities
 # Move to the root of Mudlet's source code
-# Ensure the translation file is up to date: <code>lupdate -pluralonly ./src/ ./3rdparty/dblsqd/dblsqd ./3rdparty/edbee-lib/edbee-lib -ts ./translations/translated/mudlet_en_US.ts</code>
+# Ensure the translation file is up to date: <code>lupdate -locations absolute -pluralonly ./src/ ./3rdparty/dblsqd/dblsqd ./3rdparty/edbee-lib/edbee-lib -ts ./translations/translated/mudlet_en_US.ts</code>
 # Edit the translation for this locale: <code>linguist ./translations/translated/mudlet_en_US.ts</code>
-# Fill in (and accept!) the translations - you do not have to leave the %n in the translated texts, but the tool may moan slightly about it not being there...
+# Fill in (and accept!) the translations - you do not have to leave the %n in the translated texts for the singular case, but the tool may moan slightly about it not being there...
 The resulting translations will then be converted into the binary file <code>./translations/translated/mudlet_en_US.qm</code> to be included into the main Mudlet resources along with the other translations when the project is next compiled.

@@ Line 81: / Line 81: @@
 == Special notes on separate translations ==
-=== English (American) translation ===
+=== Plural forms in (American) English ===
-{{Note}} This section is a note for Mudlet developers only :)
+{{Note}} This section is for Mudlet developers only :)
-This is a special case that is handled internally as the CrowdIn system does not allow for one target locale to only contain the plural form when the remainder of the source texts are in the required language already.  The translation file thus consists only of translations that contain a '''numerus''' (quantity-dependent) translation where the source text varies depending on a quantity, e.g. "You have just destroyed %n room(s)...!". In English this means that there are two plural forms one for the single (one room) case and the other for all other quantities (many or no rooms).  For this example text it would require the two translations "You have just destroyed a room...!" and "You have just destroyed %n rooms...!".
+The plural forms in Mudlet's original American English texts need to be handled internally, as the CrowdIn system does not allow for this is a special case where one target locale to only contain the plural form when the remainder of the source texts are in the required language already. The translation file thus consists only of translations that contain a '''numerus''' (quantity-dependent) translation where the source text varies depending on a quantity.
-''N.B. Others language have other variations (for instance French uses an additional "s" for the zero case, as well as the more than one, one; on the other hand Japanese has only one form for all quantities, in comparison Russian has a more complex systems with three variations, see [https://doc.qt.io/qt-5/i18n-plural-rules.html Translation Rules for Plurals] for the details).''
+Example: The text "You have just destroyed %n room(s)...!" in English needs two plural forms: One for the can of "one" single room, and the other for all "other" quantities (many or no rooms). Therefore this text would require two translations "You have just destroyed a room...!" and "You have just destroyed %n rooms...!".
-For the ''developer'' who is in the root of the source code, (ensure you are using the latest version you can of the following Qt utilities):
+Other languages may have more or other cases than the English "one" and "others". For instance Japanese has only one form for all quantities. On the other hand French uses an additional "s" in both the "zero" and the "more than one" case. In comparison Russian has a more complex system with three cases. See [https://doc.qt.io/qt-5/i18n-plural-rules.html Qt: Translation Rules for Plurals] for more details.
-: <code>lupdate -pluralonly ./src/ ./3rdparty/dblsqd/dblsqd ./3rdparty/edbee-lib/edbee-lib -ts ./translations/translated/mudlet_en_US.ts</code> will ensure the translation file is up to date.
-: <code>linguist ./translations/translated/mudlet_en_US.ts</code> will allow editing the translation for this locale.
+To add these translations as a ''developer'':
-: the resulting file will then be converted into the binary <code>./translations/translated/mudlet_en_US.qm</code> file to be included into the main Mudlet resources along with the other translations when the project is next compiled.
+# Ensure you are using the latest version you can of the following Qt utilities

@@ Line 57: / Line 57: @@
 # Go to https://github.com/Mudlet/Mudlet and search for the typo you'd like to fix - in this example, '''extention'''.
-[[File:Find typo in Mudlet.png|border]]
+[[File:Find typo in Mudlet.png|500px|border]]
 # Click on the file you'd like to edit.
-[[File:Select file to edit.png|border]]
+[[File:Select file to edit.png|500px|border]]
 # Select the <code>development</code> branch.
-[[File:Select development branch.png|border]]
+[[File:Select development branch.png|500px|border]]
 # And then click the <Code>Edit this file</code> button.
-[[File:Hit edit file button.png|border]]
+[[File:Hit edit file button.png|500px|border]]
 # Edit the typo (1), give your fix a name (2), as well as a machine-friendly name (3) and hit Commit changes (4)
-[[File:Make the edit.png|border]]
+[[File:Make the edit.png|500px|border]]
 # Lastly, open a pull request to integrate your changes - you can re-use the same title (1) as the overview (2), put in the reasion (3) and finally hit the green (4) button to submit your change!
-[[File:Commit changes.png|border]]
+[[File:Commit changes.png|500px|border]]
 == Special notes on separate translations ==