Template:Documentation: Difference between revisions
From Drunkapedia
imported>Tlosk No edit summary |
imported>Tlosk No edit summary |
||
| Line 1: | Line 1: | ||
<includeonly>{|cellpadding=3 style="border:1px solid #e5e5e5; width:100%; background:#f9f9f9;" | <includeonly>{|cellpadding=3 style="border:1px solid #e5e5e5; width:100%; background:#f9f9f9;" | ||
!align=left bgcolor=#d0d0d0| <big>Template Documentation:</big> | !align=left bgcolor=#d0d0d0| <big>Template Documentation:</big> | ||
!align=right bgcolor=#d0d0d0| '''<small>[ | !align=right bgcolor=#d0d0d0| '''<small>[{{fullurl:{{PAGENAME}}}}/Doc&action=edit Edit Documentation]</small> | ||
|} | |} | ||
{{{{PAGENAME}}/Doc}}</includeonly><noinclude>{{Documentation}}[[Category:Wiki Template]][[Category:General Template]]</noinclude> | {{{{PAGENAME}}/Doc}}</includeonly><noinclude>{{Documentation}}[[Category:Wiki Template]][[Category:General Template]]</noinclude> | ||
Revision as of 14:17, 3 December 2009
| Template Documentation: | Edit Documentation |
|---|
Related topics: Wiki Templates, Wiki Template Documentation
Syntax
<noinclude>{{Documentation}}</noinclude>
Usage
- This template is used to insert documentation on template pages.
- Place at the end of the template code.
- Create a subpage called "Template Name/Doc" where the template's documentation will be stored.
Segregating documentation to a subpage means that updates to the documentation don't cause large numbers of pointless template updates across the wiki, and the template itself can be protected if necessary (without protecting the documentation). That is, each time a change is made to a template, all pages that use that template are updated, which can be significant for widely used templates. Similarly, when changes are needed to a widely used template, experiment first on {{Sandbox}} so only a single change will be needed to the template itself.