Template:Documentation: Difference between revisions
Tag: Undo |
No edit summary |
||
| Line 1: | Line 1: | ||
<div class="boilerplate" style="background-color:#ecfcf4;padding:0px 10px;border:1px solid #a2a9b1;margin-top:1em;"> | <div class="boilerplate" style="background-color:#ecfcf4;padding:0px 10px;border:1px solid #a2a9b1;margin-top:1em;clear:both;"> | ||
< | <div style="padding-bottom:3px;border-bottom: 1px solid #aaa;margin-bottom:1ex;"> | ||
-- | <span style="font-weight:bold;font-size:1.25em;">[[File:Test Template Info-Icon - Version (2).svg|50px|alt=|link=]] Documentation</span> | ||
<span class="mw-editsection-like plainlinks">[[[{{FULLPAGENAME}}/doc|view]]] [[{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} edit]]</span> | |||
</div> | |||
{{{{FULLPAGENAME}}/doc}} | {{{{FULLPAGENAME}}/doc}} | ||
</div> | </div> | ||
Revision as of 04:11, 25 April 2021
This is the preferred method for including documentation for a template.
Usage
This should only be used on pages in the Template namespace. It should not be used in any articles.
Add the following to the end of a template to transclude documentation for it:
<noinclude>{{documentation}}</noinclude>
After adding this, you can press the edit button at the top of the green box to edit the contents of the documentation.
Keeping the documentation separate from the template itself has a few benefits, like easier organization and putting less strain on the server when the documentation is edited.
TemplateData
This is the preferred method for including documentation for a template. This is only meant for pages in the Template namespace; it is NOT meant for use in articles.
| Parameter | Description | Type | Status | |||
|---|---|---|---|---|---|---|
| No parameters specified | ||||||