Template:Documentation subpage/doc

: {{Template link expanded|Documentation subpage}}

: or

: {{Template link expanded|Documentation subpage |[[{{var|Page where the documentation is transcluded}}]]}}

To set this template to use "userbox" and "userbox page" rather than "{{lc:{{ns:Template}}}}" and "{{lc:{{ns:Template}}}} page" or "{{lc:{{ns:User}}}} template" and "{{lc:{{ns:User}}}} template page", use:

: {{Template link expanded|Userbox documentation subpage}}

: or

: {{Template link expanded|Userbox documentation subpage |[[{{var|userbox page}}]]}}

The parameters {{para|text1}} and {{para|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:

{{Hidden begin |showhide=left |title=With text1 and text2}}

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

{{Documentation subpage |[page] |text1=text1 appears here |text2=text2 appears here |override={{lc:{{SUBPAGENAME}}}}}}

{{Hidden end}}

{{Hidden begin |showhide=left |title=With text2 only}}

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

{{Documentation subpage |[page] |text2=text2 appears here |override={{lc:{{SUBPAGENAME}}}}}}

{{Hidden end}}

{{Hidden begin |showhide=left |title=With text1 only}}

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

{{Documentation subpage |[page] |text1=text1 appears here |override={{lc:{{SUBPAGENAME}}}}}}

{{Hidden end}}

{{para|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.)

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 {{para|override}} to specify the doc subpage's name. For example, if the documentation were at "Template:Example/Documentation", use {{para|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 {{Template link|Documentation}}) will automatically note that the documentation is transcluded from a subpage.

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.

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

{{#switch:{{FULLPAGENAME}}

|Template:Userbox documentation subpage=

• {{Template link|Userbox/categories}}
• {{Template link|Userbox/citydoc}}}}
• {{Template link|Documentation/see also}}
• {{Template link|Documentation subpage}}
• {{Template link|Userspace disclaimers}}
• {{Template link|Userbox documentation subpage}}

{{Sandbox other||{{#switch:{{FULLPAGENAME}}

|Template:Documentation subpage =

|Template:Userbox documentation subpage = Δ

}}

Category:Documentation header templates

}}