Template:Documentation subpage/doc

From PortlandWiki
Revision as of 18:35, 15 March 2012 by WikiMaster (talk | contribs) (Create template.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This documentation subpage contains instructions, categories, or other information for technical reasons.
To view the Template page itself, see Template:Documentation subpage.

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. 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