Template:TEMPLATENAME/doc
Appearance
This is a documentation subpage for Template:TEMPLATENAME. It may contain usage information, categories and other content that is not part of the original template page. |
When used on a template's /doc
subpage, {{TEMPLATENAME}} evaluates to the name of the associated template. The result will be accurate when the end page is either the /doc
subpage or the actual template page. The template makes a special case for the Template:
namespace: the Template:
prefix will be removed.
Note that the result will not be URL-safe. For a URL-encoded version, see {{TEMPLATENAMEE}}.
Parameters
[edit]|1=
(i.e. the first unnamed parameter) or|require=
- Sets the subpage from which the template extracts a name. If the parameter's value does not match the current subpage,[clarification needed] nothing will be returned. This is useful in preventing potentially endless recursive loops on some templates pages that might otherwise reference themselves.
|docpage=
or|override=
- Use to indicate the documentation page's location if it is other than the subpage
/doc
, e.g.{{TEMPLATENAME|docpage=Documentation}}
if the subpage is/Documentation
.
The following subpages will always be stripped:
- /doc
- /sandbox
- /testcases
See also
[edit]- {{TEMPLATENAMEE}}