Template:Lang/doc: Difference between revisionsGive feedback
Added detail on language selection and improved general formatting |
mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
This template retrieves localized strings from their relevant JSON file, based on the language code. If no language code is found in the URL, it defaults to english. | |||
Localizations of this type come from the game files and have a file per language, such as [[Data: | Localizations of this type come from the game files and have a file (Data:Lang xx.json) per language, such as [[Data:Lang en.json]]. | ||
== Usage == | === Usage === | ||
Use of the | Use of the {{tl|Lang}} template comes in two forms, either by setting the <code>key</code> argument or the <code>label</code> argument '''(but not both!)'''. | ||
=== Language | === Language selection === | ||
Selection of the language is based off of the URL sub-page name, defaulting to | Selection of the language is based off of the URL sub-page name, defaulting to english if none is found. For example, <code>Abrams/es</code> will use language code "es" (spanish). | ||
Alternatively, <code>lang_code</code> can be used to override of the automated language selection. | Alternatively, <code>lang_code</code> can be used to override of the automated language selection. | ||
| Line 14: | Line 14: | ||
=== Examples === | === Examples === | ||
==== Retrieve word by key ==== | ==== Retrieve word by key ==== | ||
English string: <code><nowiki>{{Lang|key=BonusClipSize_label}} | English string: <code><nowiki>{{Lang|key=BonusClipSize_label}}</nowiki></code> Output: {{Lang|key=BonusClipSize_label}} | ||
Spanish string: <code><nowiki>{{Lang|key=BonusClipSize_label|lang_code=es}} | |||
Spanish string: <code><nowiki>{{Lang|key=BonusClipSize_label|lang_code=es}}</nowiki></code> Output: {{Lang|key=BonusClipSize_label|lang_code=es}} | |||
==== Retrieve string by label ==== | ==== Retrieve string by label ==== | ||
English string: <code><nowiki>{{Lang|label=Ammo}} | English string: <code><nowiki>{{Lang|label=Ammo}}</nowiki></code> Ouput: {{Lang|label=Ammo}} | ||
Spanish string: <code><nowiki>{{Lang|label=Ammo|lang_code=es}} | |||
Spanish string: <code><nowiki>{{Lang|label=Ammo|lang_code=es}}</nowiki></code> Output: {{Lang|label=Ammo|lang_code=es}} | |||
<templatedata> | <templatedata> | ||
{ | { | ||
"params": { | "params": { | ||
"lang_code": { | |||
"description": "Optional language code to override the language. See Data:LangCodes.json.", | |||
"example": "es, cs, pt-br", | |||
"type": "string" | |||
}, | |||
"key": { | "key": { | ||
"description": "Attribute key to directly retrieve the localized string from its JSON file", | "description": "Attribute key to directly retrieve the localized string from its JSON file.", | ||
"example": "BonusClipSize_label", | "example": "BonusClipSize_label", | ||
"type": "string", | "type": "string", | ||
" | "required": true | ||
}, | }, | ||
"label": { | "label": { | ||
"description": "Used to search for the string by its | "description": "Used to search for the string by its english localized string instead of using the attribute key directly.", | ||
"example": "Ammo", | "example": "Ammo", | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
"paramOrder": [ | "paramOrder": [ | ||
"key", | "key", | ||
"label", | "label", | ||
"lang_code" | "lang_code" | ||
] | ], | ||
"description": " ", | |||
"format": "inline" | |||
} | } | ||
</templatedata> | </templatedata> | ||
<noinclude>[[Category:Template documentation]]</noinclude> | <includeonly>[[Category:Language templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude> | ||
Latest revision as of 21:27, 6 June 2026
Overview
[edit source]This template retrieves localized strings from their relevant JSON file, based on the language code. If no language code is found in the URL, it defaults to english.
Localizations of this type come from the game files and have a file (Data:Lang xx.json) per language, such as Data:Lang en.json.
Usage
[edit source]Use of the {{Lang}} template comes in two forms, either by setting the key argument or the label argument (but not both!).
Language selection
[edit source]Selection of the language is based off of the URL sub-page name, defaulting to english if none is found. For example, Abrams/es will use language code "es" (spanish).
Alternatively, lang_code can be used to override of the automated language selection.
Examples
[edit source]Retrieve word by key
[edit source]English string: {{Lang|key=BonusClipSize_label}} Output: Ammo
Spanish string: {{Lang|key=BonusClipSize_label|lang_code=es}} Output: Munición
Retrieve string by label
[edit source]English string: {{Lang|label=Ammo}} Ouput: Ammo
Spanish string: {{Lang|label=Ammo|lang_code=es}} Output: Munición
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| key | key | Attribute key to directly retrieve the localized string from its JSON file.
| String | required |
| label | label | Used to search for the string by its english localized string instead of using the attribute key directly.
| String | optional |
| lang_code | lang_code | Optional language code to override the language. See Data:LangCodes.json.
| String | optional |