Template:Lang: Difference between revisions

From Deadlock Wiki
Jump to navigation Jump to search
Saag (talk | contribs)
Added proper documentation
Sur (talk | contribs)
m lang_code_override now a named arg for get_string
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly>
<includeonly><!--
{{#if:{{{key}}}|{{#invoke:Lang|get_string|{{{key|}}}|{{{lang_code|en}}}}}|
{{#if:{{{label}}}|{{#invoke:Lang|search_string|{{{label|}}}|{{{lang_code|en}}}}}|
"label" or "key" is required}}}}
</includeonly>


<noinclude>
-->{{#if:{{{key|}}}|{{#invoke:Lang|get_string|{{{key|}}}|lang_code_override={{{lang_code|}}}}}|<!--
-->{{#if:{{{label|}}}|{{#invoke:Lang|search_string|{{{label|}}}|{{{lang_code|}}}}}|<!--
-->"label" or "key" is required}}}}<!--
 
--></includeonly><!--
--><noinclude>
{{Documentation}}
{{Documentation}}
</noinclude>
</noinclude>

Latest revision as of 00:14, 11 October 2024

Template documentation [view] [edit] [history] [purge]

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[Edit template data]

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