Template:Documentation
More actions
Usage
This template displays a green documentation box at the bottom of a
template page, transcluded from a /doc subpage. It lets
editors maintain a template's documentation separately from the
template itself, which is especially useful when the template is
protected <kcite ref="1"/>.
Standard usage
Place the following at the very bottom of a template, inside
<noinclude> tags so it does not appear in articles
that transclude the template:
<noinclude>
{{Documentation}}
</noinclude>
This will transclude Template:NAME/doc, where
NAME is the name of the template.
Custom doc location
To load documentation from a different page, pass it as the first parameter:
<noinclude>
{{Documentation|Template:Some other page}}
</noinclude>
Parameters
- 1 (unnamed)
- Optional. The full page name of the documentation page to transclude. Defaults to
Template:Documentation/doc.
See also
- {{Documentation subpage}} — goes at the top of the
/docpage itself.
The above documentation is transcluded from Template:Documentation/doc (edit · history).
Editors can experiment in this template's sandbox and testcases pages.
Please add categories to the /doc subpage. Subpages of this template.
Usage
This template displays a green documentation box at the bottom of a
template page, transcluded from a /doc subpage. It lets
editors maintain a template's documentation separately from the
template itself, which is especially useful when the template is
protected <kcite ref="1"/>.
Standard usage
Place the following at the very bottom of a template, inside
<noinclude> tags so it does not appear in articles
that transclude the template:
<noinclude>
{{Documentation}}
</noinclude>
This will transclude Template:NAME/doc, where
NAME is the name of the template.
Custom doc location
To load documentation from a different page, pass it as the first parameter:
<noinclude>
{{Documentation|Template:Some other page}}
</noinclude>
Parameters
- 1 (unnamed)
- Optional. The full page name of the documentation page to transclude. Defaults to
Template:Documentation/doc.
See also
- {{Documentation subpage}} — goes at the top of the
/docpage itself.
The above documentation is transcluded from Template:Documentation/doc (edit · history).
Editors can experiment in this template's sandbox and testcases pages.
Please add categories to the /doc subpage. Subpages of this template.