Difference between revisions of "Template:Documentation/doc"
m (→See also: use link syntax) |
(+ "Explanation", shortened and expanded from removed section) |
||
| Line 12: | Line 12: | ||
Typically documentation subpages are not also put in the categories in which the page the documentation refers to is put. | Typically documentation subpages are not also put in the categories in which the page the documentation refers to is put. | ||
| + | |||
| + | ==Explanation== | ||
| + | Transcluding a template on a page adds to the {{peis}} of that page, which is the amount of text the server must parse to render the page. Hidden content on a template page, like documentation, adds to this include size even though it doesn't appear on the page. Transcluding the documentation from a subpage reduces this include size to the negligible number of bytes added by the characters on the template page itself, thus reducing server load. | ||
| + | |||
| + | Using a subpage also allows anyone to edit the documentation, categories, or interwiki links of a protected template. | ||
<!-- for the template --> | <!-- for the template --> | ||
Revision as of 02:52, 5 July 2007
Template:Documentation subpage Template:Shortcut
Contents
Usage
On template (or other) pages
This template displays a "(Namespace) documentation" box like the one you are seeing now. Place the following code on the template (or other) page, and edit the documentation page (click the "[edit]" link after you save) where you can put instructions, categories, et cetera.
<noinclude>{{documentation}}</noinclude>
On documentation subpages
Please add the following code at the top of the subpage to put it in Category:Documentation subpages; this keeps it out of Special:Uncategorizedpages and links back to the main page.
<noinclude>{{documentation subpage}}</noinclude>
Typically documentation subpages are not also put in the categories in which the page the documentation refers to is put.
Explanation
Transcluding a template on a page adds to the Template:Peis of that page, which is the amount of text the server must parse to render the page. Hidden content on a template page, like documentation, adds to this include size even though it doesn't appear on the page. Transcluding the documentation from a subpage reduces this include size to the negligible number of bytes added by the characters on the template page itself, thus reducing server load.
Using a subpage also allows anyone to edit the documentation, categories, or interwiki links of a protected template.
