Editing Template:Lang/docGive feedback
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 1: | Line 1: | ||
== Overview == | == 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 | 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 | 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 | === 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", which is 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}}</nowiki></code> | 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> | |||
Spanish string: <code><nowiki>{{Lang|key=BonusClipSize_label|lang_code=es}}</nowiki></code> | |||
==== Retrieve string by label ==== | ==== Retrieve string by label ==== | ||
English string: <code><nowiki>{{Lang|label=Ammo}}</nowiki></code> | 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> | |||
Spanish string: <code><nowiki>{{Lang|label=Ammo|lang_code=es}}</nowiki></code> | |||
<templatedata> | <templatedata> | ||
{ | { | ||
"params": { | "params": { | ||
" | "key": { | ||
"description": " | "description": "Attribute key to directly retrieve the localized string from its JSON file", | ||
"example": " | "example": "BonusClipSize_label", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "lang_code": { | ||
"description": " | "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": " | "example": "en", | ||
"type": "string", | "type": "string", | ||
" | "default": "Defaults to \"en\" (English), or if the URL has the code at the end, it will use that" | ||
}, | }, | ||
"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" | ||
} | } | ||
}, | }, | ||
"description": "", | |||
"paramOrder": [ | "paramOrder": [ | ||
"key", | "key", | ||
"label", | "label", | ||
"lang_code" | "lang_code" | ||
] | ] | ||
} | } | ||
</templatedata> | </templatedata> | ||
<noinclude>[[Category:Template documentation]]</noinclude> | |||