Template:Documentation/doc

From Deep Blue Robotics Wiki
Revision as of 09:24, 4 July 2007 by Patrick~mediawikiwiki (Talk) (Pre-expand include size: and typically much less, which is an advantages compared to putting the documentation in the wikitext of the template page.)

Jump to: navigation, search

Template:Documentation subpage

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

The inclusion of this template on the page of another template adds 40 bytes to the Template:Peis of a page calling the latter directly or indirectly, for each call. This is independent of the size of the documentation, and typically much less, which is an advantages compared to putting the documentation in the wikitext of the template page.

See also