Template:Documentation/doc

This template provides a mechanism to document other pages (usually another template, but technically it can be used in other namespaces — the following information assumes it is being used on a template page).

The actual documentation is contained in a subpage whose title is the title of the current page plus the suffix. (For example, if is called on the page Template:C, the documentation will be transcluded from the page Template:C/doc.)

For details on how to properly document templates, see Help:Templates and Help:Template sandbox and test cases.

Parameters
None in typical usage (see next section). However, this template actually passes the following parameters (with empty default values) to Documentation/core2, so certain default settings can be overridden.

Do not override any of these unless you have a really good reason.

Usage
The element is necessary to ensure that the template documentation (say, Template:C/doc) appears when viewing the template it's documenting (Template:C) but not any other page where the template is called (e.g., Gentoo Wiki:Guidelines, which contains  template calls).

(As the standard usage of this template is so simple, no test cases are shown here.)