Template:Documentation subpage/doc: Difference between revisions

From BoyWiki
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
__NOTOC__
This template simply adds a notice to "/doc" pages that it is a documentarion subpage and adds the page to the documentation category. 
==Usage==
<nowiki>{{documentation subpage}}</nowiki>
'''OR'''
  <nowiki>{{documentation subpage|[[main page to link to]]|[[documentation to link to]]}}</nowiki>


This template should be placed at the top of "/doc" pages. It changes output depending on where it is viewed:
Usage
* On a "/doc" page, it displays a box explaining template documentation and links to the template page.
Type: &lt;noinclude> {{Tl|documentation subpage}}&lt;/noinclude> at the top of "/doc" 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 [[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'''
* [[Template documentation]] for how this template is used.
<includeonly>
<!-- categories and interwiki links -->
[[Category:Template documentation| {{PAGENAME}}]]
[[Category:General wiki templates]]


----


</includeonly>
* [[:Category:Template documentation]] for how this template is used.
<includeonly>

Latest revision as of 02:22, 22 December 2012

This template simply adds a notice to "/doc" pages that it is a documentarion subpage and adds the page to the documentation category.

Usage Type: <noinclude> {{documentation subpage}}</noinclude> at the top of "/doc" page.


See also