Difference between revisions of "Template:Documentation subpage/doc"

From blackwiki
Jump to navigation Jump to search
test>Patrick
(→‎Functions: categorizes pages to Category:Template documentation, or similar, but only for documentation pages in namespaces with the subpage feature,)
Line 11: Line 11:
  
 
==Functions==
 
==Functions==
In addition to the output message, the template categorizes pages to [[:Category:Documentation subpages|Documentation subpages]] and defaults the [[m:Help:Categories#Sort order|sort key]] to the page name without namespace (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').  
+
In addition to the output message, the template categorizes pages to [[:Category:Template documentation]], or similar, but only for documentation pages in namespaces with the subpage feature, and defaults the [[m:Help:Categories#Sort order|sort key]] to the page name without namespace (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').
  
 
==See also==
 
==See also==

Revision as of 16:16, 18 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 (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, or similar, but only for documentation pages in namespaces with the subpage feature, and 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

General information about documentation for templates:

{{Documentation}} family:

Meta-Wiki {{Documentation}} ancestor: