Template:Lang/doc: Difference between revisions

Sur (talk | contribs)
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 json file, such as '''Data:Lang_en.json''' for English. Note that localized strings are all pulled from raw game files.
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.


Supports retrieval via the JSON '''key''' or by referencing it using the English '''label'''
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 the attribute key ====
==== Retrieve word by key ====
<pre style="width:fit-content;>English string: {{Lang|key=BonusClipSize_label}} -></pre> {{Lang|key=BonusClipSize_label}}<br><br>
English string: <code><nowiki>{{Lang|key=BonusClipSize_label}} -></nowiki></code> {{Lang|key=BonusClipSize_label}}<br><br>
<pre style="width:fit-content;>French string:  {{Lang|key=BonusClipSize_label|lang_code=fr}} -></pre> {{Lang|key=BonusClipSize_label|lang_code=fr}}<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 ====
<pre style="width:fit-content;>English string: {{Lang|label=Ammo}} -></pre> {{Lang|label=Ammo}}<br><br>
English string: <code><nowiki>{{Lang|label=Ammo}} -></nowiki></code> {{Lang|label=Ammo}}<br><br>
<pre style="width:fit-content;>French string:  {{Lang|label=Ammo|lang_code=fr}} -></pre> {{Lang|label=Ammo|lang_code=fr}}<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",