Template:Translatable template/Documentation

See https://www.mediawiki.org/w/index.php?title=Template:Translatable_template&oldid=868147.

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 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 of template|parameters...}}
• {{TNT|name of template|parameters...}}
• {{tnt|name of template|parameters...}}

The above simplified syntax cannot work if the named template also needs to be transcluded in other translatable templates, because it would cause self-recursion. An alternative is to use 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:

• {{ {{Translatable template name|name of template}} |parameters....}}
• {{ {{TNTN|name of template}} |parameters....}}
• {{ {{tntn|name of template}} |parameters....}}

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.

Dependency

• Module:Template translation (standard version)
• m:Module:Template translation/sandbox (used when this template is called with optional dummy parameter sandbox=/sandbox, for testing only