Template:Documentation: Difference between revisions
More actions
consistent with new substitution template format |
Created page with "<div class="template-documentation iezoomfix" style="clear: both; margin: 1em 0 0 0; border: 1px solid #aaa; background-color: #ecfcf4; padding: 1em;"> <div style="padding-bottom: 3px; border-bottom: 1px solid #aaa; margin-bottom: 1ex;"> 50px|left|link=|alt=Documentation icon '''Template documentation'''<span style="font-size: 90%;">view · [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit}} edit] · [{{fullurl:{{{1|{{FU..." |
||
| Line 1: | Line 1: | ||
{{# | <div class="template-documentation iezoomfix" style="clear: both; margin: 1em 0 0 0; border: 1px solid #aaa; background-color: #ecfcf4; padding: 1em;"> | ||
< | |||
<div style="padding-bottom: 3px; border-bottom: 1px solid #aaa; margin-bottom: 1ex;"> | |||
[[File:Template-info.svg|50px|left|link=|alt=Documentation icon]] | |||
'''Template documentation'''<span style="font-size: 90%;">[[#top|view]] · [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit}} edit] · [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=history}} history] · [{{fullurl:{{FULLPAGENAME}}|action=purge}} purge]</span> | |||
</div> | |||
{{ {{{1|{{FULLPAGENAME}}/doc}}} }} | |||
<div style="clear: both; margin-top: 1ex; padding-top: 3px; border-top: 1px solid #aaa; font-style: italic;"> | |||
The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from <span class="plainlinks">[[{{{1|{{FULLPAGENAME}}/doc}}}]] ([{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit}} edit] · [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=history}} history])</span>.<br /> | |||
Editors can experiment in this template's [[{{FULLPAGENAME}}/sandbox|sandbox]] and [[{{FULLPAGENAME}}/testcases|testcases]] pages.<br /> | |||
Please add categories to the [[{{{1|{{FULLPAGENAME}}/doc}}}|/doc]] subpage. [[Special:WhatLinksHere/{{FULLPAGENAME}}|Subpages of this template]]. | |||
</div> | |||
</div><noinclude> | |||
{{Documentation|Template:Documentation/doc}} | |||
</noinclude> | </noinclude> | ||
Revision as of 09:06, 24 April 2026
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.