Template:Documentation subpage

Template documentation (for the above template, sometimes hidden or invisible)

Usage

Template:Tlx

or

Template:Tlx

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

Template:Tlx

or

Template:Tlx

Text customization

The parameters |text1= and/or |text2= can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1:

With text1 and text2

{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}} Template:Mbox

With text2 only

{{Documentation subpage |text2='''''text2 appears here'''''}} Template:Mbox

With text1 only

{{Documentation subpage |text1='''''text1 appears here'''''}} Template:Mbox

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

• On a /doc page, it displays a box explaining template documentation and links to the template page.
• On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains {{Documentation}}) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also

The above text is transcluded from Template:Documentation subpage/doc; you can change it or view its history. (How does this work?)
If you're done making changes, please refresh the text. (Why?)
You can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories and interwikis to Template:Documentation subpage/doc. (View all subpages of this page.)