Difference between revisions of "Template:Documentation/doc"
(→Pre-expand include size: and typically much less, which is an advantages compared to putting the documentation in the wikitext of the template page.) |
(→Pre-expand include size: rewrite) |
||
| Line 19: | Line 19: | ||
==Pre-expand include size== | ==Pre-expand include size== | ||
| − | + | Transcluding a template directly or indirectly on a page adds to the {{peis}} of that page. In general, documentation of the template on the template page adds to this pre-expand include size by an amount per call of 23 bytes for the noinclude tags, plus the size of the unexpanded wikitext for the documentation. When using this Template:Documentation the latter is 17 bytes for the wikitext "<nowiki>{{documentation}}</nowiki>", so typically much less than the documentation text itself. Together the use of this template adds 40 bytes per direct or indirect inclusion. | |
==See also== | ==See also== | ||
*{{mlww|Template documentation}} | *{{mlww|Template documentation}} | ||
Revision as of 09:42, 4 July 2007
Template:Documentation subpage
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.
Pre-expand include size
Transcluding a template directly or indirectly on a page adds to the Template:Peis of that page. In general, documentation of the template on the template page adds to this pre-expand include size by an amount per call of 23 bytes for the noinclude tags, plus the size of the unexpanded wikitext for the documentation. When using this Template:Documentation the latter is 17 bytes for the wikitext "{{documentation}}", so typically much less than the documentation text itself. Together the use of this template adds 40 bytes per direct or indirect inclusion.
