Template:Userbox documentation subpage

Template documentation[view] [edit] [history] [purge]

For use on the subpage itself

Shortcut

{{doc subTemplate:Doc sub}}

Not to be confused with Template:Documentation.

This template displays a message that the current page is a documentation subpage.

1 Usage
2 Display
3 Module documentation
4 Automatic categorization
5 See also

Usage

{{Documentation subpage}}

{{Documentation subpage|[[Page where the documentation is transcluded]]}}

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:

{{Userbox documentation subpage}}

{{Userbox documentation subpage|[[userbox page]]}}

Text customization

The parameters |text1= and |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'''''}}

This is a documentation subpage for [page] .
It may contain usage information, categories and other content that is not part of the original text2 appears here.

With text2 only

{{Documentation subpage |text2='''''text2 appears here'''''}}

This is a documentation subpage for [page] .
It may contain usage information, categories and other content that is not part of the original text2 appears here.

With text1 only

{{Documentation subpage |text1='''''text1 appears here'''''}}

This is a documentation subpage for [page] .
It may contain usage information, categories and other content that is not part of the original text1 appears here.

Other parameters

|inhibit=yes will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

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.
- As a workaround if the documentation page's name doesn't end with '/doc', use |override= to specify the doc subpage's name. For example, if the documentation were at "Template:Example/Documentation", use |override=documentation (must be lower-case to work)
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.

Module documentation

This template is automatically shown on /doc subpages in the module namespace. This is done automatically via MediaWiki:Scribunto-doc-page-header. This fails to add the doc page to Category:Module documentation pages so some module doc pages transclude the template manually or add the category directly to fix this.

Automatic categorization

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".