Template:Documentation subpage

From Wikipedia
Jump to: navigation, search

Lua error in package.lua at line 80: module 'Module:Arguments' not found.

Documentation icon Template documentation[view] [edit] [history] [[[:Template:Purge]]]

Usage[edit source]

{{documentation subpage}}

OR

Template:Tlx

Userboxes[edit source]

When used to document usage of a userbox, it may be preferred to have this template state "userbox"/"userbox page" instead of "template"/"template page" or "user template"/"user template page". If this is preferred, use:

{{userbox documentation subpage}}

OR

Template:Tlx

Customization of text[edit source]

To manually change the text of the template, the "text1=your text here" and/or "text2=your other text here" parameters can be specified. "text1=" changes the automatic text on the first line to your own word(s). "text2=" changes the automatic text on the second line to your own word(s). If "text1=" parameter is specified without the "text2=" parameter, both the first and second line of text will be custom based on the text given in the "text1=" parameter.

Example usage:

Template:Tlx
Template:Tlx
Template:Tlx

How it is displayed[edit source]

This template should 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 (ie, 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 the output message, the template categorizes 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 (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').

See also[edit source]

Template:Documentation/see also

Documentation icon Template documentation[view] [edit] [history] [[[:Template:Purge]]]