Template:Documentation subpage/doc: Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{template rating|p}} | |||
This template displays a message that the current page is a documentation subpage. | This template displays a message that the current page is a documentation subpage. | ||
| Line 17: | Line 19: | ||
== Functions == | == Functions == | ||
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". | 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". | ||
<includeonly> | |||
<!-- Categories below this line, please --> | |||
[[Category:Templates]] | |||
</includeonly> | |||
Revision as of 02:07, 6 September 2020
This template displays a message that the current page is a documentation subpage.
Usage
Text customization
The parameters |text1 and/or |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:
Other parameters
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.
- 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 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".