Template:Documentation subpage/Wikipedia/doc

From Templates Wiki
Jump to navigation Jump to search

Template:Mbox

Usage[edit source]

Template:Tlx
or
Template:Tlx

Userbox documentation[edit source]

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[edit source]

The parameters | and/or | 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: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}

Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}}

This documentation subpage contains instructions, categories, or other information that is not part of the template. To view the Template page itself, see Template:Documentation subpage/Wikipedia.

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

Display[edit source]

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[edit source]

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[edit source]

Template:Documentation/see also