Template:Documentation subpage/doc

From City of Hope MUSH
< Template:Documentation subpage
Revision as of 01:14, 8 June 2012 by imported>Roo (Created page with "<noinclude>{{pp-template}}{{documentation subpage}}</noinclude> __NOTOC__ ==Usage== <nowiki>{{documentation subpage}}</nowiki> '''OR''' <nowiki>{{documentation subpage|[[ma...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
This is a documentation subpage for Template:Documentation subpage (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

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 (ie, pages transcluding the "/doc" page), it notes that the documentation is transcluded from a subpage.

Functions

In addition to the output message, the template categorizes 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 (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').

See also

Template:Documentation/doc/see also