Template:Documentation subpage

From AEWiki: The Unofficial Aethelmearc Wiki
Revision as of 03:47, 4 February 2023 by MarkusSkalprGrimsson (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
[edit] File:50px-Template-info.svg.png Template documentation

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

General information about documentation for templates

{{ Documentation }} family

Template:Documentation subpage/doc (backlinks, edit)
Template:Documentation subpage/sandbox (backlinks, edit)
Template:Documentation subpage/testcases (backlinks, edit)

Meta Wiki {{ Documentation }} ancestor