Shawndouglas: Created as needed.

2014-11-22T17:30:27Z

Created as needed.

New page

{{Documentation subpage}}


When used on a template's <code>/doc</code> subpage, {{tl|{{TEMPLATENAMEE}}}} evaluates to the name of the associated template. The result will be accurate when the end page is either the <code>/doc</code> subpage or the actual template page. The template makes a special case for the <code>{{ns:Template}}:</code> namespace: the <code>{{ns:Template}}:</code> prefix will be removed.

Note that the result will be wiki-URL-encoded. For a version suitable for display, see {{tl|TEMPLATENAME}}.

== Usage ==

The template takes one parameter: <code>override</code>. Normally, this template detects whether the end page is a documentation page by looking for the presence of a <code>/doc</code> subpage. If the documentation page is under a different name—for example, in a different language—then the proper subpage name should be passed to <code>override</code>. For example, if the documentation subpage were named <code>Documentation</code>:

<nowiki>{{</nowiki>{{TEMPLATENAME}}|override=Documentation<nowiki>}}</nowiki>

The following subpages will always be removed:
* /doc
* /sandbox
* /testcases

The '''<nowiki>{{{require}}}</nowiki>''' parameter can be set to a target subpage on which the template should function. If the current subpage does not match '''<nowiki>{{{require}}}</nowiki>''' and the argument is not omitted, the template will evaluate to nothing. This is useful to prevent recursive loops on some templates pages that might otherwise reference themselves.

== See also ==

* {{tl|TEMPLATENAME}}

<includeonly>

{{DEFAULTSORT:Templatenamee}}
[[{{ns:Category}}:Template documentation]]

</includeonly>

Template:TEMPLATENAMEE/doc - Revision history

Shawndouglas: Created as needed.