ᱪᱷᱟᱸᱪ:Documentation subpage/doc

Template:Documentation ᱥᱟᱶ ᱟᱠᱟᱵᱟᱠᱟ ᱨᱮ ᱟᱞᱚᱢ ᱧᱩᱨᱩᱜᱼᱟ ᱾

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

Usage

ᱪᱷᱟᱸᱪ:Template link expanded

or

ᱪᱷᱟᱸᱪ:Template link expanded

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "ᱪᱷᱟᱸᱪ" and "ᱪᱷᱟᱸᱪ page" or "ᱵᱮᱵᱷᱟᱨᱤᱭᱟᱹ template" and "ᱵᱮᱵᱷᱟᱨᱤᱭᱟᱹ template page", use:

ᱪᱷᱟᱸᱪ:Template link expanded

or

ᱪᱷᱟᱸᱪ:Template link expanded

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'''''}}

With text2 only

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

With text1 only

{{Documentation subpage |text1='''''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.
• 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".

See also

• {{Documentation/see also}}
• {{Documentation subpage}}
• {{Userspace disclaimers}}
• {{Userbox documentation subpage}}