Module:Dictionary/doc - Revision history

Mgpt at 21:03, 6 June 2026

2026-06-06T21:03:01Z

← Older revision		Revision as of 21:03, 6 June 2026
Line 3:		Line 3:

	== p.translate ==		== p.translate ==
	Translates a given key from [[Data:Dictionary]]. '''Manual invocation should only be used when additional parameters are required''', such as {{tl\|Update ~~link~~}}, where the DISPLAYTITLE is generated using a translation key with expected parameters.		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.

	For normal usage, use the basic template.		For normal usage, use the basic template.

Mgpt: /* p.translate */ clarify this part.

2026-06-06T21:01:28Z

p.translate: clarify this part.

← Older revision		Revision as of 21:01, 6 June 2026
Line 3:		Line 3:

	== p.translate ==		== p.translate ==
	Translates a given key from [[Data:Dictionary]]. '''Manual invocation should only be used ~~for special cases~~''', such as {{tl\|Update link}}. For normal usage, use the basic template.		Translates a given key from [[Data:Dictionary]]. '''Manual invocation should only be used when additional parameters are required''', such as {{tl\|Update link}}, where the DISPLAYTITLE is generated using a translation key with expected parameters.

			For normal usage, use the basic template.

	=== Function parameters ===		=== Function parameters ===

Mgpt: New version.

2026-06-06T02:57:05Z

New version.

@@ Line 1: / Line 1: @@
-=Overview=
+= Overview =
-See [[Template:Translate]] for how/when to use and more documentation.
+See {{tl|Translate}} for how/when to use and more documentation.
-=Functions=
+== p.translate ==
-==translate==
+Translates a given key from [[Data:Dictionary]]. '''Manual invocation should only be used for special cases''', such as {{tl|Update link}}. For normal usage, use the basic template.
-===Parameters===
+=== Function parameters ===
-*'''key''' - key to translate
+* '''key''' – translation key (required).
-*'''lang_code_override''' (OPTIONAL, Named parameter) - language code that overrides current language. See supported list at [[Data:LangCodes.json]].
+* Language-specific:
-*'''fallback_str''' (OPTIONAL, Named parameter) - string to return if '''key''' cannot be translated. Defaults to the english translation. Use a blank string or nil for easier catching of missed translations, where the needs translation tooltip will also not be added.
+** '''lang_code_override''' (optional, named parameter) – language code overriding the automatic detection. See [[Data:LangCodes.json]].
-*'''show_needs_translation''' (OPTIONAL, Named parameter) - boolean that determines if the {{NeedsTranslationTooltip}} is appended when its unable to be translated. Defaults to 'true'
+** '''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).
-===Example===
+=== Examples ===
-Example where translation does exist<br>
+<code><nowiki>{{#invoke:Dictionary|translate|Update history}}</nowiki></code> Output: {{#invoke:Dictionary|translate|Update history}}
-Outputs
+<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=en}}
+<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.}}
+<includeonly>[[Category:Modules]]</includeonly><noinclude>[[Category:Module documentation]]</noinclude>

Sur: /* Examples */ example updated for embedment

2024-10-16T01:21:57Z

Examples: example updated for embedment

← Older revision		Revision as of 01:21, 16 October 2024
Line 63:		Line 63:

	===Examples===		===Examples===

	Without embedment:		Without embedment:
	<code><nowiki>{{#invoke:Dictionary\|translate\|~~TranscludedNotesFrom~~}}</nowiki></code>		<code><nowiki>{{#invoke:Dictionary\|translate\|NeedsTranslationTooltip}}</nowiki></code>

	Outputs		Outputs

	{{#invoke:Dictionary\|translate\|~~TranscludedNotesFrom~~}}		{{#invoke:Dictionary\|translate\|NeedsTranslationTooltip}}

	With embedment:		With embedment:
	<pre>{{#invoke:Dictionary\|translate_embed		<pre>{{#invoke:Dictionary\|translate_embed
	\|1=~~TranscludedNotesFrom~~		\|1=NeedsTranslationTooltip
	\|2=~~https~~:~~//en.wikipedia.org/wiki/Help:Transclusion~~		\|2=Template:Translate
	~~\|3=[[Source_Page/notes]]~~
	~~\|4=https://deadlocked.wiki/index.php?title=Source_Page/notes&action=edit~~
	}}</pre>		}}</pre>

Line 81:		Line 80:

	{{#invoke:Dictionary\|translate_embed		{{#invoke:Dictionary\|translate_embed
	\|1=~~TranscludedNotesFrom~~		\|1=NeedsTranslationTooltip
	\|2=~~https~~:~~//en.wikipedia.org/wiki/Help:Transclusion~~		\|2=Template:Translate
	~~\|3=[[Source_Page/notes]]~~
	~~\|4=https://deadlocked.wiki/index.php?title=Source_Page/notes&action=edit~~
	}}		}}

Sur: guide to Data:Dictionary/sources

2024-10-15T03:46:50Z

guide to Data:Dictionary/sources

← Older revision		Revision as of 03:46, 15 October 2024
Line 1:		Line 1:
	=Overview=		=Overview=
	See [[Template:Translate]] for how/when to use and more documentation.		See [[Template:Translate]] for how/when to use and more documentation.
			See [[Data:Dictionary/sources]] for list of where each translation is used. This may be particularly helpful for reading on the context of the phrase that needs translation.

	=Functions=		=Functions=

Sur: moving important translations list to Template:Translate

2024-10-14T20:14:50Z

moving important translations list to Template:Translate

← Older revision		Revision as of 20:14, 14 October 2024
Line 89:		Line 89:
	* 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.		* 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.		* 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 and whose existence is relied on by other pages:~~
	* '''Notes''' - for <code><nowiki>[[<ability_name>/Notes]]</nowiki></code> being transcluded to [[Abrams#Abilities]]
	*

	~~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

Sur: examples with fallback_str being blank

2024-10-13T04:01:06Z

examples with fallback_str being blank

← Older revision		Revision as of 04:01, 13 October 2024
Line 9:		Line 9:
	*'''key''' - key to translate		*'''key''' - key to translate
	*'''lang_code_override''' (OPTIONAL, Named parameter) - language code that overrides current language. See supported list at [[Data:LangCodes.json]].		*'''lang_code_override''' (OPTIONAL, Named parameter) - language code that overrides current language. See supported list at [[Data:LangCodes.json]].
			*'''fallback_str''' (OPTIONAL, Named parameter) - string to return if '''key''' cannot be translated. Defaults to the english translation. Use a blank string or nil for easier catching of missed translations, where the needs translation tooltip will also not be added.
	*'''show_needs_translation''' (OPTIONAL, Named parameter) - boolean that determines if the {{NeedsTranslationTooltip}} is appended when its unable to be translated. Defaults to 'true'		*'''show_needs_translation''' (OPTIONAL, Named parameter) - boolean that determines if the {{NeedsTranslationTooltip}} is appended when its unable to be translated. Defaults to 'true'

Line 29:		Line 30:

	Example where translation does not yet exist but displaying the tooltip is off<br>		Example where translation does not yet exist but displaying the tooltip is off<br>
	<code><nowiki>{{#invoke:Dictionary\|translate\|Update history\|show_needs_translation=false}}</nowiki></code>		<code><nowiki>{{#invoke:Dictionary\|translate\|Update history\|lang_code_override=es\|show_needs_translation=false}}</nowiki></code>

	Outputs		Outputs

	{{#invoke:Dictionary\|translate\|Update history\|show_needs_translation=false}}		{{#invoke:Dictionary\|translate\|Update history\|lang_code_override=es\|show_needs_translation=false}}

			Example where translation does not yet exist and the fallback is an empty string<br>
			<code><nowiki>{{#invoke:Dictionary\|translate\|Update history\|lang_code_override=es\|fallback_str=}}</nowiki></code>

			Outputs

			{{#invoke:Dictionary\|translate\|Update history\|lang_code_override=es\|fallback_str=}}


			Example where translation does not yet exist and the fallback is another text<br>
			<code><nowiki>{{#invoke:Dictionary\|translate\|Update history\|lang_code_override=es\|fallback_str=My custom fallback text}}</nowiki></code>

			Outputs

			{{#invoke:Dictionary\|translate\|Update history\|lang_code_override=es\|fallback_str=My custom fallback text}}

	==translate_embed==		==translate_embed==

Sur: now includes show_needs_translation and better examples

2024-10-13T03:23:10Z

now includes show_needs_translation and better examples

@@ Line 9: / Line 9: @@
 *'''key''' - key to translate
 *'''lang_code_override''' (OPTIONAL, Named parameter) - language code that overrides current language. See supported list at [[Data:LangCodes.json]].
 ===Example===
 <code><nowiki>{{#invoke:Dictionary|translate|Update history|lang_code_override=es}}</nowiki></code>
@@ Line 16: / Line 26: @@
 {{#invoke:Dictionary|translate|Update history|lang_code_override=es}}
 ==translate_embed==

Sur: /* Important translations */ phrasing

2024-10-13T03:13:08Z

Important translations: phrasing

← Older revision		Revision as of 03:13, 13 October 2024
Line 60:		Line 60:
	<i>Note: these are not yet important, as most translations are only used for in-development pages right now.<br></i>		<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:		Page/subpage names that can't exist without translation and whose existence is relied on by other pages:
	* '''Notes''' - for <code><nowiki>[[<ability_name>/Notes]]</nowiki></code>		* '''Notes''' - for <code><nowiki>[[<ability_name>/Notes]]</nowiki></code> being transcluded to [[Abrams#Abilities]]
	*		*

Sur: Important translations

2024-10-13T03:10:58Z

Important translations

← Older revision		Revision as of 03:10, 13 October 2024
Line 55:		Line 55:
	* 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.		* 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.		* 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