Teamplaid:LangSwitch/documentation
This is a documentation subpage for . It contains usage information, categories and other content that is not part of the original teamplaid page. |
Provides a method to present a string of text selected from an array of many language translations in the language set in the user's preferences or the most appropiate fallback language (as determined by {{GetFallback}}).
Usage
{{LangSwitch
|en=
|xx=
|default=
}}
Parameters
Parameter name | Description | Default value | required or optional?
|
---|---|---|---|
en | Text in English language. Unless default is used, this text will also be used if the languages provided do not include the language set in the user's preferences. If you do not want to show any text when the user's language is English, then use "en=~". LangSwitch templates without an en option will be added to Roinn-seòrsa:LangSwitch template without English version. | empty | required |
xx | Translated text in language xx (The parameter name xx can be any supported language code, and you can specify as many such parameters as needed for each translated language). Use "~" if you do not want any message (or default) in some specific language. | empty | optional |
default | Default text in case one of the 'xx' languages is not the language of user’s preferences. By default, the English version will be shown, if provided. | {{{en|}}} (English version) | optional |
lang | language code (only needs to be provided if the language displayed is to be fixed and independent of the user’s preferences). This option is usually only used for template debugging. | value of {{int:Lang}} (the preferred language of the visitor viewing the page).
|
optional |
nocat | "nocat=1" will overwrite the default behavior of adding Roinn-seòrsa:LangSwitch template without English version to pages with no "en" and "default" options | empty | optional |
Additional information
The template is intended to be used in the following namespaces: the Template namespace
The template is intended to be used by the following user groups: no user group specified
Feum air:
{{GetFallback}}, {{GetFallback2}}
Faic cuideachd:
Examples
Here are a few examples showing template behavior for three languages: English, French and Corsu, which defaults to French if Corsu text is not available:
Test | Code | lang=en | lang=fr | lang=co |
---|---|---|---|---|
no En; default | {{LangSwitch|fr=French|default=default}} | default | French | French |
no En ; no default | {{LangSwitch|fr=French|co=Corsu}} | [1] | French[1] | Corsu[1] |
En; default | {{LangSwitch|en=English|co=Corsu|default=default}} | English | default | Corsu |
En; no default | {{LangSwitch|en=English|co=Corsu}} | English | English | Corsu |
empty En; default | {{LangSwitch|en=~|fr=French|default=default}} | French | French | |
empty En; no default | {{LangSwitch|en=~|fr=French}} | French | French | |
En; default; empty Fr | {{LangSwitch|en=English|fr=~|co=Corsu|default=default}} | English | Corsu | |
En; default; empty Fr | {{LangSwitch|en=English|fr=|co=Corsu|default=default}} | English | default | Corsu |
En; no default; empty Fr | {{LangSwitch|en=English|fr=~|co=Corsu}} | English | Corsu | |
simple case with "lang=" | {{LangSwitch|en=English|fr=French|co=Corsu|default=default|lang=}} | default | default | default |
The default option is intended for providing more language independent option. For example:
{{LangSwitch |de=[[:de:Warschau|Warschau]] |fr=[[:fr:Varsovie|Varsovie]] |pl=[[:pl:Warszawa|Warszawa]] |en=[[:en:Warsaw|Warsaw]] |default=[[Warsaw]] }}
will provide link to wikipedia articles in case one of the languages provided matches user's language but will link to Commons gallery page (Warsaw) if any other language is used.