The Deadlock Wiki

Editing Module:Dictionary/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 =
=Overview=
See {{tl|Translate}} for how/when to use and more documentation.
See [[Template:Translate]] for how/when to use and more documentation.


== p.translate ==
=Functions=
Translates a given key from [[Data:Dictionary]]. '''Manual invocation should only be used when additional parameters are required''', such as {{tl|Update layout}}, where the DISPLAYTITLE is generated using a translation key with expected parameters.
==translate==
Translates a given key using [[Data:Dictionary]].


For normal usage, use the basic template.
===Parameters===
*'''key''' - key to translate
*'''lang_code_override''' (OPTIONAL, Named parameter) - language code that overrides current language. See supported list at [[Data:LangCodes.json]].


=== Function parameters ===
===Example===
* '''key''' – translation key (required).
<code><nowiki>{{#invoke:Dictionary|translate|Update history|lang_code_override=es}}</nowiki></code>
* Language-specific:
** '''lang_code_override''' (optional, named parameter) – language code overriding the automatic detection. See [[Data:LangCodes.json]].
** '''fallback_str''' (optional, named parameter) – value returned '''only if translation is missing'''. If set to empty string or nil, fallback will be empty (useful for detecting missing translations).


=== Examples ===
Outputs
<code><nowiki>{{#invoke:Dictionary|translate|Update history}}</nowiki></code> Output: {{#invoke:Dictionary|translate|Update history}}


<code><nowiki>{{#invoke:Dictionary|translate|Updates|lang_code_override=pt-br}}</nowiki></code> Output: {{#invoke:Dictionary|translate|Updates|lang_code_override=pt-br}}
{{#invoke:Dictionary|translate|Update history|lang_code_override=es}}


<code><nowiki>{{#invoke:Dictionary|translate|Update history|fallback_str=Custom fallback text.}}</nowiki></code> Output: {{#invoke:Dictionary|translate|Updates|lang_code_override=xx<!-- invalid language code to force fallback. -->|fallback_str=Custom fallback text.}}
==translate_embed==
<includeonly>[[Category:Modules]]</includeonly><noinclude>[[Category:Module documentation]]</noinclude>
Translates a given key then replaces %s in the string with extra parameters
 
===Parameters===
*'''key''' - key to translate
*'''var1''' - first variable to embed in the string
*'''var2''' - second
*'''varN''' - Nth
Ensure the number of variables passed matches the number of instances of <code>%s</code> in the translated string.
 
===Examples===
Without embedment:
<code><nowiki>{{#invoke:Dictionary|translate|TranscludedNotesFrom}}</nowiki></code>
 
Outputs
 
{{#invoke:Dictionary|translate|TranscludedNotesFrom}}
 
With embedment:
<pre>{{#invoke:Dictionary|translate_embed
|1=TranscludedNotesFrom
|2=https://en.wikipedia.org/wiki/Help:Transclusion
|3=[[Source_Page/notes]]
|4=https://deadlocked.wiki/index.php?title=Source_Page/notes&action=edit
}}</pre>
 
Outputs
 
{{#invoke:Dictionary|translate_embed
|1=TranscludedNotesFrom
|2=https://en.wikipedia.org/wiki/Help:Transclusion
|3=[[Source_Page/notes]]
|4=https://deadlocked.wiki/index.php?title=Source_Page/notes&action=edit
}}
 
===Notes===
* The parameters do not need to be prefixed with "1=", "2=", etc., they are used in the above example because the 4th parameter contains an equal sign (<code>=</code>) in it, where it would be read as a named parameter rather than a ordinal parameter.
* Ensure the number of passed variables (other than the key) matches the number of %s used in the translated string.
 
 
=Important translations=
<i>Note: these are not yet important, as most translations are only used for in-development pages right now.<br></i>
 
Page/subpage names that can't exist without translation:
* '''Notes''' - for <code><nowiki>[[<ability_name>/Notes]]</nowiki></code>
*
 
Other:
* '''NeedsTranslationTooltip''' - {{NeedsTranslationTooltip}} is displayed when something can't be localized, so the tooltip being localized is quite helpful for guiding potential translators
* '''MissingValveTranslationTooltip''' - {{MissingValveTranslationTooltip}} is displayed... same reason as above
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/Module:Dictionary/doc"