The Deadlock Wiki

Editing Template:Translate/doc

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 =
=How to help translate=
Navigate to [[Data:Dictionary]] to add or update keys, or create a new key if one does not already exist.
Navigate to [[Data:Dictionary]] and add the translations for a specific key there. For example, to translate  'Patch notes' to spanish (es), edit the record in the Dictionary from


For additional context about where a key is used, see [[Data:Dictionary/sources]].
<pre>
"Patch notes": {
"en": "Patch notes",
"ru": "Содержание обновления"
}
</pre>


== Tooltip notes ==
to
* '''{{tl|NeedsTranslationTooltip}}''' {{NeedsTranslationTooltip}} - displayed when the key is not translated.
* '''{{tl|MissingValveTranslationTooltip}}''' {{MissingValveTranslationTooltip}} (manual) - displayed in cases where an official translation is expected but unavailable.


== Usage ==
<pre>
Use this template to translate reusable text strings and interface text that appear in templates, such as {{tl|Update layout}}. Page-specific content should be translated on the corresponding language subpage.
"Patch notes": {
"en": "Patch notes",
"ru": "Содержание обновления",
"es": "Notas de revision"
}
</pre>


If a translation is unavailable, the template falls back to the english translation and displays the missing translation tooltip. An optional parameter allows the language to be overridden.


See also: [[Module:Dictionary]].
Similarly, if translating a new key not yet added, simply add the record that looks like the above at the bottom of the page, but be sure the last curly brace } has a comma afterwards.


=== Examples ===
=When to use=
This should only be used to translate text written in Templates, such as [[Template:Update layout]] which outputs "Patch notes" above the UI element. Page specific content should be translated on that page in that language, i.e. /Abrams/es or /Abrams/en


<code><nowiki>{{Translate|Patch notes}}</nowiki></code> Output: {{Translate|Patch notes}}
=Example=
Without providing lang_override, the language will be detected based on the subpage the user is on, i.e. /Abrams/es will be detected as a spanish page.
<pre style="width: fit-content">{{Translate|Patch notes}}</pre>


<code><nowiki>{{Translate|Patch notes|lang_code=ru}}</nowiki></code> Output: {{Translate|Patch notes|lang_code=ru}}
Outputs


<templatedata>
{{Translate|Patch notes}}
{
 
"description": " ",
 
"params": {
<pre style="width: fit-content">{{Translate|Patch notes|ru}}</pre>
"1": {
 
"label": "Dictionary key",
Outputs
"description": "The key that corresponds to the text to be translated.",
 
"type": "string",
{{Translate|Patch notes|ru}}
"required": true,
 
"example": "Patch notes"
 
},
If translation to that language does not yet exist, it will default to the english translation. If the english translation also does not exist, it will default to the provided key. In both cases, it will add <code><nowiki>{{NeedsTranslationTooltip}}</nowiki></code> at the end to guide users to help translate it, appearing as {{NeedsTranslationTooltip}}.
"lang_code": {
 
"label": "Language code",
<pre style="width: fit-content">{{Translate|Patch notes|made-up-code}}</pre>
"description": "Optional language code to override the language. See Data:LangCodes.json.",
 
"example": "es, cs, pt-br",
Outputs
"type": "string"
 
}
{{Translate|Patch notes|made-up-code}}
},
 
"paramOrder": [
=Lua=
"1",
This template simply forwards parameters to the Lua function <code>translate</code> from [[Module:Translate]]. If familiar with Lua invokes, try using it or <code>translate_embed</code> instead.
"lang_code"
 
],
=Parameters=
"format": "inline"
 
<templatedata>{
    "description": "A template to fetch translations for a given key, optionally overriding the language.",
    "params": {
        "1": {
            "label": "key_to_translate",
            "description": "The key that corresponds to the text to be translated.",
            "type": "string",
            "required": true,
            "example": "Patch notes"
        },
        "2": {
            "label": "lang_override",
            "description": "Optional two-letter language code to override the language (e.g., 'en', 'es'), if page ends in /<lang_code> it defaults to that lang code.",
            "type": "string",
            "required": false,
            "example": "es",
            "default": ""
        }
    }
}</templatedata>
}</templatedata>
<includeonly>[[Category:Language templates]]</includeonly><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:Translate/doc"