Template:Lang/doc: Difference between revisionsGive feedback
m examples now dynamic |
Added detail on language selection and improved general formatting |
||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
Template for retrieving localized strings from their relevant | Template for retrieving localized strings from their relevant JSON file, based on the language code in the URL. 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:Lang_en.json]] for English. | |||
== Usage == | |||
Use of the <code>Lang</code> template comes in two forms, either by setting the <code>key</code> argument or the <code>label</code> argument '''(but not both!)'''. | |||
=== Language Selection === | |||
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", which is Spanish. | |||
Alternatively, <code>lang_code</code> can be used to override of the automated language selection. | |||
=== Examples === | === Examples === | ||
==== Retrieve word by | ==== Retrieve word by key ==== | ||
English string: <code><nowiki>{{Lang|key=BonusClipSize_label}} -></nowiki></code> {{Lang|key=BonusClipSize_label}}<br><br> | |||
< | Spanish string: <code><nowiki>{{Lang|key=BonusClipSize_label|lang_code=es}} -></nowiki></code> {{Lang|key=BonusClipSize_label|lang_code=es}}<br><br> | ||
==== Retrieve string by label ==== | ==== Retrieve string by label ==== | ||
English string: <code><nowiki>{{Lang|label=Ammo}} -></nowiki></code> {{Lang|label=Ammo}}<br><br> | |||
< | Spanish string: <code><nowiki>{{Lang|label=Ammo|lang_code=es}} -></nowiki></code> {{Lang|label=Ammo|lang_code=es}}<br><br> | ||
<templatedata> | <templatedata> | ||
| Line 33: | Line 41: | ||
} | } | ||
}, | }, | ||
"description": "", | |||
"paramOrder": [ | "paramOrder": [ | ||
"key", | "key", | ||
Revision as of 09:24, 18 September 2024
Overview
Template for retrieving localized strings from their relevant JSON file, based on the language code in the URL. 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:Lang_en.json for English.
Usage
Use of the Lang template comes in two forms, either by setting the key argument or the label argument (but not both!).
Language Selection
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", which is Spanish.
Alternatively, lang_code can be used to override of the automated language selection.
Examples
Retrieve word by key
English string: {{Lang|key=BonusClipSize_label}} -> Ammo
Spanish string: {{Lang|key=BonusClipSize_label|lang_code=es}} -> Munición
Retrieve string by label
English string: {{Lang|label=Ammo}} -> Ammo
Spanish string: {{Lang|label=Ammo|lang_code=es}} -> Munición
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| key | key | Attribute key to directly retrieve the localized string from its JSON file
| String | optional |
| 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 | Two-letter language code for selecting language of string. Note that this should not usually be used, as the lang code will be pulled from the URL subpage.
| String | optional |