(Created page with "<div class="container-steel" style="margin: 0; padding: 1em"> <div style="display: flex; justify-content: space-between; align-items: baseline; margin-bottom: 0.5em"> <div style="display: inline-block; font-size: 1.5em; font-weight: bold">Template documentation</div> <div><nowiki>[</nowiki>[[{{FULLPAGENAME}}/doc|view]]<nowiki>]</nowiki> <span class="plainlinks"><nowiki>[</nowiki>[{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} edit]<nowiki>]</nowiki></span></div> </di...") |
(a little padding) |
||
(One intermediate revision by the same user not shown) | |||
Line 4: | Line 4: | ||
<div><nowiki>[</nowiki>[[{{FULLPAGENAME}}/doc|view]]<nowiki>]</nowiki> <span class="plainlinks"><nowiki>[</nowiki>[{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} edit]<nowiki>]</nowiki></span></div> | <div><nowiki>[</nowiki>[[{{FULLPAGENAME}}/doc|view]]<nowiki>]</nowiki> <span class="plainlinks"><nowiki>[</nowiki>[{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} edit]<nowiki>]</nowiki></span></div> | ||
</div> | </div> | ||
<div class="steel">{{ | <div class="steel" style="padding: 1.25em">{{/doc}}</div> | ||
</div> | </div> |
Revision as of 20:55, 22 October 2025
Template:Documentation is used to add instructions on how to use a template, including an explanation of its syntax and parameters, recommended usage, and example code. When added to a page, it will transclude a subpage found at
Template:YOURTEMPLATE/doc
(which initially will be a red link) – write your documentation on that subpage.
Usage
Place the following at the bottom of a template:
<noinclude>{{Documentation}}</noinclude>
This must come directly after the last character in your template – do not place it on a new line.
Example
If you have a template to create bold text that looks like this:
'''{{{1}}}'''
Add the documentation template like this:
'''{{{1}}}'''<noinclude>{{Documentation}}</noinclude>