Template:Documentation/Doc: Difference between revisions
(Created page with '{{Related|Wiki Templates}} == Syntax == <pre> <noinclude>{{Documentation}}</noinclude> </pre> == Usage == * This template is used to insert documentation on template pages. * P…') |
No edit summary |
||
| Line 10: | Line 10: | ||
* Create a subpage called "Template Name/Doc" where the template's documentation will be stored. | * 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 {{tl | 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 {{tl|Sandbox}} so only a single change will be needed to the template itself. | ||
<noinclude>[[Category:Template Documentation]]</noinclude> | |||
Revision as of 17:53, 3 December 2009
Related topics: Wiki Templates
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.