Editing Template:Documentation/doc

{{documentation subpage}}
This is the {{tl|Documentation}} template, used on almost every template page to contain that template's documented instructions and information.

This template displays a documentation 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 that are [[mw:Transclusion|transcluded]] onto other pages.

Use of this template allows templates to be [[mw:Help:Protection|protected]] where necessary, while allowing anyone to edit the documentation and categories.

===Usage===
Normally this template is used without any parameters, placed at the bottom of the template or page being documented, within a &lt;noinclude&gt; container:

<syntaxhighlight lang="xml+smarty">
<!--Last line of your template code--><noinclude>
{{Documentation}}
<!-- Add categories to the /doc subpage, not here -->
</noinclude>
</syntaxhighlight>

Then this template automatically loads the content from the /doc subpage of the template it is used on, along with automatically transcluding {{tl|How to export}}. To hide the instructions from {{tl|How to export}}, set the parameter <code>noexportinstructions</code> to <code>yes</code>

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

<syntaxhighlight lang="xml+smarty">
<!--Last line of your template code--><noinclude>
{{Documentation |Template:Other page/doc}}
</noinclude>
</syntaxhighlight>

Note that when loading the documentation from a page other than the local /doc page it becomes tricky to handle the categories.

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

<syntaxhighlight lang="xml+smarty">
<!--Last line of your template code--><noinclude>
{{Documentation
 | content =
(some documentation)
}}</noinclude>
</syntaxhighlight>

When the <nowiki>|content=</nowiki> parameter is used, the doc box normally does not 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.

Parameter <nowiki>|1=</nowiki> and the <nowiki>|content=</nowiki> parameter can also be combined, like this:

<syntaxhighlight lang="xml+smarty">
<!--Last line of your template code--><noinclude>
{{Documentation |1=Template:Any page/doc
| content =
{{Template:Any page/doc |parameters}}
}}</noinclude>
</syntaxhighlight>

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 {{tlx|Any page/doc|parameters}}. In this example a parameter is also fed to the /doc page being loaded.

=== Shortcut ===
To automatically insert the [[w:Wikipedia:Noinclude|noinclude tags]], the template call and the guiding comment, use this [[w:WP:Substitution|substitution]] code:<br>

:<code><nowiki>{{subst:doc-code}}</nowiki></code>

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

Categories that apply to the template itself should be added to the bottom of the /doc subpage, inside &lt;includeonly&gt; tags.

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

===Heading===
When in the Template namespace, this template shows this heading:
:[[File:Test Template Info-Icon - Version (2).svg|32px|link=[[w:Wikipedia:Template documentation]]]] '''Template documentation'''

In most other namespaces, such as "{{SITENAME}}:", 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:

:<code><nowiki>{{Documentation |heading=Infobox documentation}}</nowiki></code>

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

:<code><nowiki>{{Documentation |heading=}}</nowiki></code>

The '''heading-style''' parameter can be fed optional [[w:Cascading Style Sheets|CSS]] values. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
:<code>heading-style=font-size:150%;color:red;</code>

===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
: <nowiki>|link box=off</nowiki>.

You can also insert customised text into the link box, by setting the <nowiki>|link box=</nowiki> parameter. For example:
<pre style="width:auto; overflow:scroll">
  |link box=This documentation is automatically generated by [[w:Template:Country showdata]]
</pre>

===Automatic functions===
If the documentation page does not exist, the [create] link includes a [[mw:Manual:Creating pages with preloaded text|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.

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

This template is usually placed in a subject namespace, within &lt;noinclude&gt; tags. But in some cases this template needs to be on the talk page:

* In the Mediawiki namespace, since &lt;noinclude&gt; often does not work in system messages, and since the Mediawiki namespace needs to be kept clean for performance reasons.

When placed on talk pages, this template usually is placed near the top of the page and without &lt;noinclude&gt; tags.

The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki [[w:m:Help:Link#Subpage feature|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 namespaces.) There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those) namespaces.

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

===Technical details===
The preload page for the /doc [create] link is [[Template:Documentation/preload]]. The preload pages for the /sandbox and /testcases [create] links are [[Template:Documentation/preload-sandbox]] and [[Template:Documentation/preload-testcases]]. The preload page for the /sandbox [mirror] link is [[Template:Documentation/mirror]].

====Full syntax====
<pre>
{{Documentation}}

{{Documentation
 | content =
}}

{{Documentation
| [path to documentation page]
| heading-style = 
| heading = 
| link box = 
}}
</pre>

===See also===
* {{tl|Documentation subpage}}, a notice placed at the top of a /doc subpage explaining its role and including a link to the page it documents.
* [[w:Wikipedia:Template documentation]] is a how-to guide to template documentation.
* [[w:Wikipedia:Template sandbox and test cases]] explains the use of /sandbox and /testcases subpages and includes more information about template testing.