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

From blackwiki
Jump to navigation Jump to search
test>ConradPino
(__NOTOC__)
test>ConradPino
(→‎Usage: improve Usage layout)
Line 2: Line 2:
 
__NOTOC__
 
__NOTOC__
 
==Usage==
 
==Usage==
<pre>
+
<nowiki>{{documentation subpage}}</nowiki>
{{documentation subpage}}
+
'''OR'''
or: {{documentation subpage|[[main page to link to]]|[[documentation to link to]]}}
+
  <nowiki>{{documentation subpage|[[main page to link to]]|[[documentation to link to]]}}</nowiki>
</pre>
+
 
 
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.

Revision as of 00:46, 13 November 2007

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 Documentation subpages 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: