Internationalization - Revision history

Geep: /* Support in DR */ Update bugtracker URL

2021-07-27T20:31:42Z

Support in DR: Update bugtracker URL

← Older revision		Revision as of 20:31, 27 July 2021
Line 57:		Line 57:
	=== Support in DR ===		=== Support in DR ===

	Darkradiant currently does not support the dictionaries, so strings will look like "#str_07118" instead of the "OK". This is tracked here: ~~http~~://bugs.~~angua~~.at/view.php?id=2845		Darkradiant currently does not support the dictionaries, so strings will look like "#str_07118" instead of the "OK". This is tracked here: https://bugs.thedarkmod.com/view.php?id=2845


	== For Developers ==		== For Developers ==

Geep: /* Inventory Item Names with multiple lines */

2020-09-10T16:29:13Z

Inventory Item Names with multiple lines

← Older revision		Revision as of 16:29, 10 September 2020
Line 49:		Line 49:
	=== Inventory Item Names with multiple lines ===		=== Inventory Item Names with multiple lines ===

	If you have an ~~inventor~~ item name which is very long, you can insert '''\n''' to split it up into two (but not more!) lines:		If you have an inventory item name which is very long, you can insert '''\n''' to split it up into two (but not more!) lines:

	"#str_20000" "This is a very very\nlong item name."		"#str_20000" "This is a very very\nlong item name."

Petike: /* Known bugs */ typo

2019-02-19T11:51:13Z

Known bugs: typo

← Older revision		Revision as of 11:51, 19 February 2019
Line 157:		Line 157:

	* Not all fonts contain accented characters yet.		* Not all fonts contain accented characters yet.
	* [[~~Darkradiant~~]] does not support the '''#str_01234''' strings yet.		* [[DarkRadiant]] does not support the '''#str_01234''' strings yet.
	* Doom3 does not render/support all characters (f.i. 0xFF in Russian, 0xF7 .. 0x9F in Western). To work around this, the characters are remapped (moved) during load. See [[I18N - Charset]] for details on this.		* Doom3 does not render/support all characters (f.i. 0xFF in Russian, 0xF7 .. 0x9F in Western). To work around this, the characters are remapped (moved) during load. See [[I18N - Charset]] for details on this.

	{{i18n}} {{editing}} {{sdk}}		{{i18n}} {{editing}} {{sdk}}

Grayman: /* New Strings */

2017-12-08T15:48:10Z

New Strings

← Older revision		Revision as of 15:48, 8 December 2017
Line 95:		Line 95:

	{{infobox\|{{red\|Never edit the other language files manually, they will be regenerated and your edits will be lost.}}}}		{{infobox\|{{red\|Never edit the other language files manually, they will be regenerated and your edits will be lost.}}}}

			{{infobox\|{{red\|Make sure you use the latest versions of all.lang and gen_lang.pl. If you don't have SVN access, work with someone who does and can provide you with the latest versions. When your changes are ready to be checked in, make sure that not only the new *.lang files get checked in, but also the new gen_lang.pl}}}}

	=== Adding a new i18n language ===		=== Adding a new i18n language ===

Petike: /* Very basic overview of the process */ slight formatting edit of the sentence

2015-01-21T09:16:48Z

Very basic overview of the process: slight formatting edit of the sentence

← Older revision		Revision as of 09:16, 21 January 2015
Line 109:		Line 109:

	* Edit the file "all.lang". Just copy the english language section to the end of the file and rename the new section. '''Make sure you use a Unicode editor and all.lang stays in UTF-8!'''		* Edit the file "all.lang". Just copy the english language section to the end of the file and rename the new section. '''Make sure you use a Unicode editor and all.lang stays in UTF-8!'''
	* Add the correct entry for the language name in '''strings/all.lang''' after the names in the range of 2460 .. 2500 (unless it already exists). The language name is to be expected in the local name, e.g. it is "Deutsch" in the english translation		* Add the correct entry for the language name in '''strings/all.lang''' after the names in the range of 2460 .. 2500 (unless it already exists). The language name is to be expected in the local name, e.g. it is "Deutsch" in the english translation, not "German". If the language name contains characters that cannot be represented in the current charset of the language, please use either the special characters from ISO-8859-1, or an translitertion like "Bulgarian"
	, not "German". If the language name contains characters that cannot be represented in the current charset of the language, please use either the special characters from ISO-8859-1, or an translitertion like "Bulgarian"
	* if possible, add the same entries in languages that do not use ISO-8859-1		* if possible, add the same entries in languages that do not use ISO-8859-1
	* Run the perl script '''devel/gen_lang.pl''' To do this, you need to have commit access to the developer SVN. This will "break up" the all.lang file into separate files for each translated language.		* Run the perl script '''devel/gen_lang.pl''' To do this, you need to have commit access to the developer SVN. This will "break up" the all.lang file into separate files for each translated language.

Tels: combine two sections

2014-09-05T08:59:15Z

combine two sections

← Older revision		Revision as of 08:59, 5 September 2014
Line 96:		Line 96:
	{{infobox\|{{red\|Never edit the other language files manually, they will be regenerated and your edits will be lost.}}}}		{{infobox\|{{red\|Never edit the other language files manually, they will be regenerated and your edits will be lost.}}}}

	=== ~~New Languages~~ ===		=== Adding a new i18n language ===
			The TDM i18n system works by having the translated strings given individual numbers. These numbers are included from separate language files at compile time, and then replaced with the language strings at runtime.

	~~If you need to add a new language, follow these steps:~~		==== Relevant files ====

	* ~~Add~~ a section in '''~~strings/~~all.lang'''		* all.lang - all the languages
	* ~~add~~ the correct entry for the language name in '''strings/all.lang''' after the names in the range of 2460 .. 2500 (unless it already exists). The language name is to be expected in the local name, e.g. it is "Deutsch" in the english translation		* devel/gen_lang.pl - perl script for breaking up the all.lang master file
			* (language).lang - the individual language files, eg english.lang or german.lang
			* (language).map - a [[character mapping file]], eg german.map

			==== Very basic overview of the process ====

			* Edit the file "all.lang". Just copy the english language section to the end of the file and rename the new section. '''Make sure you use a Unicode editor and all.lang stays in UTF-8!'''
			* Add the correct entry for the language name in '''strings/all.lang''' after the names in the range of 2460 .. 2500 (unless it already exists). The language name is to be expected in the local name, e.g. it is "Deutsch" in the english translation
	, not "German". If the language name contains characters that cannot be represented in the current charset of the language, please use either the special characters from ISO-8859-1, or an translitertion like "Bulgarian"		, not "German". If the language name contains characters that cannot be represented in the current charset of the language, please use either the special characters from ISO-8859-1, or an translitertion like "Bulgarian"
	* if possible, add the same entries in languages that do not use ISO-8859-1		* if possible, add the same entries in languages that do not use ISO-8859-1
	* ~~run~~ '''~~perl~~ devel/gen_lang.pl''' to ~~generate~~ the ~~new~~ "*.lang" file.		* Run the perl script '''devel/gen_lang.pl''' To do this, you need to have commit access to the developer SVN. This will "break up" the all.lang file into separate files for each translated language.
	* If nec, create a new ".map" file by copying one of the existing .map files in "strings/".		* If nec, create a new ".map" file by copying one of the existing .map files in "strings/".
	* Add the new ".lang" file (and possible ".map" file) to SVN.		* Add the new ".lang" file (and possible ".map" file) to SVN.

			The new strings should now be accessible at the next start of TDM.

	=== Missing Translations ===		=== Missing Translations ===
Line 135:		Line 145:

	perl devel/rename_string.pl 2236 2298 2		perl devel/rename_string.pl 2236 2298 2


	~~=== Adding a new i18n language ===~~
	The TDM i18n system works by having the translated strings given individual numbers. These numbers are included from separate language files at compile time, and then replaced with the language strings at runtime.

	~~====Relevant files====~~
	* all.lang - all the languages
	* devel/gen_lang.pl - perl script for breaking up the all.lang master file
	* (language).lang - the individual language files, eg english.lang or german.lang

	~~====Very basic overview of the translation process====~~
	* Edit the file "all.lang". Just copy the english language section to the end of the file and rename the new section.
	* Run the perl script "devel/gen_lang.pl" To do this, you need to have commit access to the developer SVN. This will "break up" the all.lang file into separate files for each translated language.
	* The new strings should now be accessible at next compile time.

	=== GUI ===		=== GUI ===

Tels: adding a new language, correction to CVAR

2014-09-05T08:55:07Z

adding a new language, correction to CVAR

← Older revision		Revision as of 08:55, 5 September 2014
Line 64:		Line 64:
	=== CVAR tdm_lang ===		=== CVAR tdm_lang ===

	~~The D3 CVAR~~ '''~~sys_lang~~''' ~~is restricted to a few hard-coded values,~~ and is ~~thus not usable~~. ~~We have added a new~~ CVAR '''~~tdm_lang~~'''~~, which~~ contains the current language as English lower-case string, e.g. "english", "german", "portuguese" etc. This variable is controlled by the GUI via a call back into the SDK code, which switches the language underneath, and also reloads the GUI.		'''tdm_lang''' was only used before TDM 2.0 and is obsolete.

			=== CVAR sys_lang ===

			The [[CVAR]] '''sys_lang''' contains the current language as English lower-case string, e.g. "english", "german", "portuguese" etc. This variable is controlled by the GUI via a call back into the SDK code, which switches the language underneath, and also reloads the GUI.

	{{infobox\|If you change the CVAR manually (via the console f.i.), you need to restart TDM so it works!}}		{{infobox\|If you change the CVAR manually (via the console f.i.), you need to restart TDM so it works!}}
Line 74:		Line 78:
	=== Charset ===		=== Charset ===

	The D3 code that handles the GUI bitmap font can only load a specific range of bytes as characters. To get the most out of the available entries, an special charset (based on ISO 8859-1 with modifications) is used. The details can be found [[I18N - Charset\|on this page]].		The TDM (old D3) code that handles the GUI bitmap font can only load a specific range of bytes as characters. To get the most out of the available entries, an special charset (based on ISO 8859-1 with modifications) is used. The details can be found [[I18N - Charset\|on this page]].

	=== New Strings ===		=== New Strings ===
Line 91:		Line 95:

	{{infobox\|{{red\|Never edit the other language files manually, they will be regenerated and your edits will be lost.}}}}		{{infobox\|{{red\|Never edit the other language files manually, they will be regenerated and your edits will be lost.}}}}

			=== New Languages ===

			If you need to add a new language, follow these steps:

			* Add a section in '''strings/all.lang'''
			* add the correct entry for the language name in '''strings/all.lang''' after the names in the range of 2460 .. 2500 (unless it already exists). The language name is to be expected in the local name, e.g. it is "Deutsch" in the english translation
			, not "German". If the language name contains characters that cannot be represented in the current charset of the language, please use either the special characters from ISO-8859-1, or an translitertion like "Bulgarian"
			* if possible, add the same entries in languages that do not use ISO-8859-1
			* run '''perl devel/gen_lang.pl''' to generate the new "*.lang" file.
			* If nec, create a new ".map" file by copying one of the existing .map files in "strings/".
			* Add the new ".lang" file (and possible ".map" file) to SVN.

	=== Missing Translations ===		=== Missing Translations ===

Akira at 11:45, 30 December 2013

2013-12-30T11:45:38Z

← Older revision		Revision as of 11:45, 30 December 2013
Line 119:		Line 119:

	perl devel/rename_string.pl 2236 2298 2		perl devel/rename_string.pl 2236 2298 2


			=== Adding a new i18n language ===
			The TDM i18n system works by having the translated strings given individual numbers. These numbers are included from separate language files at compile time, and then replaced with the language strings at runtime.

			====Relevant files====
			* all.lang - all the languages
			* devel/gen_lang.pl - perl script for breaking up the all.lang master file
			* (language).lang - the individual language files, eg english.lang or german.lang

			====Very basic overview of the translation process====
			* Edit the file "all.lang". Just copy the english language section to the end of the file and rename the new section.
			* Run the perl script "devel/gen_lang.pl" To do this, you need to have commit access to the developer SVN. This will "break up" the all.lang file into separate files for each translated language.
			* The new strings should now be accessible at next compile time.

	=== GUI ===		=== GUI ===

Tels: update for v1.08

2012-03-17T11:25:24Z

update for v1.08

← Older revision		Revision as of 11:25, 17 March 2012
Line 15:		Line 15:
	You can switch the language of TDM in the '''Settings''' menu under '''Video''', '''General'''. The language is stored in the CVAR '''sys_lang''' (Note: in v1.07, it was stored in tdm_lang).		You can switch the language of TDM in the '''Settings''' menu under '''Video''', '''General'''. The language is stored in the CVAR '''sys_lang''' (Note: in v1.07, it was stored in tdm_lang).

	Switching the language does not require a ~~newstart~~, except for ~~some~~ languages ~~like Russian~~. There the game will inform you that you need to restart it manually, or the display will not look correct.		Switching the language does not require a restart, except for switching between Russian and Western languages. There the game will inform you that you need to restart it manually, or the display will not look correct.

	Changing the language will change the language of the HUD, as well as the inventory immidiately. It can also be done during a mission.		Changing the language will change the language of the HUD, as well as the inventory immidiately. It can also be done during a mission.


	{{infobox\|'''Note:''' Not all FMs are yet multi-lingual, and for these certain inventory items, the objectives, or readables might appear in English.~~<br>~~ See the '''[[I18N Status\|list of already internationalized FMs]]''' and their status.}}		{{infobox\|'''Note:''' Not all FMs are yet multi-lingual, and for these certain inventory items, the objectives, or readables might appear in English. See the '''[[I18N Status\|list of already internationalized FMs]]''' and their status.}}


Line 54:		Line 54:

	You should try in the game to see how it looks, so that both lines are roughly the same length.		You should try in the game to see how it looks, so that both lines are roughly the same length.

			=== Support in DR ===

			Darkradiant currently does not support the dictionaries, so strings will look like "#str_07118" instead of the "OK". This is tracked here: http://bugs.angua.at/view.php?id=2845


Line 66:		Line 70:
	=== Code ===		=== Code ===

	The main translation object is of the class CI18N (which is short for "Class Internationalization") and lives in ''Darkmod/I18N.cpp'' and ''Darkmod/I18N.h''.		The main translation object is of the class CI18N (which is short for "Class Internationalization") and lives in ''framework/I18N.cpp'' and ''framework/I18N.h'' (in v1.07, it was in ''Darkmod/I18N.cpp'' and ''Darkmod/I18N.h'').

	==== Charset ====		=== Charset ===

	The D3 code that handles the GUI bitmap font can only load a specific range of bytes as characters. To get the most out of the available entries, an special charset (based on ISO 8859-1 with modifications) is used. The details can be found [[I18N - Charset\|on this page]].		The D3 code that handles the GUI bitmap font can only load a specific range of bytes as characters. To get the most out of the available entries, an special charset (based on ISO 8859-1 with modifications) is used. The details can be found [[I18N - Charset\|on this page]].
Line 118:		Line 122:
	=== GUI ===		=== GUI ===

	To work around ~~the~~ '''choiceDef''' bug, two new main menu commands ~~have been~~ added, called "initChoice" and "stepChoice". ~~These two take 3 arguments each:~~		In v1.07 there was a bug in '''choiceDef''' inside the GUI, which did not allow other characters than a-z. To work around this '''choiceDef''' bug, two new main menu commands were added, called "initChoice" and "stepChoice". However, for v1.08, the bug is fixed in the main code (due to the source code now being available), so the work-arounds were removed.

	~~# the CVAR name~~
	~~# the labels for each choice ('''should be''' in the form '#str_01234" to make it translatable)~~
	~~# the values~~ for ~~each choice (usually a hard-coded list like '0;1')~~

	~~In addition to these, a few GUI #defines where added that make it easier to add a new choice def~~. ~~Here is how it looked before:~~

	~~<pre>~~
	~~choiceDef PostProcessing~~
	{
	~~rect SETTINGS_X_OFFSET~~, ~~54, 80, 14~~
	~~choices "#str_07300" // disabled, enabled~~
	~~values "1;0"~~
	~~cvar "r_postprocess"~~
	~~choiceType 0~~
	~~font SETTINGS_FONT~~
	~~textscale SETTINGS_FONT_SCALE_CHOICE~~
	~~textalign 1~~
	~~textaligny 0~~
	~~forecolor SETTINGS_FONT_COLOUR~~

	~~onAction~~
	{
	~~set "cmd" "play sound/meta/menu/mnu_select" ;~~
	~~resetTime "UpdateBloomSliderVisibility" 0;~~
	}
	}
	~~</pre>~~

	~~And here~~ is ~~how it has to look now:~~

	~~<pre>~~
	~~windowDef PostProcessing~~
	{
	~~rect SETTINGS_X_OFFSET, 54, 80, 14~~
	~~text "gui::r_postprocess_text"~~
	~~CHOICE_INIT "initChoice 'r_postprocess' '#str_07300' '1;0'" }~~
	~~CHOICE_STEP "stepChoice 'r_postprocess' '#str_07300' '1;0'"; resetTime "UpdateBloomSliderVisibility" 0; }~~
	}
	~~</pre>~~

	~~'''Notes:'''~~

	* use '''windowDef''', not '''choiceDef''', or the GUI will crash upon load.
	* the text variable has to be in the ~~format "gui::cvarname_text"~~ (~~e.g.~~ the ~~CVAR with "_text" appended~~)
	* The lines for "CHOICE_INIT" and "CHOICE_STEP" '''must''' end with a "}".
	* The secondary action in CHOICE_STEP (resetTime in the ~~example above) is optional~~.


	== Known bugs ==		== Known bugs ==

	~~Sadly, there are quite a lot of limitations in~~ the ~~D3 SDK that prevent~~ a few things ~~from fully~~ working~~. Once D3 goes open source, these things will be fixed, in the meantime we hope that you can live with the quirks~~:		At the moment only a few things are still not working:

	* Doom3 does not render/support all characters (f.i. 0xFF in Russian, 0xF7 .. 0x9F in Western). To work around this, the characters are remapped (moved) during load. See [[I18N - Charset]] for details.		* Not all fonts contain accented characters yet.
	* choiceDefs do not properly display choices with high-bit characters. There exist two new menu commands and a few #defines to work around this~~, see the [[#GUI\|GUI section]] above~~.		* [[Darkradiant]] does not support the '''#str_01234''' strings yet.
			* Doom3 does not render/support all characters (f.i. 0xFF in Russian, 0xF7 .. 0x9F in Western). To work around this, the characters are remapped (moved) during load. See [[I18N - Charset]] for details on this.

	{{i18n}} {{editing}} {{sdk}}		{{i18n}} {{editing}} {{sdk}}

Tels: update

2012-02-16T19:13:12Z

update

← Older revision		Revision as of 19:13, 16 February 2012
Line 13:		Line 13:
	== For Users ==		== For Users ==

	You can switch the language of TDM in the '''Settings''' menu under '''Video''', '''General'''. The language is stored in the CVAR '''~~tdm_lang~~'''. ~~Ignore '''sys_lang'''~~.		You can switch the language of TDM in the '''Settings''' menu under '''Video''', '''General'''. The language is stored in the CVAR '''sys_lang''' (Note: in v1.07, it was stored in tdm_lang).

	Switching the language does not require a newstart, except for some languages like Russian. There the game will inform you that you need to restart it manually, or the display will not look correct.		Switching the language does not require a newstart, except for some languages like Russian. There the game will inform you that you need to restart it manually, or the display will not look correct.