Template:Documentation: Difference between revisions

Template page
(oops)
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<div class="container-steel" style="margin: 0; padding: 1em">
<div class="container-steel documentation" style="margin: 0; padding: 1em">
<div style="display: flex; justify-content: space-between; align-items: baseline; margin-bottom: 0.5em">
<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 style="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>
<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">{{/doc}}</div>
<div class="steel" style="padding: 1.25em">{{/doc}}</div>
</div>
</div>

Latest revision as of 18:28, 23 October 2025

Template documentation
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>