Template:Documentation subpage/doc: Difference between revisions
Template page
More actions
sort |
override note + m |
||
| Line 8: | Line 8: | ||
This template should be placed at the top of "/doc" pages. It changes output depending on where it is viewed: | This template should 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 a "/doc" page, it displays a box explaining template documentation and links to the template page. | ||
* On other pages ( | * On other pages (i.e. pages transcluding the "/doc" page), it notes that the documentation is transcluded from a subpage. | ||
* For documentation pages that are not called "/doc" use <nowiki>{{</nowiki>documentation subpage|override=''subpage name''}} | |||
==Functions== | ==Functions== | ||
In addition to the output message, the template categorizes pages to [[:Category: | In addition to the output message, the template categorizes pages to [[:Category:Template documentation]] and defaults the [[m:Help:Categories#Sort order|sort key]] to the page name without namespace (i.e. "Foo" on "Template:Foo", so it would be sorted in categories under 'F'). | ||
==See also== | ==See also== | ||
Revision as of 03:28, 22 March 2008
Usage
{{documentation subpage}}
or: {{documentation subpage|[[main page to link to]]|[[documentation to link to]]}}
This template should 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), it notes that the documentation is transcluded from a subpage.
- For documentation pages that are not called "/doc" use {{documentation subpage|override=subpage name}}
Functions
In addition to the output message, the template categorizes pages to Category:Template documentation and defaults the sort key to the page name without namespace (i.e. "Foo" on "Template:Foo", so it would be sorted in categories under 'F').
See also
- m:Template:Documentation or en:Wikipedia:Template documentation for how this template is used.