View source for Template:Translatable template/doc

<noinclude>{{Documentation subpage}}</noinclude>
{{Shortcut|Template:TNT|Template:tnt}}

== Purpose ==
This template is used to show translatable templates in the language of the current page. Templates, like all other MediaWiki pages, can be translated using the [[mw:Extension:Translate|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 ==
* <code><nowiki>{{Translatable template|</nowiki>''name of template''<nowiki>|</nowiki>''parameters....''<nowiki>}}</nowiki></tt>
* <code><nowiki>{{TNT|</nowiki>''name of template''<nowiki>|</nowiki>''parameters....<nowiki>}}</nowiki></tt>
* <code><nowiki>{{tnt|</nowiki>''name of template''<nowiki>|</nowiki>''parameters....<nowiki>}}</nowiki></tt>

The above simplied syntax cannot work if the named template also needs to be transcluded in other translatable templates, because it would cause self-recursion of {{tl|Translatable template}}. An alternative is to use {{tl|Translatable template name}} which does not expand the template with its parameters, but only returns the resolved template name, which can then be
transcluded normally:
* <code><nowiki>{{{{Translatable template name|</nowiki>''name of template''<nowiki>}}|</nowiki>''parameters....''<nowiki>}}</nowiki></tt>
* <code><nowiki>{{{{TNTN|</nowiki>''name of template''<nowiki>}}|</nowiki>''parameters....<nowiki>}}</nowiki></tt>
* <code><nowiki>{{{{tntn|</nowiki>''name of template''<nowiki>}}|</nowiki>''parameters....<nowiki>}}</nowiki></tt>

Example (from [[Help:Extension:Translate]]):

:<code><nowiki>{{Translatable template|Extension-Translate}}</nowiki></code> or <code><nowiki>{{TNT|Extension-Translate}}</nowiki></code>
which includes translated versions of {{tl|Extension-Translate}} 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 (with the exception of 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:
* <code><nowiki>{{Translatable template|namespace=</nowiki>'':somename:''<nowiki>|</nowiki>''page name''<nowiki>|</nowiki>''parameters....''<nowiki>}}</nowiki></tt>
* <code><nowiki>{{TNT|namespace=</nowiki>'':somename:''<nowiki>|</nowiki>''page name''<nowiki>|</nowiki>''parameters....<nowiki>}}</nowiki></tt>
* <code><nowiki>{{tnt|namespace=</nowiki>'':somename:''<nowiki>|</nowiki>''page name''<nowiki>|</nowiki>''parameters....<nowiki>}}</nowiki></tt>
This <code>namespace</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 [[meta:Global sysops]]):
* <code><nowiki>{{TNT|Special global permissions/Seealso|Global sysops}}</nowiki></code>
where the second parameter "Global sysops" is the value of the first numbered parameter transferred into called page "Special global permissions/Seealso".

== Dependency ==
* [[Module:Template translation]] (standard version)
* [[meta:Module:Template translation/sandbox]] (used when this template is called with optional dummy parameter <code>sandbox=/sandbox</code>, for testng only)

== See also ==
* {{tl|Translatable template name}}, alias {{tl|TNTN}} or {{tl|tntn}}
* {{tl|Localized link}}, alias {{tl|ll}}

{{Languages}}
<includeonly>
<!-- PUT HERE THE CATEGORIES OF THE TEMPLATE -->
[[Category:Navigation templates|* {{PAGENAME}}]]
[[Category:Internationalization templates|{{PAGENAME}}]]
[[Category:Lua-based templates]]
</includeonly>