Template:Documentation subpage/doc: Difference between revisions

{{Short description|For use on the subpage itself}}

{{Documentation subpage}}

{{Distinguish|Template:Documentation}}

 

: {{Template link expanded|Documentation subpage}}

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

===Userbox documentation===

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:

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

<code><nowiki>{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}</nowiki></code>

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

<code><nowiki>{{Documentation subpage |text2='''''text2 appears here'''''}}</nowiki></code>

<code><nowiki>{{Documentation subpage |text1='''''text1 appears here'''''}}</nowiki></code>

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

** 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&nbsp;– i.e. pages transcluding the /doc page&nbsp;– the template will not show. The template page itself (which contains <code>{{Template link|Documentation}}</code>) will automatically note that the documentation is [[Help:Transclusion|transcluded]] from a subpage.

== Module documentation ==

This template is automatically shown on /doc subpages in the [[Wikipedia:Namespace|module namespace]]. This is done automatically via [[MediaWiki:Scribunto-doc-page-header]]. This [[MediaWiki talk:Scribunto-doc-page-header#Category:Module documentation pages|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 [[m:Help:Categories#Sort order|sort key]] to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

<includeonly>{{#switch:{{FULLPAGENAME}}

*{{Template link|Documentation/see also}}

*{{Template link|Userbox documentation subpage}}

<includeonly>{{Sandbox other||<!-- Make sure only the template page is categorised. No subpages, and not after transclusion. This /doc page is reused, btw.

|Template:Documentation subpage        = [[Category:Documentation templates| ]]

[[Category:Documentation header templates]]

}}</includeonly>