Editing Template:Lang/doc

Jump to navigation Jump to search
Warning: You are not logged in. Once you make an edit, a temporary account will be created for you. Learn more. Log in or create an account to continue receiving notifications after this account expires, and to access other features.
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 ==
This template retrieves localized strings from their relevant JSON file, based on the language code. If no language code is found in the URL, it defaults to english.
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.


Localizations of this type come from the game files and have a file (Data:Lang xx.json) per language, such as [[Data:Lang en.json]].
Supports retrieval via the JSON '''key''' or by referencing it using the English '''label'''
 
=== Usage ===
Use of the {{tl|Lang}} 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" (spanish).
 
Alternatively, <code>lang_code</code> can be used to override of the automated language selection.


=== Examples ===
=== Examples ===
==== Retrieve word by key ====
==== Retrieve word by the attribute key ====
English string: <code><nowiki>{{Lang|key=BonusClipSize_label}}</nowiki></code> Output: {{Lang|key=BonusClipSize_label}}
<pre>English string: {{Lang|key=BonusClipSize_label}} -> "Ammo"</pre>
 
<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> Output: {{Lang|key=BonusClipSize_label|lang_code=es}}


==== Retrieve string by label ====
==== Retrieve string by label ====
English string: <code><nowiki>{{Lang|label=Ammo}}</nowiki></code> Ouput: {{Lang|label=Ammo}}
<pre>English string: {{Lang|label=Ammo}} -> "Ammo"</pre>
 
<pre>French string: {{Lang|label=Ammo|lang_code=fr}} -> "Munitions"</pre>
Spanish string: <code><nowiki>{{Lang|label=Ammo|lang_code=es}}</nowiki></code> Output: {{Lang|label=Ammo|lang_code=es}}


<templatedata>
<templatedata>
{
{
"params": {
"params": {
"lang_code": {
"key": {
"description": "Optional language code to override the language. See Data:LangCodes.json.",
"description": "Attribute key to directly retrieve the localized string from its JSON file",
"example": "es, cs, pt-br",
"example": "BonusClipSize_label",
"type": "string"
"type": "string"
},
},
"key": {
"lang_code": {
"description": "Attribute key to directly retrieve the localized string from its JSON file.",
"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": "BonusClipSize_label",
"example": "en",
"type": "string",
"type": "string",
"required": true
"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 english localized string 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"
Line 47: Line 37:
"label",
"label",
"lang_code"
"lang_code"
],
]
"description": " ",
"format": "inline"
}
}
</templatedata>
</templatedata>
<includeonly>[[Category:Language templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
<noinclude>[[Category:Template documentation]]</noinclude>
Please note that all contributions to The Deadlock Wiki are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike (see Deadlock:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Preview page with this template

Pages included on this page:

Retrieved from "https://deadlock.wiki/Template:Lang/doc"