TranslationsWML - Revision history

Celtic Minstrel: /* Hidden Text */ Add in the more important reason to use the circumflex

2017-12-29T03:03:46Z

Hidden Text: Add in the more important reason to use the circumflex

← Older revision		Revision as of 03:03, 29 December 2017
Line 54:		Line 54:
	=== Hidden Text ===		=== Hidden Text ===

	Presence of the circumflex (''^''), US-ASCII 0x5E, in any text string which is translatable — i.e. processed by the functions of src/tstring.cpp — causes the circumflex and any text preceeding it to be ignored; any such text is therefore not shown in the GUI. This can be used to provide translators with informative messages because, of course, such text is retained in the original value.		Presence of the circumflex (''^''), US-ASCII 0x5E, in any text string which is translatable — i.e. processed by the functions of src/tstring.cpp — causes the circumflex and any text preceeding it to be ignored; any such text is therefore not shown in the GUI. This can be used to provide translators with informative messages because, of course, such text is retained in the original value. More importantly, it also serves to distinguish strings which are the same in English but would differ in other languages - for example, if a string is used both for male and female units.

	Examples of this are seen throughout the mainline assets. Most often, it is used when a name is purposed for an object of certain gender and when that gender is not obvious by the text of the name itself. <br />		Examples of this are seen throughout the mainline assets. Most often, it is used when a name is purposed for an object of certain gender and when that gender is not obvious by the text of the name itself. <br />

Cannedfood: restructure headings ; added information concerning the circumflex

2017-12-11T19:13:22Z

restructure headings ; added information concerning the circumflex

← Older revision		Revision as of 19:13, 11 December 2017
Line 1:		Line 1:
	This page describes tags and syntax used for enabling translation in your user made campaign.		This page describes tags and syntax used for enabling translation in your user made campaign.

	== _ "<translatable string>" ==		== Components ==
	Any string that you want to be ~~translated has~~ to be ~~put inside _ " "~~.
			=== _ "<translatable string>" ===

			Any string that you want to be [[translatable]] needs to be prefixed with an underscore, US-ASCII 0x5F. It will usually also be enclosed in quote marks.
	Example:		Example:
	[message]		[message]
Line 9:		Line 12:
	[/message]		[/message]

	== #textdomain <textdomain> ==		=== #textdomain <textdomain> ===

	This comment tells Wesnoth to use a certain textdomain. Affects the tag that it has been placed in and all children until another #textdomain is found. A textdomain is a set of translations(you can create your own one for your campaign).		This comment tells Wesnoth to use a certain textdomain. Affects the tag that it has been placed in and all children until another #textdomain is found. A textdomain is a set of translations(you can create your own one for your campaign).
	Example:		Example:
Line 36:		Line 40:
	Note: The [scenario] tag isn't a child of [campaign], so you will have to specify a textdomain for both, your campaign and each of your scenarios.		Note: The [scenario] tag isn't a child of [campaign], so you will have to specify a textdomain for both, your campaign and each of your scenarios.

	== the [textdomain] tag ==		=== the [textdomain] tag ===

	This tag, which has to be placed at the same level as [campaign], is used to specify a path for your own textdomain.		This tag, which has to be placed at the same level as [campaign], is used to specify a path for your own textdomain.
Line 45:		Line 49:
	path="data/campaigns/Liberty/translations"		path="data/campaigns/Liberty/translations"
	[/textdomain]		[/textdomain]

			== Functional Characteristics ==

			=== Hidden Text ===

			Presence of the circumflex (''^''), US-ASCII 0x5E, in any text string which is translatable — i.e. processed by the functions of src/tstring.cpp — causes the circumflex and any text preceeding it to be ignored; any such text is therefore not shown in the GUI. This can be used to provide translators with informative messages because, of course, such text is retained in the original value.

			Examples of this are seen throughout the mainline assets. Most often, it is used when a name is purposed for an object of certain gender and when that gender is not obvious by the text of the name itself. <br />
			Used in a '''[side]''' key:
			user_team_name= _ "teamname^Southeast"
			Used in a '''[race]''' key:
			female_name= _ "race+female^Bat"

			== See Also ==

			* [[SyntaxWML]]

	[[Category:WML Reference]]		[[Category:WML Reference]]

Esr: Categorize

2008-03-08T11:29:11Z

Categorize

← Older revision		Revision as of 11:29, 8 March 2008
Line 45:		Line 45:
	path="data/campaigns/Liberty/translations"		path="data/campaigns/Liberty/translations"
	[/textdomain]		[/textdomain]

			[[Category:WML Reference]]

CIB: documentation for textdomain syntax and tags

2007-09-10T19:30:03Z

documentation for textdomain syntax and tags

New page

This page describes tags and syntax used for enabling translation in your user made campaign.

== _ "<translatable string>" ==
Any string that you want to be translated has to be put inside _ " ".
Example:
[message]
speaker=narrator
message= _ "This string is going to be translated."
[/message]

== #textdomain <textdomain> ==
This comment tells Wesnoth to use a certain textdomain. Affects the tag that it has been placed in and all children until another #textdomain is found. A textdomain is a set of translations(you can create your own one for your campaign).
Example:
#textdomain wesnoth-trow
[event]
#textdomain wesnoth-httt
[message]
message= _ "heir to the throne message" #this will be translated using the HttT textdomain
[/message]
[message]
message= _ "heir to the throne message two" #same as above
[/message]

#textdomain wesnoth-utbs
[message]
message= _ "under the burning suns message" #UtbS textdomain
[/message]
[/event]

[event]
[message]
message= _ "the rise of wesnoth message" #TroW textdomain
[/message]
[/event]

Note: The [scenario] tag isn't a child of [campaign], so you will have to specify a textdomain for both, your campaign and each of your scenarios.

== the [textdomain] tag ==

This tag, which has to be placed at the same level as [campaign], is used to specify a path for your own textdomain.

Example:
[textdomain]
name="wesnoth-Liberty"
path="data/campaigns/Liberty/translations"
[/textdomain]