Difference between revisions of "Template:Documentation subpage/doc"

From Captain of Industry Wiki
Jump to: navigation, search
(Creation)
 
(Removed unnecessary and broken categories transclusion)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}<!--
This template displays a message that the current page is a documentation subpage.
Add categories to the template itself where indicated at the bottom of this page.-->


== Usage ==
== Usage ==
Line 18: Line 18:
In addition to its message, the template adds pages to [[:Category:Template documentation]], [[:Category:User documentation]], or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the [[MediaWikiWiki:Help:Categories#Sort key|sort key]] to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".
In addition to its message, the template adds pages to [[:Category:Template documentation]], [[:Category:User documentation]], or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the [[MediaWikiWiki:Help:Categories#Sort key|sort key]] to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".


== See also ==
<includeonly><!--
<includeonly>{{#switch:{{FULLPAGENAME}}
Add categories to the template itself below this line.-->
|Template:Userbox documentation subpage=
[[Category:Template documentation]]
*{{:Documentation}}
 
<includeonly>{{#switch:{{FULLPAGENAME}}
|Template:Documentation subpage        = [[Category:Template documentation| ]]
|Template:Userbox documentation subpage = [[Category:Template documentation| ]][[Category:Userboxes|Δ]]
}}
[[Category:Documentation header templates]]
</includeonly>
</includeonly>

Latest revision as of 02:36, 1 May 2023

Usage

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

Other parameters

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.

Functions

In addition to its message, the template adds pages to Category:Template documentation, Category:User documentation, 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".