Template:Documentation

Frahn Wikipidia
Jomp go a: navigieshan, saach
[edit] Template-info.svg Template documentation

Template loop detected: Template:Documentation subpage

Usage[edit suos]

{{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 (i.e., pages transcluding the "/doc" page), it notes that the documentation is transcluded from a subpage.

Functions[edit suos]

In addition to the output message, the template categorizes pages to Documentation subpages and defaults the sort key to the page name without namespace (i.e., "Foo" on "Template:Foo", so it would be sorted in categories under 'F').

Related pages[edit suos]


This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not.

Usage[edit suos]

<noinclude>{{documentation}}</noinclude>
or <noinclude>{{documentation|template:any page}}</noinclude>

This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page.

Add categories and interwiki links to the documentation page inside includeonly tags.

If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;".

Functions[edit suos]

If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format. The header depends on the namespace; for example, it will display "Template documentation" in the template namespace.

Rationale[edit suos]

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).

Related pages[edit suos]