Template:Documentation subpage/doc: Difference between revisions

From BoyWiki
(New page: {{documentation subpage}} __NOTOC__ ==Usage== <nowiki>{{documentation subpage}}</nowiki> '''OR''' <nowiki>{{documentation subpage|main page to link to|documentation to link to}}...)
 
No edit summary
Line 19: Line 19:
<!-- categories and interwiki links -->
<!-- categories and interwiki links -->
[[Category:Template documentation| {{PAGENAME}}]]
[[Category:Template documentation| {{PAGENAME}}]]
[[Category:Template namespace templates]]
[[Category:Template namespace templates]]
[[Category:General wiki templates]]


[[ar:قالب:صفحة توثيق فرعية]]
[[bg:Шаблон:Подстраница с документация]]
[[es:Plantilla:Subpágina documentación de plantilla]]
[[is:Snið:Skjalsíða]]
[[ja:template:Documentation subpage]]
[[mk:Шаблон:Документација потстрана]]
[[pl:Szablon:Podstrona dokumentacji]]
[[sl:template:Dokumentacijska podstran]]
[[sq:Stampa:Documentation subpage]]
[[uk:Шаблон:Підсторінка документації]]


</includeonly>
</includeonly>

Revision as of 12:19, 12 December 2012


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