More actions
Created page with "{{tsh|doc sub}} {{Documentation subpage}} {{Distinguish|Template:Documentation}} This template displays a message that the current page is a documentation subpage. == Usage == : {{Template link expanded|Documentation subpage}} : or : {{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 tha..." |
No edit summary |
||
| Line 21: | Line 21: | ||
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}} | {{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}} | ||
{{Hidden end}} | {{Hidden end}} | ||
{{Hidden begin |showhide=left |title=With ''text2'' only}} | |||
<code><nowiki>{{Documentation subpage |text2='''''text2 appears here'''''}}</nowiki></code> | |||
{{Documentation subpage |[''page''] |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}} | |||
{{Hidden end}} | |||
{{Hidden begin |showhide=left |title=With ''text1'' only}} | |||
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here'''''}}</nowiki></code> | |||
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}} | |||
{{Hidden end}} | |||
===Other parameters=== | |||
{{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.) | |||
== 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 {{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 <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". | |||
== See also == | |||
<includeonly>{{#switch:{{FULLPAGENAME}} | |||
|Template:Userbox documentation subpage= | |||
*{{Template link|Userbox/categories}} | |||
*{{Template link|Userbox/citydoc}}}}</includeonly> | |||
*{{Template link|Documentation/see also}} | |||
*{{Template link|Documentation subpage}} | |||
*{{Template link|Userspace disclaimers}} | |||
*{{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. | |||
-->{{#switch:{{FULLPAGENAME}} | |||
|Template:Documentation subpage = [[Category:Documentation templates| ]] | |||
|Template:Userbox documentation subpage = [[Category:Documentation templates| ]][[Category:Userboxes|Δ]] | |||
}} | |||
[[Category:Documentation header templates]] | |||
}}</includeonly> | |||