Template:Doc short

  Template documentation

This is the {{doc short}} template. It can be used to display a documentation subpage which describes and shows examples of complex templates with a large expansion depth (of nested if-else logic; see: m:Help:Expansion depth). The page width defaults to 99% to avoid the bottom scroll bar, but setting width=101% can allow for wider text on the page.

This template displays a green doc box like you are seeing now, and automatically loads the content from a /doc subpage. It can also load the content from other places if instructed to.

This template is intended for documenting templates and other pages which are transcluded onto other pages. It can be used in template space and most other namespaces.

Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.

Usage

Normally this template is used without any parameters, placed at the bottom of the template or page being documented, below a <noinclude> tag:

<!--Last line of your template code--><noinclude>

{{doc short}}
<!-- Add categories and interwikis to the /doc subpage, not here! -->
</noinclude>

Then this template automatically loads the content from the /doc subpage of the template it is used on.

Performance impact

This template has an expansion depth of 1 level. It can be used to display a documentation subpage for a complex template, instead of using the other template {{documentation}}, consuming 11 expansion levels, which might exceed the total expansion depth limit (such as 40 levels during 2009-2011). Due to shortening the expansion depth, no ability to create /doc pages is provided in this template, so use the template {{documentation}} when first needing to create a doc subpage.