Template:Documentation, template/doc
 | This is a documentation subpage for Template:Terminate sentence It contains usage information, categories and other content that is not part of the original template page. |
Uisage
[eedit soorce]<noinclude>{{documentation}}<noinclude>
or <noinclude>{{documentation|template:any page}}<noinclude>
The template automatically displays a documentation box like you are seeing now.
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 first parameter can be used as shown above to transclude an arbitrary documentation page.
Functions
[eedit soorce]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
[eedit soorce]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).
See an aw
[eedit soorce]- Template:template doc (backlinks, edit) (similar template with more documentation; see template comparison)
- Template:documentation subpage (backlinks, edit) (replaces older {{Template doc page viewed directly}} and {{Template doc page transcluded}})