Difference between revisions of "Help:Translation switching"

From Team Fortress Wiki
Jump to: navigation, search
m
(expand)
Line 44: Line 44:
 
   
 
   
 
  <nowiki>{{</nowiki>translation switching|de, cs, <span style="font-weight:bolder;font-size:115%;color:#006F00;">it,</span> ja}}
 
  <nowiki>{{</nowiki>translation switching|de, cs, <span style="font-weight:bolder;font-size:115%;color:#006F00;">it,</span> ja}}
 +
 +
Make sure to add the language to the {{tl|translation switching}} template towards the bottom of the page, also.
  
 
== Templates without translation switching ==
 
== 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 start us off. Take a look at the [[:Category:Templates that use translation switching|list of other templates]] that have localized strings and 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 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>
 +
'''[[Welcome]]'''
 +
</nowiki></pre>
 +
 
 +
Now after modifying it for translation switching:
 +
 
 +
<pre style="margin-left:2em;"><nowiki>
 +
'''[[{{lang
 +
| en = Welcome
 +
| ja = Irashaimasu
 +
}}]]'''
 +
</nowiki></pre>
 +
 
 +
Notice there are no extra line breaks or spaces, like there are in this example:
 +
 
 +
<pre style="margin-left:2em;"><nowiki>
 +
'''[[
 +
 
 +
{{lang
 +
| en = Welcome
 +
| ja = Irashaimasu
 +
}}
 +
 
 +
]]'''
 +
</nowiki></pre>
 +
 
 +
You can have as many line breaks as you want ''inside'' lang's {{code|&#123;&#123;}} brackets {{code|&#125;&#125;}}, 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.
  
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]] and they'd be happy to help you.
+
=== 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 ==
 
== Related language templates ==

Revision as of 10:59, 25 August 2010

Translation switching is used on many templates and other message boxes across the wiki. The template {{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, etc.
  • The exception to this currently is navigational templates which use {{Navbox}}. These should be maintained on separate template pages.

How to add localized strings

  1. Select a template from the list of templates that use translation switching.
  2. Edit the template and add your strings (please use alphabetical ordering for convenience).
  3. Update the template {{translation switching}} or {{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:

{{lang
  | de = Willkommen
  | cs = Vítejte
  | en = Welcome
  | ja = Irashaimasu
}}

...

{{translation switching|de, cs, ja}}

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

{{lang
  | de = Willkommen
  | cs = Vítejte
  | en = Welcome
  | it = Benvenuto
  | ja = Irashaimasu
}}

...

{{translation switching|de, cs, it, ja}}

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

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 {{lang}} to templates.

You may also wish to take a look at the list of other templates that have localized strings to try and copy the layout. Be aware of more intricate templates such as infobox templates as their uses of {{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 moderators or admins, as they'd be happy to help you.

Parts of templates

Let's say a template contains the text:

'''[[Welcome]]'''

Now after modifying it for translation switching:

'''[[{{lang
 | en = Welcome
 | ja = Irashaimasu
 }}]]'''

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

'''[[

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

]]'''

You can have as many line breaks as you want inside lang's {{ brackets }}, 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:

* [[Welcome|{{lang
| en = Welcome
| fr =  Accueil
}}]]

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

* [[Welcome{{if lang}}|{{lang
| en = Welcome
| fr =  Accueil
}}]]

{{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 /fr). So the link in this example will go to Welcome/fr, and the text displayed on the link will be French, as well.

Language categories

{{lang cat}} can be particularly handy for placing some templates in categories based on their language. For example, {{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|:Category:Language templates]]

For more advanced uses of translation switching we have the following templates:

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

See also