Difference between revisions of "Template:Documentation subpage/doc"
From Captain of Industry Wiki
m |
(Removed unnecessary and broken categories transclusion) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{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". | ||
<includeonly> | <includeonly><!-- | ||
Add categories to the template itself below this line.--> | |||
[[Category:Template documentation]] | |||
</includeonly> | </includeonly> | ||
Latest revision as of 02:36, 1 May 2023
 | This is a template documentation subpage for Template:Documentation subpage. It contains usage information, categories, and other content that is not part of the original template page. |
Usage
{{Documentation subpage}}- or
{{Documentation subpage|[[Page where the documentation transcluded]]}}
Other parameters
inhibit=yeswill prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation) 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.
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".
