Template:Documentation: Difference between revisions

Revision as of 20:42, 22 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

<noinclude>{{Documentation|<optional page name>}}</noinclude>

By default, this template retrieves documentation at Template:YOURTEMPLATE/doc. The unnamed first parameter is optional and can be used to point to documentation on a different page.

Template:Documentation 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, add the documentation template like this:

'''{{{1}}}'''<noinclude>{{Documentation}}</noinclude>

If your template is named Template:Bold, and you want to reuse documentation from Template:Italics, fill in the first parameter like this:

'''{{{1}}}'''<noinclude>{{Documentation|Template:Italics/doc}}</noinclude>

@@ 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>
-	<div class="steel">{{{1}}}</div>
+	<div class="steel">{{/doc}}</div>
 </div>