I18N - Translating Fan Missions - Revision history

Grayman: /* FM Specific Dictionaries */

2018-01-29T14:35:07Z

FM Specific Dictionaries

← Older revision		Revision as of 14:35, 29 January 2018
Line 64:		Line 64:
	</pre>		</pre>

	This setup makes it easier to translate the FM, because an translator needs only to copy ''english.lang'' to ''german.lang'', change the strings, repackage the ''outpost_l10n.pk4'' file, and it works!		This setup makes it easier to translate the FM, because a translator needs only to copy ''english.lang'' to ''german.lang'', change the strings, repackage the ''outpost_l10n.pk4'' file, and it works!

	=== Images with Text ===		=== Images with Text ===

Grayman: /* FM Specific Dictionaries */

2018-01-29T14:33:31Z

FM Specific Dictionaries

← Older revision		Revision as of 14:33, 29 January 2018
Line 17:		Line 17:
	These dictionaries live in the directory '''strings/fm/''' and must follow a specific format, explained below. The name for such a dictionary is always '''LANGUAGE.lang''', f.i. "english.lang".		These dictionaries live in the directory '''strings/fm/''' and must follow a specific format, explained below. The name for such a dictionary is always '''LANGUAGE.lang''', f.i. "english.lang".

	The string IDs for FMs are 20000 … 89999, using these ensures that they do not conflict with strings from the TDM core. Note that if you have a string that matches one of the other core strings (like "Silver Key", "#str_10000"), then you should use just the core string ID. This saves the translators to translate the string again.		The string IDs for FMs are 20000 … 89999, using these ensures that they do not conflict with strings from the TDM core. Note that if you have a string that matches one of the other core strings (like "Silver Key", "#str_10000"), then you should use just the core string ID. This saves the translators from having to translate the string again.

	You '''MUST''' also separate them from the rest of your FM into their own package called "YOURFM_l10n.pk4" where YOURFM is the name of your original PK4 file. This ensures that TDM can install/update the I18N package properly.		You '''MUST''' also separate them from the rest of your FM into their own package called "YOURFM_l10n.pk4" where YOURFM is the name of your original PK4 file. This ensures that TDM can install/update the I18N package properly.

Tels: add note about bug 3012

2012-07-07T09:02:16Z

add note about bug 3012

← Older revision		Revision as of 09:02, 7 July 2012
Line 7:		Line 7:
	=== darkmod.txt ===		=== darkmod.txt ===

	~~In addition, if you translate strings in '''darkmod.txt~~''~~', '''DO NOT''' translate the field names like ''Author~~:''~~, ''Required TDM Version:'' etc. These must stay in English, or TDM will~~ not ~~be able~~ to ~~interpret them~~. ~~Only translate the text that comes after them! If you use [[I18N~~.~~pl]],~~ this ~~will be automatically done~~ for ~~you, you should not edit ''darkmod~~.~~txt'' in this case!~~		{{infobox\|''Important:'' Due to bug #3012 it is not yet possible to translate darkmod.txt no README.txt - so please ignore this section for now.}}

	If you want to add your name to the credits, include it in a README.txt file inside ''YOURFM_l10n.pk4'' file.		If you translate strings in '''darkmod.txt''', '''DO NOT''' translate the field names like ''Author:'', ''Required TDM Version:'' etc. These must stay in English, or TDM will not be able to interpret them. Only translate the text that comes after them! If you use [[I18N.pl]], this will be automatically done for you, you should not edit ''darkmod.txt'' in this case!

			If you want to add your name as translator to the credits, include it in a README.txt file inside ''YOURFM_l10n.pk4'' file.

	=== FM Specific Dictionaries ===		=== FM Specific Dictionaries ===

Tels: add image file names

2011-11-28T21:33:21Z

add image file names

← Older revision		Revision as of 21:33, 28 November 2011
Line 95:		Line 95:

	'''Only English and Italian are shown here, you need one version for each language.'''		'''Only English and Italian are shown here, you need one version for each language.'''

			You also need the actual images, in this case:

			* <tt>dds/guis/assets/maps/thiefsdenmap_it.dds</tt> (Italian version, should go into "yourfm_l10n.pk4" as the other languages)
			* <tt>dds/guis/assets/maps/thiefsdenmap.dds</tt> (English original, should go into "yourfm.pk4")

	Then modify the GUI file (in this case <tt>guis/thiefsdenmap.gui</tt>) where the map is used to say:		Then modify the GUI file (in this case <tt>guis/thiefsdenmap.gui</tt>) where the map is used to say:
Line 133:		Line 138:

	{{infobox\|Please note that non-existing strings will default to English. So in any other language, the English map will be used as fallback.}}		{{infobox\|Please note that non-existing strings will default to English. So in any other language, the English map will be used as fallback.}}

			In case this still all unclear, use these files as an example:

			# http://www.bloodgate.com/mirrors/tdm/pub/pk4/i18n/thiefs_den.pk4
			# http://www.bloodgate.com/mirrors/tdm/pub/pk4/i18n/thiefs_den_l10n.pk4

	== Publishing the FM ==		== Publishing the FM ==

Tels: add info about images

2011-11-28T21:21:30Z

add info about images

@@ Line 66: / Line 66: @@
 === Images with Text ===
-{{red|todo}}
+If the text is painted on the image itself, you first need to paint a different image with the text in the foreign language. If you cannot do this yourself, ask one of the [[I18N_-_List_of_TDM_translators|translators]].
 == Publishing the FM ==

Tels: updates

2011-11-28T06:38:03Z

updates

← Older revision		Revision as of 06:38, 28 November 2011
Line 3:		Line 3:
	{{infobox\|''Important:'' Use [[I18N.pl]] to prepare an FM before you attempt to translate it!}}		{{infobox\|''Important:'' Use [[I18N.pl]] to prepare an FM before you attempt to translate it!}}

	== darkmod.txt ==		== Translation ==

			=== darkmod.txt ===

	In addition, if you translate strings in '''darkmod.txt''', '''DO NOT''' translate the field names like ''Author:'', ''Required TDM Version:'' etc. These must stay in English, or TDM will not be able to interpret them. Only translate the text that comes after them! If you use [[I18N.pl]], this will be automatically done for you, you should not edit ''darkmod.txt'' in this case!		In addition, if you translate strings in '''darkmod.txt''', '''DO NOT''' translate the field names like ''Author:'', ''Required TDM Version:'' etc. These must stay in English, or TDM will not be able to interpret them. Only translate the text that comes after them! If you use [[I18N.pl]], this will be automatically done for you, you should not edit ''darkmod.txt'' in this case!
Line 9:		Line 11:
	If you want to add your name to the credits, include it in a README.txt file inside ''YOURFM_l10n.pk4'' file.		If you want to add your name to the credits, include it in a README.txt file inside ''YOURFM_l10n.pk4'' file.

	== FM Specific Dictionaries ==		=== FM Specific Dictionaries ===

	These dictionaries live in the directory '''strings/fm/''' and must follow a specific format, explained below. The name for such a dictionary is always '''LANGUAGE.lang''', f.i. "english.lang".		These dictionaries live in the directory '''strings/fm/''' and must follow a specific format, explained below. The name for such a dictionary is always '''LANGUAGE.lang''', f.i. "english.lang".
Line 61:		Line 63:

	This setup makes it easier to translate the FM, because an translator needs only to copy ''english.lang'' to ''german.lang'', change the strings, repackage the ''outpost_l10n.pk4'' file, and it works!		This setup makes it easier to translate the FM, because an translator needs only to copy ''english.lang'' to ''german.lang'', change the strings, repackage the ''outpost_l10n.pk4'' file, and it works!

			=== Images with Text ===

			{{red\|todo}}

			== Publishing the FM ==

			If you upload your FM somewhere, you need to upload both files, the '''.PK4''' and the '''_l10n.pk4'''. The interface for publishing an FM on [http://www.thedarkmod.com/admin/fms.php thedarkmod.com] has a special field where you can enter the URL for the '''_l10n.pk4''' file.

	{{i18n}}		{{i18n}}

Tels: mention strings/english.lang

2011-11-28T06:34:57Z

mention strings/english.lang

← Older revision		Revision as of 06:34, 28 November 2011
Line 28:		Line 28:
	maps/outpost.script		maps/outpost.script
	maps/outpost.aas32		maps/outpost.aas32
			strings/fm/english.lang // include a copy of this, so the FM package
			// also works stand-alone

	outpost_l10n.pk4:		outpost_l10n.pk4:

Tels: typo

2011-11-28T06:32:49Z

typo

← Older revision		Revision as of 06:32, 28 November 2011
Line 13:		Line 13:
	These dictionaries live in the directory '''strings/fm/''' and must follow a specific format, explained below. The name for such a dictionary is always '''LANGUAGE.lang''', f.i. "english.lang".		These dictionaries live in the directory '''strings/fm/''' and must follow a specific format, explained below. The name for such a dictionary is always '''LANGUAGE.lang''', f.i. "english.lang".

	The string IDs for FMs are 20000 .. 89999, using these ensures that they do not conflict with strings from the TDM core. Note that if you have a string that matches one of the other core strings (like "Silver Key", "#str_10000"), then you should use just the core string ID. This saves the translators to translate the string again.		The string IDs for FMs are 20000 … 89999, using these ensures that they do not conflict with strings from the TDM core. Note that if you have a string that matches one of the other core strings (like "Silver Key", "#str_10000"), then you should use just the core string ID. This saves the translators to translate the string again.

	You '''MUST''' also separate them from the rest of your FM into their own package called "YOURFM_l10n.pk4" where YOURFM is the name of your original PK4 file. This ensures that TDM can install/update the I18N package properly.		You '''MUST''' also separate them from the rest of your FM into their own package called "YOURFM_l10n.pk4" where YOURFM is the name of your original PK4 file. This ensures that TDM can install/update the I18N package properly.

Tels: rename i18n.pk4 to l10n.pk4

2011-10-22T14:03:23Z

rename i18n.pk4 to l10n.pk4

← Older revision		Revision as of 14:03, 22 October 2011
Line 7:		Line 7:
	In addition, if you translate strings in '''darkmod.txt''', '''DO NOT''' translate the field names like ''Author:'', ''Required TDM Version:'' etc. These must stay in English, or TDM will not be able to interpret them. Only translate the text that comes after them! If you use [[I18N.pl]], this will be automatically done for you, you should not edit ''darkmod.txt'' in this case!		In addition, if you translate strings in '''darkmod.txt''', '''DO NOT''' translate the field names like ''Author:'', ''Required TDM Version:'' etc. These must stay in English, or TDM will not be able to interpret them. Only translate the text that comes after them! If you use [[I18N.pl]], this will be automatically done for you, you should not edit ''darkmod.txt'' in this case!

	If you want to add your name to the credits, include it in a README.txt file inside ''~~YOURFM_i18n~~.pk4'' file.		If you want to add your name to the credits, include it in a README.txt file inside ''YOURFM_l10n.pk4'' file.

	== FM Specific Dictionaries ==		== FM Specific Dictionaries ==
Line 15:		Line 15:
	The string IDs for FMs are 20000 .. 89999, using these ensures that they do not conflict with strings from the TDM core. Note that if you have a string that matches one of the other core strings (like "Silver Key", "#str_10000"), then you should use just the core string ID. This saves the translators to translate the string again.		The string IDs for FMs are 20000 .. 89999, using these ensures that they do not conflict with strings from the TDM core. Note that if you have a string that matches one of the other core strings (like "Silver Key", "#str_10000"), then you should use just the core string ID. This saves the translators to translate the string again.

	You '''MUST''' also separate them from the rest of your FM into their own package called "~~YOURFM_i18n~~.pk4" where YOURFM is the name of your original PK4 file. This ensures that TDM can install/update the I18N package properly.		You '''MUST''' also separate them from the rest of your FM into their own package called "YOURFM_l10n.pk4" where YOURFM is the name of your original PK4 file. This ensures that TDM can install/update the I18N package properly.

	Let's see how this looks for the FM named ''Outpost'', which provides two translations (English and French):		Let's see how this looks for the FM named ''Outpost'', which provides two translations (English and French):
Line 29:		Line 29:
	maps/outpost.aas32		maps/outpost.aas32

	~~outpost_i18n~~.pk4:		outpost_l10n.pk4:

	strings/fm/english.lang		strings/fm/english.lang
Line 58:		Line 58:
	</pre>		</pre>

	This setup makes it easier to translate the FM, because an translator needs only to copy ''english.lang'' to ''german.lang'', change the strings, repackage the ''~~outpost_i18n~~.pk4'' file, and it works!		This setup makes it easier to translate the FM, because an translator needs only to copy ''english.lang'' to ''german.lang'', change the strings, repackage the ''outpost_l10n.pk4'' file, and it works!

	{{i18n}}		{{i18n}}

Tels: add

2011-10-21T16:27:18Z

add

New page

== Introduction ==

{{infobox|''Important:'' Use [[I18N.pl]] to prepare an FM before you attempt to translate it!}}

== darkmod.txt ==

In addition, if you translate strings in '''darkmod.txt''', '''DO NOT''' translate the field names like ''Author:'', ''Required TDM Version:'' etc. These must stay in English, or TDM will not be able to interpret them. Only translate the text that comes after them! If you use [[I18N.pl]], this will be automatically done for you, you should not edit ''darkmod.txt'' in this case!

If you want to add your name to the credits, include it in a README.txt file inside ''YOURFM_i18n.pk4'' file.

== FM Specific Dictionaries ==

These dictionaries live in the directory '''strings/fm/''' and must follow a specific format, explained below. The name for such a dictionary is always '''LANGUAGE.lang''', f.i. "english.lang".

The string IDs for FMs are 20000 .. 89999, using these ensures that they do not conflict with strings from the TDM core. Note that if you have a string that matches one of the other core strings (like "Silver Key", "#str_10000"), then you should use just the core string ID. This saves the translators to translate the string again.

You '''MUST''' also separate them from the rest of your FM into their own package called "YOURFM_i18n.pk4" where YOURFM is the name of your original PK4 file. This ensures that TDM can install/update the I18N package properly.

Let's see how this looks for the FM named ''Outpost'', which provides two translations (English and French):

<pre>
outpost.pk4:

xdata/outpost.xd
maps/outpost.map
maps/outpost.cm
maps/outpost.proc
maps/outpost.script
maps/outpost.aas32

outpost_i18n.pk4:

strings/fm/english.lang
strings/fm/french.lang
README.txt // f.i. with credits for translators
</pre>

Note that all files names should be in lowercase, otherwise there can be problems under Linux.

Example dictionary, note the entire content is wrapped in "{ }"

<pre style="font-size: 83%">
// String table english (iso-8859-1) for: The Outpost

// This file was generated automatically on 2011-08-20 13:56 UTC by i18n.pl v0.02
{
"#str_20000" "The Outpost"
"#str_20001" "Break into a builder outpost to retrieve a gold ingot."
"#str_20002" "Gold Ingot"
"#str_20003" "Leave the outpost after your main objectives are done and get back to the front gates."
"#str_20004" "You won't find bags full of money in a builder outpost, but take away any valuables you can get hold of. Find valuables worth at least 600."
"#str_20005" "You won't find bags full of money in a builder outpost, but take away any valuables you can get hold of. Find valuables worth at least 700."
"#str_20006" "No knock outs too."
"#str_20007" "Killing is not your style. No corpses tonight."
"#str_20008" "You won't find bags full of money in a builder outpost, but take away any valuables you can get hold of. Find valuables worth at least 800."
"#str_20009" "The massive gold ingot should be worth a fair amount of money. Find out where the ingot is kept and change its ownership."
}
</pre>

This setup makes it easier to translate the FM, because an translator needs only to copy ''english.lang'' to ''german.lang'', change the strings, repackage the ''outpost_i18n.pk4'' file, and it works!

{{i18n}}