Template:Lang/doc: Difference between revisions

From Deadlock Wiki
Jump to navigation Jump to search
Saag (talk | contribs)
Created doc for Lang template
 
Saag (talk | contribs)
Added detail on language selection and improved general formatting
 
(4 intermediate revisions by 2 users not shown)
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 search 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>English string: {{Lang|key=BonusClipSize_label}} -> "Ammo"</pre>
English string: <code><nowiki>{{Lang|key=BonusClipSize_label}} -></nowiki></code> {{Lang|key=BonusClipSize_label}}<br><br>
<pre>French string: {{Lang|key=BonusClipSize_label|lang_code=fr}} -> "Munitions"</pre>
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>English string: {{Lang|label=Ammo}} -> "Ammo"</pre>
English string: <code><nowiki>{{Lang|label=Ammo}} -></nowiki></code> {{Lang|label=Ammo}}<br><br>
<pre>French string: {{Lang|label=Ammo|lang_code=fr}} -> "Munitions"</pre>
Spanish string: <code><nowiki>{{Lang|label=Ammo|lang_code=es}} -></nowiki></code> {{Lang|label=Ammo|lang_code=es}}<br><br>


<templatedata>
<templatedata>
Line 22: Line 30:
},
},
"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 28: Line 36:
},
},
"label": {
"label": {
"description": "Used to search for the string by its English label instead of using the attribute key directly",
"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": ""
     "description": "",
"paramOrder": [
"key",
"label",
"lang_code"
]
}
}
</templatedata>
</templatedata>
<noinclude>[[Category:Template documentation]]</noinclude>
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 09:24, 18 September 2024

Overview[edit source]

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[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", which is 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}} -> Ammo

Spanish string: {{Lang|key=BonusClipSize_label|lang_code=es}} -> de munición

Retrieve string by label[edit source]

English string: {{Lang|label=Ammo}} -> Ammo

Spanish string: {{Lang|label=Ammo|lang_code=es}} -> de munición

Template parameters

ParameterDescriptionTypeStatus
keykey

Attribute key to directly retrieve the localized string from its JSON file

Example
BonusClipSize_label
Stringoptional
labellabel

Used to search for the string by its English localized string instead of using the attribute key directly

Example
Ammo
Stringoptional
lang_codelang_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.

Default
Defaults to "en" (English), or if the URL has the code at the end, it will use that
Example
en
Stringoptional