Template:Lang/doc: Difference between revisions
Jump to navigation
Jump to search
Created doc for Lang template |
No edit summary |
||
Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
Template for retrieving localized strings from their relevant json file, such as | Template for retrieving localized strings from their relevant json file, such as '''Data:Lang_en.json''' for English. Note that localized strings are all pulled from raw game files. | ||
Supports | Supports retrieval via the JSON '''key''' or by referencing it using the English '''label''' | ||
=== Examples === | === Examples === | ||
Line 22: | Line 22: | ||
}, | }, | ||
"lang_code": { | "lang_code": { | ||
"description": "Two-letter language code for selecting language of string. Note that this should usually be used, as the lang code will be pulled from the URL subpage.", | "description": "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.", | ||
"example": "en", | "example": "en", | ||
"type": "string", | "type": "string", | ||
Line 32: | Line 32: | ||
"type": "string" | "type": "string" | ||
} | } | ||
} | } | ||
} | } | ||
</templatedata> | </templatedata> | ||
<noinclude>[[Category:Template documentation]]</noinclude> | <noinclude>[[Category:Template documentation]]</noinclude> |
Revision as of 13:20, 15 September 2024
Overview
Template for retrieving localized strings from their relevant json file, such as Data:Lang_en.json for English. Note that localized strings are all pulled from raw game files.
Supports retrieval via the JSON key or by referencing it using the English label
Examples
Retrieve word by the attribute key
English string: {{Lang|key=BonusClipSize_label}} -> "Ammo"
French string: {{Lang|key=BonusClipSize_label|lang_code=fr}} -> "Munitions"
Retrieve string by label
English string: {{Lang|label=Ammo}} -> "Ammo"
French string: {{Lang|label=Ammo|lang_code=fr}} -> "Munitions"
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
key | key | Attribute key to directly retrieve the localized string from its JSON file
| 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 |
label | label | Used to search for the string by its English label instead of using the attribute key directly
| String | optional |