Template:Documentation/doc

This is the documentation template.

For most of the instructions about how and when to use this template, see Template documentation.

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 and placed at the bottom of the template or page being documented, in a &lt;noinclude> section. Like this:

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

This template can also load the content from any other page. Like this:

Note that when loading the documentation from another page than the local /doc page it becomes tricky to handle the categories and interwiki links.

The content can also be fed directly as text. Like this:

When the content parameter is used the doc box normally doesn't show the [edit] [purge] links in the top right corner. Note that if the /doc page exists a link to it is still shown in the link box below the doc box.

But parameter 1 and the content parameter can also be combined, like this:

Then the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But the content parameter is used for the content shown in the doc box. The above code means that the content is transcluded as " ". In this example a parameter is also fed to the /doc page being loaded.

Best practice
The code should be added at the bottom of the template code, with no space before " " (which would cause extra space on pages where the template is used).

Categories and interwiki links that apply to the template itself should be added to the bottom of the /doc subpage, inside  tags. For more complex cases, see Template documentation.

If the documentation page contains &lt;includeonly> or &lt;noinclude> tags as part of the visible documentation text, replace the " " with " ".

The heading
When in Template space this template shows this heading:
 * Template-info.svg Template documentation

In most other namespaces, such as "Wikipedia:", it shows this heading:
 * Documentation

But when on File (image) pages it shows this heading:
 * Summary

The heading parameter can be used to set the heading to something else. Like this:



If the heading parameter is empty but defined, no heading is shown and no [edit] [purge] links are shown. Like this:



The heading-style parameter can be fed optional CSS values. Without quotation marks  but with the ending semicolons. For example:

The link box
Below the big doc box is a small link box that shows some meta-data about the documentation. The link box shows different things depending on what parameters are fed to this template, and in which namespace it is used. In some cases the link box is not shown at all.

To hide the link box, add the parameter " ".

Automatic functions
If the documentation page doesn't exist, the [create] link includes a preload page so that clicking it will pre-fill the edit form with the basic documentation page format. Preload text is also used for the /sandbox and /testcases (create) links.

When this template is on a protected template page it now automatically adds pp-template which shows the grey or red padlock in the top right corner. So no need to manually add to templates that use documentation.

When this template is on a /sandbox subpage it automatically adds the template sandbox notice.

Subject space vs talk space
Terminology: Subject space is the opposite of talk space. For instance "Template:" is the subject space of "Template talk:".

This template is usually placed in subject space, within &lt;noinclude> tags. But in some cases this template needs to be on the talkpage:


 * For preload pages (usually in Template or Wikipedia space), since they can't use &lt;noinclude>. See for instance Template talk:AfC preload and Template talk:RfD subpage starter. Such talkpages can be marked with talkdoc.


 * In MediaWiki space, since &lt;noinclude> often doesn't work in system messages and since MediaWiki space needs to be kept clean for performance reasons.

When placed on talkpages this template usually is placed near the top of the page and without &lt;noinclude> tags.

The /doc, /sandbox and /testcases pages should normally be in subject space, except in the namespaces that don't have the MediaWiki subpage feature enabled: Main, File, MediaWiki and Category. (But currently we only show the /sandbox and /testcases links from User, User talk, Template and Template talk space.) There are also a whole bunch of other technical reasons why the /doc page must be stored under the talkpage for those namespaces.

This template automatically points its create links for the /doc, /sandbox and /testcases to the right namespace.

Technical details
This template calls documentation/core2 which in turn calls documentation/core. /core holds most of the code, while this template and /core2 do parameter preprocessing.

The preload page for the /doc [create] link is Template:Documentation/preload, but in File space it is Template:Documentation/preload-filespace. The preload pages for the /sandbox and /testcases (create) links are Template:Documentation/preload-sandbox and Template:Documentation/preload-testcases.

For more technical details see the talk page.