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)
No edit summary
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, such as '''Data:Lang_en.json''' for English. Note that localized strings are all pulled from raw game files.


Supports search via the JSON '''key''' or by referencing it using the English '''label'''
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"
}
}
},
}
    "description": ""
}
}
</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.

Template parameters

ParameterDescriptionTypeStatus
keykey

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

Example
BonusClipSize_label
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
labellabel

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

Example
Ammo
Stringoptional