GettextForWesnothDevelopers - Revision history

Egallager: /* Generating the .mo files for UMC */ update

2024-11-21T17:05:18Z

‎Generating the .mo files for UMC: update

Celtic Minstrel: /* Marking up strings in C++ */ Explain N_ and N_n

2024-11-21T14:18:03Z

‎Marking up strings in C++: Explain N_ and N_n

Octalot: /* Marking up strings in C++ */ Gettext isn't a full C++ parser

2024-11-21T09:27:04Z

‎Marking up strings in C++: Gettext isn't a full C++ parser

Celtic Minstrel: /* Marking up strings in C++ */ A single name doesn't need syntax hiliting!

2024-04-29T13:45:00Z

‎Marking up strings in C++: A single name doesn't need syntax hiliting!

Celtic Minstrel: /* Unbalanced WML macros */ Actually delete the tag, too

2024-04-29T13:42:16Z

‎Unbalanced WML macros: Actually delete the tag, too

Celtic Minstrel: /* Unbalanced WML macros */ The syntax hiliter doesn't support unbalanced tags, so just don't hilite it.

2024-04-29T13:40:38Z

‎Unbalanced WML macros: The syntax hiliter doesn't support unbalanced tags, so just don't hilite it.

Octalot: /* The translatable strings */ Explain a bit about where the textdomain is used

2024-01-23T10:46:52Z

‎The translatable strings: Explain a bit about where the textdomain is used

Name: Fixed wmlxgettext syntax based on: https://github.com/wesnoth/wesnoth/pull/6875#issuecomment-1188052805

2022-07-19T23:58:56Z

Fixed wmlxgettext syntax based on: https://github.com/wesnoth/wesnoth/pull/6875#issuecomment-1188052805

Celtic Minstrel: /* Unbalanced WML macros */ Improve example; may still need updating though

2022-07-18T12:49:48Z

‎Unbalanced WML macros: Improve example; may still need updating though

Octalot: Added new "proper nouns in strings" section

2022-03-14T06:25:46Z

Added new "proper nouns in strings" section

@@ Line 357: / Line 357: @@
 === Generating the .mo files for UMC ===
-For Wesnoth 1.14, it's generally not necessary to compile the .po files to .mo files. The mainline translations still use .mo files for better performance, but UMC authors can skip the .mo compilation stage.
+For Wesnoth 1.14 and later, it's generally not necessary to compile the .po files to .mo files. The mainline translations still use .mo files for better performance, but UMC authors can skip the .mo compilation stage.
 == See Also ==

← Older revision		Revision as of 14:18, 21 November 2024
Line 58:		Line 58:

	Don't wrap the existing macros in more macros, as the .pot files are generated by gettext. Gettext isn't a full C++ parser, it's just searching for arguments to functions and macros in this list: <code>_ N_ _n N_n VGETTEXT VNGETTEXT sgettext vgettext sngettext vngettext</code>. That list is defined in cmake/FindTranslationTools.cmake and po/SConscript.		Don't wrap the existing macros in more macros, as the .pot files are generated by gettext. Gettext isn't a full C++ parser, it's just searching for arguments to functions and macros in this list: <code>_ N_ _n N_n VGETTEXT VNGETTEXT sgettext vgettext sngettext vngettext</code>. That list is defined in cmake/FindTranslationTools.cmake and po/SConscript.
		+
		+	The <code>N_</code> and <code>N_n</code> macros are used equivalently to <code>_</code> and <code>_n</code>, but return the source string instead of the translated string – this can be used to manually look up the translation later. This is something of a niche use-case however, and most of the time you should prefer to use <code>_</code> and <code>_n</code>.

	== Marking up strings in WML ==		== Marking up strings in WML ==

← Older revision		Revision as of 09:27, 21 November 2024
Line 56:		Line 56:

	You should avoid placing translatable strings in C++ headers if at all possible. Though there are a few places where it may be unavoidable, such as if templates are in use, it creates the risk of the strings sometimes being looked up in the wrong textdomain if the header is included in multiple files with different textdomains. If possible, always factor the translatable strings out into a source file.		You should avoid placing translatable strings in C++ headers if at all possible. Though there are a few places where it may be unavoidable, such as if templates are in use, it creates the risk of the strings sometimes being looked up in the wrong textdomain if the header is included in multiple files with different textdomains. If possible, always factor the translatable strings out into a source file.
		+
		+	Don't wrap the existing macros in more macros, as the .pot files are generated by gettext. Gettext isn't a full C++ parser, it's just searching for arguments to functions and macros in this list: <code>_ N_ _n N_n VGETTEXT VNGETTEXT sgettext vgettext sngettext vngettext</code>. That list is defined in cmake/FindTranslationTools.cmake and po/SConscript.

	== Marking up strings in WML ==		== Marking up strings in WML ==

@@ Line 51: / Line 51: @@
 </syntaxhighlight>
-The <syntaxhighlight lang=c++ inline>string_map</syntaxhighlight> can contain additional values that aren't used in the translated string. In the example above, it has both ''friends'' and ''enemies''.
+The <code>string_map</code> can contain additional values that aren't used in the translated string. In the example above, it has both ''friends'' and ''enemies''.
 By default, all strings in C++ belong to the "wesnoth" textdomain. If a different textdomain is required, you can add a textdomain binding at the top of the source file, before any include statements. A textdomain binding looks like this: <syntaxhighlight lang=c++>#define GETTEXT_DOMAIN "wesnoth-lib"</syntaxhighlight>

@@ Line 254: / Line 254: @@
 Suppose abilities.cfg line 29 is in the definition of SOH_ABILITY_BLITZ. To get the .pot file generated, the simplest change is to use ''# wmlxgettext'' comments to add the missing opening or closing tags:
-<syntaxhighlight>
+ # wmllint: unbalanced-on
-# wmllint: unbalanced-on
+ # wmlxgettext: [abilities]
-# wmlxgettext: [abilities]
+ #define SOH_ABILITY_BLITZ
-#define SOH_ABILITY_BLITZ
+     [dummy]
-    [dummy]
+         id=soh_blitz
-        id=soh_blitz
+         # ... ability definition stuff ...
-        # ... ability definition stuff ...
+     [/dummy]
-    [/dummy]
+ [/abilities]
-[/abilities]
+ # ... several lines of code, none of which are an ''#enddef'' ...
-# ... several lines of code, none of which are an ''#enddef'' ...
+ [+abilities] # wmlxgettext: [/abilities]
-[+abilities] # wmlxgettext: [/abilities]
+ #enddef
-#enddef
+ # wmllint: unbalanced-off
 == Marking up strings in Lua ==

@@ Line 77: / Line 77: @@
 === The translatable strings ===
-To mark a string as translatable, just put an underscore ( _ ) in front of the string you wish to be marked as translatable, like the example below:
+To mark a string as translatable, just put an underscore ( _ ) in front of the string you wish to be marked as translatable, like the example below. When parsing this, the engine will record both the visible text and the active textdomain, which can later be used to get the translation when displaying the text to the player.
 <syntaxhighlight lang=wml>

← Older revision		Revision as of 06:25, 14 March 2022
Line 175:		Line 175:

	Using a macro to encapsulate most of that can be useful. The example above is from the tutorial, after expanding the ''GENDER'' macro which is defined in data/campaigns/tutorial/utils/utils.cfg.		Using a macro to encapsulate most of that can be useful. The example above is from the tutorial, after expanding the ''GENDER'' macro which is defined in data/campaigns/tutorial/utils/utils.cfg.
		+
		+	=== Proper nouns in strings ===
		+
		+	Some languages require declensions of proper nouns - a person's name may change slightly depending on their role in a sentence. See for example [https://github.com/hrubymar10/wesnoth-cs/pull/209#issuecomment-1066163433 the Czech translators' PR 209].
		+
		+	Where there are a small number of units that might be addressed, for example the two in the tutorial or the four possible allies in UtBS, it's better to have a separate translatable string for each possible character instead of interpolating '''$unit.name''' into a string.

	=== Reusing mainline translations ===		=== Reusing mainline translations ===