Help:Translation switching - Revision history

Tark at 06:16, 28 September 2021

2021-09-28T06:16:31Z

← Older revision		Revision as of 06:16, 28 September 2021
Line 1:		Line 1:
			{{NS HELP navbar}}

	'''Translation switching''' is used on many templates and other message boxes across the wiki. The template '''{{tl\|lang}}''' detects the name of the language page and ''switches'' the text. Its main purpose is to keep all localized versions of text centralized into one template.		'''Translation switching''' is used on many templates and other message boxes across the wiki. The template '''{{tl\|lang}}''' detects the name of the language page and ''switches'' the text. Its main purpose is to keep all localized versions of text centralized into one template.

Line 5:		Line 7:
	== What should use translation switching? ==		== What should use translation switching? ==

	In general, all templates should use it~~. This includes infoboxes to maintenance messages, among others~~.		In general, all templates should use it.

	== How to add localized strings ==		== How to add localized strings ==

	# Select a template from the [[:Category:Templates that use translation switching\|list of templates]] that use translation switching.		# Select a template from the [[:Category:Templates that use translation switching\|list of templates]] that use translation switching.
	# Edit the template and add your strings (please use alphabetical ordering for convenience).		# Edit the template and add your strings (please use alphabetical ordering for convenience, with the English string on top).
	# Update the template {{tl\|translation switching}} or {{tl\|ts}} towards the bottom of the page and add your language code to the list.		# Update the template {{tl\|translation switching}} or {{tl\|ts}} towards the bottom of the page and add your language code to the list.

Line 17:		Line 19:
	<pre><nowiki>		<pre><nowiki>
	{{lang		{{lang
			\| en = Welcome
	\| cs = Vítejte		\| cs = Vítejte
	\| de = Willkommen		\| de = Willkommen
	~~\| en = Welcome~~
	\| ja = Irashaimasu		\| ja = Irashaimasu
	\| ru = Добро пожаловать		\| ru = Добро пожаловать
Line 32:		Line 34:

	<nowiki>{{lang</nowiki>		<nowiki>{{lang</nowiki>
			\| en = Welcome
	\| cs = Vítejte		\| cs = Vítejte
	\| de = Willkommen		\| de = Willkommen
	~~\| en = Welcome~~
	<span style="font-weight:bolder;font-size:110%;color:#006F00;">\| it = Benvenuto</span>		<span style="font-weight:bolder;font-size:110%;color:#006F00;">\| it = Benvenuto</span>
	\| ja = Irashaimasu		\| ja = Irashaimasu
Line 46:		Line 48:
	Make sure to add the language to the {{tl\|translation switching}} template towards the bottom of the page, also.		Make sure to add the language to the {{tl\|translation switching}} template towards the bottom of the page, also.

	:{{c\|important}}: Remember to add language strings in alphabetical order.		:{{c\|important}}: Remember to add language strings in alphabetical order, with English being on top.

	== Templates without translation switching ==		== Templates without translation switching ==
Line 107:		Line 109:
	{{tl\|if lang}} tests whether the page is a language page, and if it is, it'll output the language code (in this case, it's {{code\|/fr}}). So the link in this example will go to [[Welcome/fr]], and the text displayed on the link will be French, as well.		{{tl\|if lang}} tests whether the page is a language page, and if it is, it'll output the language code (in this case, it's {{code\|/fr}}). So the link in this example will go to [[Welcome/fr]], and the text displayed on the link will be French, as well.

	It's important to not put a space in front of {{tl\|if lang}} (for example {{code\|1=[[~~Hats~~ <nowiki>{{if lang}}</nowiki>]]}}) This is because, when used in a link, it will produce [[~~Chell~~/fr]] instead of [[Chell/fr]].		It's important to not put a space in front of {{tl\|if lang}} (for example {{code\|1=[[Chell <nowiki>{{if lang}}</nowiki>]]}}) This is because, when used in a link, it will produce [[Chell_/fr]] instead of [[Chell/fr]].

	=== Language categories ===		=== Language categories ===
Line 122:		Line 124:
	== See also ==		== See also ==
	* [[Help:Language translation]] – how to translate normal article pages.		* [[Help:Language translation]] – how to translate normal article pages.


	~~{{NS HELP navbar}}~~

	[[Category:Help]]		[[Category:Help]]
	[[Category:Portal Wiki translation]]		[[Category:Portal Wiki translation]]

Seb: /* Templates without translation switching */ forgot dis

2011-04-25T09:30:25Z

Templates without translation switching: forgot dis

← Older revision		Revision as of 09:30, 25 April 2011
Line 107:		Line 107:
	{{tl\|if lang}} tests whether the page is a language page, and if it is, it'll output the language code (in this case, it's {{code\|/fr}}). So the link in this example will go to [[Welcome/fr]], and the text displayed on the link will be French, as well.		{{tl\|if lang}} tests whether the page is a language page, and if it is, it'll output the language code (in this case, it's {{code\|/fr}}). So the link in this example will go to [[Welcome/fr]], and the text displayed on the link will be French, as well.

	It's important to not put a space in front of {{tl\|if lang}} (for example {{code\|1=[[Hats <nowiki>{{if lang}}</nowiki>]]}}) This is because, when used in a link, it will produce [[~~Hats_~~/fr]] instead of [[~~Hats~~/fr]].		It's important to not put a space in front of {{tl\|if lang}} (for example {{code\|1=[[Hats <nowiki>{{if lang}}</nowiki>]]}}) This is because, when used in a link, it will produce [[Chell/fr]] instead of [[Chell/fr]].

	=== Language categories ===		=== Language categories ===
	{{tl\|lang cat}} can be particularly handy for placing some templates in categories based on their language. For example, {{tlx\|lang cat\|~~Soldier~~}} will place German pages in [[:Category:~~Soldier~~/de]], and French pages in [[:Category:~~Soldier~~/fr]].		{{tl\|lang cat}} can be particularly handy for placing some templates in categories based on their language. For example, {{tlx\|lang cat\|Characters}} will place German pages in [[:Category:Characters/de]], and French pages in [[:Category:Characters/fr]].

	== Related language templates ==		== Related language templates ==

RJackson: Copypasted from TF wiki - only had to adjust the category. Worded very generically, which is goooood.

2011-04-25T09:28:37Z

Copypasted from TF wiki - only had to adjust the category. Worded very generically, which is goooood.

New page

'''Translation switching''' is used on many templates and other message boxes across the wiki. The template '''{{tl|lang}}''' detects the name of the language page and ''switches'' the text. Its main purpose is to keep all localized versions of text centralized into one template.

In the past, translators would create pages like ''Template:Cleanup/ru'', which would lead to a lot of misplaced and inconsistent localized templates. Now all translators have to do is simply add a few lines of code to the existing [[Template:Cleanup]] page and whenever that template is used on a Russian page, the template will automatically switch to show the Russian text.

== What should use translation switching? ==

In general, all templates should use it. This includes infoboxes to maintenance messages, among others.

== How to add localized strings ==

# Select a template from the [[:Category:Templates that use translation switching|list of templates]] that use translation switching.
# Edit the template and add your strings (please use alphabetical ordering for convenience).
# Update the template {{tl|translation switching}} or {{tl|ts}} towards the bottom of the page and add your language code to the list.

=== Example ===
Let's say you're adding Italian strings to a template. The template might already look like this:
<pre><nowiki>
{{lang
| cs = Vítejte
| de = Willkommen
| en = Welcome
| ja = Irashaimasu
| ru = Добро пожаловать
}}

...

{{translation switching|cs, de, ja, ru}}
</nowiki></pre>

So add your lines, copying the style of the ones above and below, so it looks like this:

<nowiki>{{lang</nowiki>
| cs = Vítejte
| de = Willkommen
| en = Welcome
<span style="font-weight:bolder;font-size:110%;color:#006F00;">| it = Benvenuto</span>
| ja = Irashaimasu
| ru = Добро пожаловать
}}

...

<nowiki>{{</nowiki>translation switching|cs, de, <span style="font-weight:bolder;font-size:115%;color:#006F00;">it,</span> ja, ru}}

Make sure to add the language to the {{tl|translation switching}} template towards the bottom of the page, also.

:{{c|important}}: Remember to add language strings in alphabetical order.

== Templates without translation switching ==
If you come across a particular template that requires translation switching and you want to add it, then feel free to make a start. The instructions below detail how to add {{tl|lang}} to templates.

You may also wish to take a look at the [[:Category:Templates that use translation switching|list of other templates]] that have localized strings to try and copy the layout. Be aware of more intricate templates such as [[:Category:Infobox templates|infobox templates]] as their uses of {{tl|lang}} can be appear to be quite complex.

If you need help with a particular template, simply post on the talk page of it or contact one of the [[Help:Group rights|moderators]] or [[Help:Group rights|admins]], as they'd be happy to help you.

=== Parts of templates ===
Let's say a template contains the text:

<pre style="margin-left:2em;"><nowiki>
Lorem ipsum dolor '''[[Welcome]]''' lorem ipsum.
</nowiki></pre>

Now after modifying it for translation switching:

<pre style="margin-left:2em;"><nowiki>
Lorem ipsum dolor '''[[{{lang
| en = Welcome
| ja = Irashaimasu
}}]]''' lorem ipsum.
</nowiki></pre>

Notice there are no extra line breaks or spaces, like there are in this example:

<pre style="margin-left:2em;"><nowiki>
Lorem ipsum dolor '''[[

{{lang
| en = Welcome
| ja = Irashaimasu
}}

]]''' lorem ipsum.
</nowiki></pre>

You can have as many line breaks as you want ''inside'' lang's {{code|{{}} brackets {{code|}}}}, but ''outside'' there must be no spaces, line breaks or gaps at all.

=== Language links ===
Sometimes you may need to switch a link based on the language. A template may look like this:

<pre style="margin-left:2em;"><nowiki>
[[Welcome|{{lang
| en = Welcome
| fr = Accueil
}}]]
</nowiki></pre>

But you want the link to go to [[Welcome/fr]] instead of [[Welcome]]. This does the job:

<pre style="margin-left:2em;"><nowiki>
[[Welcome{{if lang}}|{{lang
| en = Welcome
| fr = Accueil
}}]]
</nowiki></pre>

{{tl|if lang}} tests whether the page is a language page, and if it is, it'll output the language code (in this case, it's {{code|/fr}}). So the link in this example will go to [[Welcome/fr]], and the text displayed on the link will be French, as well.

It's important to not put a space in front of {{tl|if lang}} (for example {{code|1=[[Hats <nowiki>{{if lang}}</nowiki>]]}}) This is because, when used in a link, it will produce [[Hats_/fr]] instead of [[Hats/fr]].

=== Language categories ===
{{tl|lang cat}} can be particularly handy for placing some templates in categories based on their language. For example, {{tlx|lang cat|Soldier}} will place German pages in [[:Category:Soldier/de]], and French pages in [[:Category:Soldier/fr]].

== Related language templates ==
{{see also|:Category:Language templates}}
For more advanced uses of translation switching we have the following templates:

* {{tl|lang cat}} – places a page in a particular category based on their language subpage name.
* {{tl|if lang}} – can produce two outputs based on whether the page is a language subpage or not (as opposed to {{tl|lang}} which can define outputs on ''specific'' languages).
** This is handy to avoid the use of {{tl|lang}} like this: {{tlx|1=lang|2=de=_de|3=fr=_fr|4=ru=_ru}}

== See also ==
* [[Help:Language translation]] – how to translate normal article pages.

{{NS HELP navbar}}

[[Category:Help]]
[[Category:Portal Wiki translation]]