Template:Translatable template name/doc: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | <noinclude>{{Documentation subpage}}</noinclude> | ||
== Purpose == | == Purpose == | ||
This template is used to return the name of translatable templates in the language of the current page. Templates, like all other MediaWiki pages, can be translated using the | This template is used to return the name of translatable templates in the language of the current page. Templates, like all other MediaWiki pages, can be translated using the [[mw:Extension:Translate]] extension, which creates subpages with the form "pagename/language code". The template first checks if the name of the page contains a language code. If it does, it then checks if the template name given as a first parameter has a translation in that language. If the page name does not contain a language code, or if the navigation template doesn't exist in that language, it will display the English template. | ||
== How to use == | == How to use == | ||
| Line 12: | Line 9: | ||
* <code><nowiki>{{ {{tntn|</nowiki>''name of navigation template''<nowiki>}}|</nowiki>''parameters....<nowiki>}}</nowiki></code> | * <code><nowiki>{{ {{tntn|</nowiki>''name of navigation template''<nowiki>}}|</nowiki>''parameters....<nowiki>}}</nowiki></code> | ||
Example (from translatable [[ | Example (from translatable [[m:Template:Meta]], used in translatable page [[m:Meta:About]]): | ||
: <code><nowiki>{{Translatable template name|Navbar}}</nowiki></code> or <code><nowiki>{{TNTN|Navbar}}</nowiki></code> | : <code><nowiki>{{Translatable template name|Navbar}}</nowiki></code> or <code><nowiki>{{TNTN|Navbar}}</nowiki></code> | ||
| Line 26: | Line 23: | ||
This <code>tntns</code> will be used to specify another namespace from which the translatable pagename will be transcluded, instead of referencing the page name from the default <code>:Template:</code> namespace. Note that this parameter is also passed (without modification) within the parameters of the transclusion. | This <code>tntns</code> will be used to specify another namespace from which the translatable pagename will be transcluded, instead of referencing the page name from the default <code>:Template:</code> namespace. Note that this parameter is also passed (without modification) within the parameters of the transclusion. | ||
Example with one parameters (from [[ | Example with one parameters (from [[m:Meta:About]] which is translatable): | ||
* <code><nowiki>{{ {{TNTN|Navbar}} |Meta:About}}</nowiki></code> | * <code><nowiki>{{ {{TNTN|Navbar}} |Meta:About}}</nowiki></code> | ||
== Dependency == | == Dependency == | ||
* [[Module:Template translation]] (standard version) | * [[Module:Template translation]] (standard version) | ||
* [[ | * [[m:Module:Template translation/sandbox]] (used when this template is called with optional parameter <code>sandbox=/sandbox</code>, for testing modifications only) | ||
<includeonly> | <includeonly> | ||
Latest revision as of 07:09, 15 February 2022
 | This is a documentation subpage for Template:Translatable template name. It contains usage information, categories and other content that is not part of the original Template page. |
Purpose
This template is used to return the name of translatable templates in the language of the current page. Templates, like all other MediaWiki pages, can be translated using the mw:Extension:Translate extension, which creates subpages with the form "pagename/language code". The template first checks if the name of the page contains a language code. If it does, it then checks if the template name given as a first parameter has a translation in that language. If the page name does not contain a language code, or if the navigation template doesn't exist in that language, it will display the English template.
How to use
{{ {{Translatable template name|name of navigation template}}|parameters....}}{{ {{TNTN|name of navigation template}}|parameters....}}{{ {{tntn|name of navigation template}}|parameters....}}
Example (from translatable m:Template:Meta, used in translatable page m:Meta:About):
{{Translatable template name|Navbar}}or{{TNTN|Navbar}}
which returns the translated versions of {{Navbar}} if it exists, or the English version if translations don't exist.
Parameters
The current version of the template may now include any kind of named or numbered parameters, whose values will be transferred into the called template (except for parameter 1 containing the basename of the translatable template to transclude). Numbered parameters will be shifted down by one position, all named parameters will be passed unchanged.
One named parameter is treated specially:
{{Translatable template name|tntns=:somename:|page name}}{{TNTN|tntns=:somename:|page name}}{{tntn|tntns=:somename:|page name}}
This tntns will be used to specify another namespace from which the translatable pagename will be transcluded, instead of referencing the page name from the default :Template: namespace. Note that this parameter is also passed (without modification) within the parameters of the transclusion.
Example with one parameters (from m:Meta:About which is translatable):
{{ {{TNTN|Navbar}} |Meta:About}}
Dependency
- Module:Template translation (standard version)
- m:Module:Template translation/sandbox (used when this template is called with optional parameter
sandbox=/sandbox, for testing modifications only)