Template:Translate/doc - Revision history

Mgpt: rewrite documentation for clarity

2026-06-06T20:45:56Z

rewrite documentation for clarity

← Older revision		Revision as of 20:45, 6 June 2026
Line 1:		Line 1:
	~~''Note:~~ [[~~Template~~:~~NeedsTranslationTooltip~~]] ~~directs~~ to ~~this page~~.''		= Overview =
			Navigate to [[Data:Dictionary]] to add or update keys, or create a new key if one does not already exist.

	~~=How to help translate=~~		For additional context about where a key is used, see [[Data:Dictionary/sources]].
	~~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~~

	~~<pre>~~		== Tooltip notes ==
	~~"Patch notes":~~ {		* '''{{tl\|NeedsTranslationTooltip}}''' {{NeedsTranslationTooltip}} - displayed when the key is not translated.
	~~"en": "Patch notes",~~		* '''{{tl\|MissingValveTranslationTooltip}}''' {{MissingValveTranslationTooltip}} (manual) - displayed in cases where an official translation is expected but unavailable.
	~~"ru": "Содержание обновления"~~
	}
	~~</pre>~~

	to		== Usage ==
			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.

	~~<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.
	~~"Patch notes": {~~
	~~"en": "Patch notes"~~,
	~~"ru": "Содержание обновления",~~
	~~"es": "Notas de revision"~~
	}
	~~</pre>~~

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

	~~To read the surrounding context, check for the entry on at [[Data~~:~~Dictionary/sources]] to see where each key is used.~~		<code><nowiki>{{Translate\|Patch notes}}</nowiki></code> Output: {{Translate\|Patch notes}}

	~~=Important translations=~~		<code><nowiki>{{Translate\|Patch notes\|lang_code=ru}}</nowiki></code> Output: {{Translate\|Patch notes\|lang_code=ru}}
	<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:~~		<templatedata>
	* '''Notes''' - for <code><nowiki>[[<ability_name>/Notes]]</nowiki></code> being transcluded to [[Abrams#Abilities]] and <nowiki>[[<ability_name>]]</nowiki>. Notes page can't be created by Deadbot until translated, transcluding the english Notes in its place.		{
	*		"description": " ",
			"params": {
	~~Other:~~		"1": {
	* '''NeedsTranslationTooltip''' - {{NeedsTranslationTooltip}} is displayed when something can't be localized, so the tooltip being localized is quite helpful for guiding potential translators		"label": "Dictionary key",
	* '''MissingValveTranslationTooltip''' - {{MissingValveTranslationTooltip}} is displayed... same reason as above		"description": "The key that corresponds to the text to be translated.",
			"type": "string",
	~~=When to use=~~		"required": true,
	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		"example": "Patch notes"
			},
	~~=Returned string has weird characters=~~		"lang_code": {
	If [[Template:Translate]] returns a string that has <code>%s</code> in it, it means it is expecting a parameter passed to be embedded in its place. Use [[Module:Dictionary]]'s <code>translate_embed</code> function instead for this case. The linked page includes documentation for how to use it.		"label": "Language code",
			"description": "Optional language code to override the language. See Data:LangCodes.json.",
	~~=Example=~~		"example": "es, cs, pt-br",
	~~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.~~		"type": "string"
	~~<pre style="width: fit-content">{{Translate\|Patch notes}}</pre>~~		}
			},
	~~Outputs~~		"paramOrder": [
			"1",
	~~{{Translate\|Patch notes}}~~		"lang_code"
			],
			"format": "inline"
	~~<pre style="width: fit-content">{{Translate\|Patch notes\|ru}}</pre~~>

	~~Outputs~~

	~~{{Translate\|Patch notes\|ru}}~~


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

	~~<pre style="width: fit-content">{{Translate\|Patch notes\|made-up-code}}</pre>~~

	~~Outputs~~

	~~{{Translate\|Patch notes\|made-up-code}}~~

	~~=Lua=~~
	~~This template simply forwards parameters to the Lua function <code>translate</code> from [[Module:Dictionary]]. If familiar with Lua invokes, try using it or <code>translate_embed</code> instead.~~

	~~=Parameters=~~

	~~<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 language code to override the language ~~(e.g., 'en', 'es'), if page ends in /<lang_code> it defaults to that lang code~~. See ~~accepted language codes at [[~~Data:LangCodes.json]]",
	"type": "string",
	"~~required~~": ~~false,~~
	"~~example~~": "es",
	"~~default~~": ""
	}
	}
	}</templatedata>		}</templatedata>
			<includeonly>[[Category:Language templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

Gammaton32 at 14:40, 5 May 2025

2025-05-05T14:40:37Z

← Older revision		Revision as of 14:40, 5 May 2025
Line 1:		Line 1:
			''Note: [[Template:NeedsTranslationTooltip]] directs to this page.''

	=How to help translate=		=How to help translate=
	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		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

Sur: point to Data:Dictionary/sources

2024-10-15T03:48:15Z

point to Data:Dictionary/sources

← Older revision		Revision as of 03:48, 15 October 2024
Line 21:		Line 21:

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

			To read the surrounding context, check for the entry on at [[Data:Dictionary/sources]] to see where each key is used.

	=Important translations=		=Important translations=

Sur: Important translates list ported from Module:Dictionary/doc

2024-10-14T20:17:44Z

Important translates list ported from Module:Dictionary/doc

← Older revision		Revision as of 20:17, 14 October 2024
Line 21:		Line 21:

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

			=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]] and <nowiki>[[<ability_name>]]</nowiki>. Notes page can't be created by Deadbot until translated, transcluding the english Notes in its place.
			*

			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

	=When to use=		=When to use=

Sur: link to module:dictionary if seeing %s in the string

2024-10-12T22:23:57Z

link to module:dictionary if seeing %s in the string

← Older revision		Revision as of 22:23, 12 October 2024
Line 24:		Line 24:
	=When to use=		=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		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

			=Returned string has weird characters=
			If [[Template:Translate]] returns a string that has <code>%s</code> in it, it means it is expecting a parameter passed to be embedded in its place. Use [[Module:Dictionary]]'s <code>translate_embed</code> function instead for this case. The linked page includes documentation for how to use it.

	=Example=		=Example=

Sur: fixed link to langcodes.json

2024-10-12T22:08:54Z

fixed link to langcodes.json

← Older revision		Revision as of 22:08, 12 October 2024
Line 66:		Line 66:
	"2": {		"2": {
	"label": "lang_override",		"label": "lang_override",
	"description": "Optional language code to override the language (e.g., 'en', 'es'), if page ends in /<lang_code> it defaults to that lang code. See accepted language codes at [[Data:LangCodes]]",		"description": "Optional language code to override the language (e.g., 'en', 'es'), if page ends in /<lang_code> it defaults to that lang code. See accepted language codes at [[Data:LangCodes.json]]",
	"type": "string",		"type": "string",
	"required": false,		"required": false,

Sur: /* Parameters */ lang code no longer needs to be 2 letters, instead refer to Data:LangCodes page

2024-10-12T21:53:26Z

Parameters: lang code no longer needs to be 2 letters, instead refer to Data:LangCodes page

← Older revision		Revision as of 21:53, 12 October 2024
Line 66:		Line 66:
	"2": {		"2": {
	"label": "lang_override",		"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.",		"description": "Optional language code to override the language (e.g., 'en', 'es'), if page ends in /<lang_code> it defaults to that lang code. See accepted language codes at [[Data:LangCodes]]",
	"type": "string",		"type": "string",
	"required": false,		"required": false,

Sur: /* Lua */ typo, module name is Dictionary

2024-10-12T21:51:51Z

Lua: typo, module name is Dictionary

← Older revision		Revision as of 21:51, 12 October 2024
Line 50:		Line 50:

	=Lua=		=Lua=
	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.		This template simply forwards parameters to the Lua function <code>translate</code> from [[Module:Dictionary]]. If familiar with Lua invokes, try using it or <code>translate_embed</code> instead.

	=Parameters=		=Parameters=

Sur: link to lua module

2024-10-12T21:51:26Z

link to lua module

← Older revision		Revision as of 21:51, 12 October 2024
Line 48:		Line 48:

	{{Translate\|Patch notes\|made-up-code}}		{{Translate\|Patch notes\|made-up-code}}

			=Lua=
			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.

	=Parameters=		=Parameters=

Sur: /* Example */ updated example as sometimes it doesnt default to english now

2024-10-10T19:52:53Z

Example: updated example as sometimes it doesnt default to english now

← Older revision		Revision as of 19:52, 10 October 2024
Line 41:		Line 41:


	If translation to that language does not yet exist, it will default to the english translation, ~~and~~ add <code><nowiki>{{NeedsTranslationTooltip}}</nowiki></code> at the end to guide users to help translate it.		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}}.

	<pre style="width: fit-content">{{Translate\|Patch notes\|zh}}</pre>		<pre style="width: fit-content">{{Translate\|Patch notes\|made-up-code}}</pre>

	Outputs		Outputs

	{{Translate\|Patch notes\|zh}}		{{Translate\|Patch notes\|made-up-code}}

	=Parameters=		=Parameters=