View source for Template:LangSwitch/doc

{{TemplateBox
|name=LangSwitch
|desc=
{{LangSwitch
|en=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 appropriate fallback language (as determined by {{tl|GetFallback}}).
|fr=Permet de présenter un texte dans la langue de l’utilisateur, en sélectionnant depuis un ensemble de versions en différentes langues. La langue choisie est soit celle définie dans les préférences de l’utilisateur, soit la plus appropriée déterminée par {{tl|GetFallback}}.
|ja=翻訳されている多くの言語の中から、適切な言語でテキスト文字を表示する機能を提供します。その適切な言語とは、ユーザの好みに応じて言語セットで選択された言語、あるいは、({{tl|GetFallback}}で定義される)自動システムで一番最適と思われる言語です。
|mk=Од разните постоечки преводи, го дава преводот на јазикот одбран во нагодувањата, или пак најсоодветниот резервен јазик (според утврденото во {{tl|GetFallback}}).
}}

|1=en
|1d=
{{LangSwitch
|en=Text in English language. Unless ''default'' option 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 [[:Category:LangSwitch template without English version]].
|ja=英語言語の文字。下記の''デフォルト''オプションを設定していない場合で、ユーザが選択した言語セットに該当する翻訳がない場合、この英語テキストが通常使われます。もしユーザの使用言語が英語で何も文字を表示させたくない場合、「en=~」と記述してください。「en」オプションのないLangSwitchテンプレートはカテゴリ[[:Category:LangSwitch template without English version]]に自動的に追加されます。
}}
|1def=
|1stat=required

|2=''xx''
|2d=
{{LangSwitch
|en=Translated text in language ''xx'' (the parameter name ''xx'' can be [[:en:List_of_Wikipedias#List|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.
|fr=La valeur est le texte traduit dans la langue de code ''xx'' (le nom du paramètre ''xx'' peut être n’importe quel code langue supporté, et vous pouvez indiquer autant de paramètres que nécessaire pour chaque langue de traduction).
|ja=言語「''xx''」で翻訳された文字。 (パラメーター名「''xx''」は[[:en:List_of_Wikipedias#List|サポートされている言語コード]]なら何でも大丈夫で、翻訳する言語ごとにいくつでも指定可能です)　もし特定の言語でメッセージを表示させたくない場合（あるいはデフォルト値として）、「xx=~」と記述してください。
|mk=текст на јазикот ''xx''. ''xx'' може да бидат било кои поддржани јазици.
}}
|2def=
|2stat=optional

|3=default
|3d=
{{LangSwitch
|en=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.
|ja=デフォルト言語の文字。上記の「xx」言語の中にユーザが指定した言語が含まれていない場合に、このデフォルト・オプションを使います。通常はデフォルトとして英語（en）で表示されます。
}}
|3def=<nowiki>{{{en|}}}</nowiki> (English version)
|3stat=optional

|4=lang
|4d={{Language-code-documentation}}
|4def=
{{LangSwitch
|en=Value of <code><nowiki>{{int:Lang}}</nowiki></code> (the preferred language of the visitor viewing the page)
|fr=La valeur de <code><nowiki>{{int:Lang}}</nowiki></code> (la langue préférée du visiteur visualisant la page)
|ja=<code><nowiki>{{int:Lang}}</nowiki></code>の値 （ページを閲覧しているビジターの使用言語）。
}}
|4stat=optional-

|5=nocat
|5d=
{{LangSwitch
|en="nocat=1" will overwrite the default behavior of adding [[:Category:LangSwitch template without English version]] to pages with no "en" and "default" options.
|ja=言語オプションに「en」や「default」オプションがないページには自動的にカテゴリ[[:Category:LangSwitch template without English version]]に追加され、"nocat=1" はデフォルト動作を上書きします。
}}
|5def=
|5stat=optional-

|example=
|usage-notes=
|seealso=
* {{tl|autotranslate}}
* {{tl|Translation table}}
* [[:Category:Internationalization templates using LangSwitch]]
|setscats=
|type=localization
|namespace=Template
|usergroup=
|i18n-method=LangSwitch
|i18n-desc=
|lines=multi
|shorthand=
|relieson={{tl|GetFallback}}, {{tl|GetFallback2}}
}}

== 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:

{| border="1"
! Test
! Code
! lang=en
! lang=fr
! lang=co
|-
|  No En; default
| <code><nowiki>{{LangSwitch|fr=French|default=default}}</nowiki></code>
| {{LangSwitch|fr=French|default=default|lang=en}}
| {{LangSwitch|fr=French|default=default|lang=fr}}
| {{LangSwitch|fr=French|default=default|lang=co}}
|-
|  No En ; no default
| <code><nowiki>{{LangSwitch|fr=French|co=Corsu}}</nowiki></code>
| {{LangSwitch|fr=French|co=Corsu|lang=en|nocat=1}}<ref name="c">adds [[:Category:LangSwitch template without English version]]</ref>
| {{LangSwitch|fr=French|co=Corsu|lang=fr|nocat=1}}<ref name="c"/>
| {{LangSwitch|fr=French|co=Corsu|lang=co|nocat=1}}<ref name="c"/>
|-
|  En; default
| <code><nowiki>{{LangSwitch|en=English|co=Corsu|default=default}}</nowiki></code>
| {{LangSwitch|en=English|co=Corsu|default=default|lang=en}}
| {{LangSwitch|en=English|co=Corsu|default=default|lang=fr}}
| {{LangSwitch|en=English|co=Corsu|default=default|lang=co}}
|-
|  En; no default
| <code><nowiki> {{LangSwitch|en=English|co=Corsu}}</nowiki></code>
| {{LangSwitch|en=English|co=Corsu|lang=en}}
| {{LangSwitch|en=English|co=Corsu|lang=fr}}
| {{LangSwitch|en=English|co=Corsu|lang=co}}
|-
|  Empty En; default
| <code><nowiki>{{LangSwitch|en=~|fr=French|default=default}}</nowiki></code>
| {{LangSwitch|en=~|fr=French|default=default|lang=en}}
| {{LangSwitch|en=~|fr=French|default=default|lang=fr}}
| {{LangSwitch|en=~|fr=French|default=default|lang=co}}
|-
|  Empty En; no default
| <code><nowiki>{{LangSwitch|en=~|fr=French}}</nowiki></code>
| {{LangSwitch|en=~|fr=French|lang=en}}
| {{LangSwitch|en=~|fr=French|lang=fr}}
| {{LangSwitch|en=~|fr=French|lang=co}}
|-
|  En; default; empty Fr
| <code><nowiki> {{LangSwitch|en=English|fr=~|co=Corsu|default=default}}</nowiki></code>
| {{LangSwitch|en=English|fr=~|co=Corsu|default=default|lang=en}}
| {{LangSwitch|en=English|fr=~|co=Corsu|default=default|lang=fr}}
| {{LangSwitch|en=English|fr=~|co=Corsu|default=default|lang=co}}
|-
|  En; default; empty Fr
| <code><nowiki> {{LangSwitch|en=English|fr=|co=Corsu|default=default}}</nowiki></code>
| {{LangSwitch|en=English|fr=|co=Corsu|default=default|lang=en}}
| {{LangSwitch|en=English|fr=|co=Corsu|default=default|lang=fr}}
| {{LangSwitch|en=English|fr=|co=Corsu|default=default|lang=co}}
|-
|  En; no default; empty Fr
| <code><nowiki>{{LangSwitch|en=English|fr=~|co=Corsu}}</nowiki></code>
| {{LangSwitch|en=English|fr=~|co=Corsu|lang=en}}
| {{LangSwitch|en=English|fr=~|co=Corsu|lang=fr}}
| {{LangSwitch|en=English|fr=~|co=Corsu|lang=co}}
|-
|  Simple case with "lang="
| <code><nowiki>{{LangSwitch|en=English|fr=French|co=Corsu|default=default|lang=}}</nowiki></code>
| {{LangSwitch|en=English|fr=French|co=Corsu|default=default|lang=}}
| {{LangSwitch|en=English|fr=French|co=Corsu|default=default|lang=}}
| {{LangSwitch|en=English|fr=French|co=Corsu|default=default|lang=}}
|}

<references/>

The default option is intended for providing more language independent option. For example:
<blockquote style="border: 1px solid #AAAAAA; background: white; color: black; padding: 0.3em;"><pre><nowiki>
{{LangSwitch
|de=[[:de:Warschau|Warschau]]
|en=[[:en:Warsaw|Warsaw]]
|fr=[[:fr:Varsovie|Varsovie]]
|ja=[[:ja:ワルシャワ|ワルシャワ]]
|pl=[[:pl:Warszawa|Warszawa]]
|default=[[Warsaw]]
}}
</nowiki></pre></blockquote>
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.


<includeonly>

[[Category:Function templates]]
[[Category:Internationalization templates]]

</includeonly><noinclude>
[[Category:Imported from Wikimedia Commons 2013]]</noinclude>