Difference between revisions of "Template:Documentation/doc"

From blackwiki
Jump to navigation Jump to search
test>Vivaelcelta
(Interwikis to Wikidata)
imported>Cedar101
m (→‎Usage: lang="xml")
 
(132 intermediate revisions by 67 users not shown)
Line 1: Line 1:
{{documentation subpage}}
+
<noinclude>{{pp-semi-indef}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE AND INTERWIKIS IN WIKIDATA -->
+
</noinclude>{{Distinguish|Template:Documentation subpage}}
 +
{{Documentation subpage}}
 +
{{template shortcut|doc}}
 +
{{High-use}}
 +
{{Lua|Module:Documentation}}
  
This is the {{tl|documentation}} template.
+
This is the '''{{tlx|documentation}}''' template used on almost every [[Help:A quick guide to templates|template page]] to contain that template's documented instructions and information, including [[Wikipedia:TemplateData|<templatedata>]], on either the template page itself, or a created documentation subpage.
  
For most of the instructions about how and when to use this template, see [[Wikipedia:Template documentation]].
+
For detailed instructions on how and when to use this template, see [[Wikipedia:Template documentation]] (shortcut: [[WP:TDOC]]).
  
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 displays a green 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 do so.
  
This template is intended for documenting templates and other pages which are [[Wikipedia:Transclusion|transcluded]] onto other pages. It can be used in template space and most other [[Wikipedia:Namespace|namespaces]].
+
This template is intended for documenting templates and other pages that are [[Wikipedia:Transclusion|transcluded]] onto other pages. It can be used in the [[Wikipedia:Template namespace|template namespace]] and most other [[Wikipedia:Namespace|namespace]]s.
  
Use of this template allows templates to be [[Wikipedia:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation and categories.
+
Use of this template allows templates to be [[Wikipedia:Protection policy|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 <code>&lt;noinclude></code>:
+
==Usage==
 +
Normally, this template is used without any parameters, and is placed at the bottom of the template page or other page being documented, within a {{tag|noinclude}} container:
  
<pre>
+
<syntaxhighlight lang="xml+smarty">
 
<!--Last line of your template code--><noinclude>
 
<!--Last line of your template code--><noinclude>
 
+
{{Documentation}}
{{documentation}}
 
 
<!-- Add categories to the /doc subpage and interwikis in Wikidata, not here! -->
 
<!-- Add categories to the /doc subpage and interwikis in Wikidata, not here! -->
 
</noinclude>
 
</noinclude>
</pre>
+
</syntaxhighlight>
  
Then this template automatically loads the content from the /doc subpage of the template it is used on.
+
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:
+
This template can also load the content from any other page. For example:
  
<pre>
+
<syntaxhighlight lang="xml+smarty">
 
<!--Last line of your template code--><noinclude>
 
<!--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 subpage, it becomes tricky to handle the categories.
 +
 +
The content can also be fed directly as text. For example:
  
{{documentation |Template:Other page/doc}}
+
<syntaxhighlight lang="xml">
</noinclude>
+
<!--Last line of your template code--><noinclude>
</pre>
+
{{Documentation
 +
| content =
 +
<!-- template documentation -->
 +
}}</noinclude>
 +
</syntaxhighlight>
  
Note that when loading the documentation from another page than the local /doc page it becomes tricky to handle the categories and interwiki links.
+
When the {{para|content}} 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.
  
The content can also be fed directly as text. Like this:
+
Parameter {{para|1}} and the {{para|content}} parameter can also be combined, for example:
  
<pre>
+
<syntaxhighlight lang="xml">
 
<!--Last line of your template code--><noinclude>
 
<!--Last line of your template code--><noinclude>
 +
{{Documentation |1=Template:Any page/doc
 +
| content =
 +
<!-- {{Template:Any page/doc |parameters}} -->
 +
}}</noinclude>
 +
</syntaxhighlight>
  
{{documentation |content=
+
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 {{tnull|Template:Any page/doc{{!}}parameters}}. In this example, a parameter is also fed to the /doc page being loaded.
Some documentation text.
+
 
}}
+
==Placement and tags==
</noinclude>
+
This code should be added at the bottom of the template code page, with no space before {{Tag|noinclude|o}} (which causes extra whitespace to show on pages where the template is transcluded): <syntaxhighlight lang="xml"><!--Last line of your template code--><noinclude>
</pre>
+
{{documentation}}
 +
</noinclude></syntaxhighlight>
 +
 
 +
To automatically insert the [[Wikipedia:Noinclude|noinclude tags]], the template call and the guiding comment, you can also use this [[Wikipedia:Substitution|substitution]] code shortcut:
  
When the {{para|content}} 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.
+
{{tlxs|doc-code}}
  
Parameter {{para|1}} and the {{para|content}} parameter can also be combined, like this:
+
Which results in: <syntaxhighlight lang="xml"><!--Last line of your template code--><noinclude>
 +
{{documentation}}
 +
<!-- Add categories to the /doc subpage and interwikis in Wikidata, not here! -->
 +
</noinclude></syntaxhighlight>
  
<pre>
+
===Categorization===
<!--Last line of your template code--><noinclude>
+
When a documentation subpage is created by using this template, then to place the template itself into a category, add <code><nowiki>[[Category:Category name]]</nowiki></code> inside an {{tag|includeonly|p|content={{((}}Sandbox other{{!!}}...{{))}}}} section on the /doc subpage. For example, for placement on the documentation subpage:
  
{{documentation
+
<syntaxhighlight lang="xml" style="overflow:auto;">
|1=Template:Any page/doc
+
{{Documentation subpage}}
|content=
+
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Template:Any page/doc |parameters}}
+
== Usage ==
}}
 
</noinclude>
 
</pre>
 
  
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 {{tnull|Template:Any page/doc{{!}}parameters}}. In this example a parameter is also fed to the /doc page being loaded.
+
<includeonly>{{sandbox other||
 +
<!-- Categories below this line; interwikis at Wikidata -->
 +
[[Category:Category name]]
 +
[[Category:Category name2]]
 +
}}</includeonly>
 +
</syntaxhighlight>
  
=== Best practice ===
+
When a documentation subpage has not been created, and the documentation template is being used with a {{para|content}} parameter on the actual template page, then to place the template itself into a category, add <code><nowiki>[[Category:Category name]]</nowiki></code> inside the documentation template, after the content. For example, for placement on the actual template page:
  
The code should be added at the bottom of the template code, with no space before {{tag|noinclude|o}} (which would cause extra space on pages where the template is used).
+
<syntaxhighlight lang="xml" style="overflow:auto;">
 +
<!--Last line of your template code--><noinclude>
 +
{{Documentation
 +
| content =
 +
<!-- template documentation -->
  
Categories and interwiki links that apply to the template itself should be added to the bottom of the /doc subpage, inside {{tag|includeonly}} tags. For more complex cases, see [[Wikipedia:Template documentation#Categories and interwiki links]].
+
[[Category:Category name]]
 +
[[Category:Category name2]]
 +
}}</noinclude>
 +
</syntaxhighlight>
  
If the documentation page contains {{tag|includeonly|o}} or {{tag|noinclude|o}} tags as part of the visible documentation text, replace the "<code>&lt;</code>" with "<code>&amp;lt;</code>".
+
Interwiki links that apply to the template should be listed at [[d:|Wikidata]] (more at [[Wikipedia:Wikidata]]).  For more complex cases, see {{section link|Wikipedia:Template documentation#Categories and interwiki links}}.
  
=== The heading ===
+
==Best practices==
 +
If the documentation page contains {{tag|includeonly|o}} or {{tag|noinclude|o}} tags, as part of the visible documentation text, replace the "<code>&lt;</code>" with "<code>&amp;lt;</code>" or use [[Template:tag]].
  
 +
==Heading==
 
When in the Template namespace, this template shows this heading:
 
When in the Template namespace, this template shows this heading:
:[[File:Template-info.svg|32px]] '''Template documentation'''
+
:[[File:Test Template Info-Icon - Version (2).svg|32px|link=[[Wikipedia:Template documentation]]]] '''Template documentation'''
  
 
In most other namespaces, such as "Wikipedia:", it shows this heading:
 
In most other namespaces, such as "Wikipedia:", it shows this heading:
Line 83: Line 119:
 
:'''Summary'''
 
:'''Summary'''
  
The '''heading''' parameter can be used to set the heading to something else. Like this:
+
The '''heading''' parameter can be used to set the heading to something else. For example:
  
:<code><nowiki>{{documentation |heading=Infobox documentation}}</nowiki></code>
+
:<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:
+
If the '''heading''' parameter is empty but defined, no heading is shown and no [edit] [purge] links are shown. For example:
  
:<code><nowiki>{{documentation |heading=}}</nowiki></code>
+
:<code><nowiki>{{Documentation |heading=}}</nowiki></code>
  
 
The '''heading-style''' parameter can be fed optional [[Cascading Style Sheets|CSS]] values. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
 
The '''heading-style''' parameter can be fed optional [[Cascading Style Sheets|CSS]] values. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
:<code>heading-style = color: red; font-size: 150%;</code>
+
:<code>heading-style=font-size:150%;color:red;</code>
 
 
=== 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.
+
==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 {{para|link box|off}}.
 
To hide the link box, add the parameter {{para|link box|off}}.
  
You can also insert customised text in the link box, by defining the {{para|link box}} parameter. For example:
+
You can also insert customised text into the link box, by setting the {{para|link box}} parameter. For example:
{{para|link box|This documentation is automatically generated by [<nowiki />[Template:Country showdata]]}}
 
 
 
=== 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 <small>(create)</small> links.
+
|link box=This documentation is automatically generated by [[Template:Country showdata]]
  
When this template is on a protected template page it now automatically adds {{tl|pp-template}} which shows the grey or red padlock in the top right corner. So no need to manually add {{tlf|pp-template}} to templates that use {{tl|documentation}}.
+
==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.
  
When this template is on a /sandbox subpage it automatically adds the {{tl|template sandbox notice}}. If that sandbox is not a subpage of the live template, then the {{para|livepage}} parameter can be used to correctly link back to that template.
+
When this template is on a protected template page it now automatically adds {{tl|pp-template}}, which shows the grey or red padlock in the top right corner. So no need to manually add {{tlf|pp-template}} to templates that use {{tl|Documentation}}.
  
=== Subject namespaces vs. talk namespaces ===
+
When this template is on a /sandbox subpage it automatically adds the {{tl|Template sandbox notice}}.
  
 +
==Subject namespaces vs. talk namespaces==
 
Terminology: ''Subject namespaces'' are the opposite of ''talk namespaces''. For instance "Template:" is the subject space of "Template talk:".
 
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 {{tag|noinclude|o}} tags. But in some cases this template needs to be on the talk page:
 
This template is usually placed in a subject namespace, within {{tag|noinclude|o}} tags. But in some cases this template needs to be on the talk page:
  
* For preload pages (usually in Template or Wikipedia namespaces), since they cannot use {{tag|noinclude|o}}. See for instance, [[Template talk:AfC preload]] and [[Template talk:RfD subpage starter]]. Such talk pages can be marked with {{tl|talkdoc}}.
+
* In the Mediawiki namespace, since {{tag|noinclude|o}} often does not work in system messages, and since the Mediawiki namespace needs to be kept clean for performance reasons.
 
 
* In the Mediawiki namespace, since {{tag|noinclude|o}} often does not work in system messagesm 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 {{tag|noinclude}} tags.
 
When placed on talk pages, this template usually is placed near the top of the page and without {{tag|noinclude}} tags.
  
The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki [[meta: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.
+
The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki [[meta:Help:Link#Subpage feature|subpage feature]] enabled: Main, File, and Mediawiki. (Categories can have subpages, but documentation is created in the Category talk namespace to prevent creating empty categories.) (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 <small>[create]</small> links for the /doc, /sandbox and /testcases to the right namespace.
+
This template automatically points its [create] links for the /doc, /sandbox and /testcases to the right namespace.
  
=== Technical details ===
+
==Testing==
 +
You can simulate the output for a given page by using the {{para|page}} parameter. For example, if you use the code {{para|page|Template:Edit protected}}, the template will behave exactly as if it were on the page [[Template:Edit protected]], including showing the documentation from [[Template:Edit protected/doc]], linking to [[Template:Edit protected/sandbox]], etc. This parameter is useful for testing and is used extensively on the [[Module:Documentation/testcases|module testcases page]].
  
This template calls {{tl|documentation/start box2}} and {{tl|documentation/end box2}} which in turn call {{tl|documentation/start box}} and {{tl|documentation/end box}}. The /start box (and /end box) hold most of the code, while this template and /start box2 (and /end box2) do parameter preprocessing.
+
==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]].
  
The preload page for the /doc <small>[create]</small> link is [[Template:Documentation/preload]], but in File namespace it is [[Template:Documentation/preload-filespace]]. The preload pages for the /sandbox and /testcases <small>[create]</small> links are [[Template:Documentation/preload-sandbox]] and [[Template:Documentation/preload-testcases]].
+
For more details, see the [[Template talk:Documentation|talk page]].
  
For more technical details see the [[Template talk:Documentation|talk page]].
+
===Full syntax===
 +
<pre>
 +
{{Documentation}}
  
=== See also ===
+
or
 +
 
 +
{{Documentation
 +
| content =
 +
}}
 +
 
 +
or
 +
 
 +
{{Documentation
 +
| [path to documentation page]
 +
| heading-style =  
 +
| heading =  
 +
| link box =  
 +
}}
 +
</pre>
  
<!-- {{documentation/see also}} -->
+
==See also==
* {{tl|documentation}} – Placed on templates and other pages to document them.
+
* {{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.
* {{tl|documentation subpage}} – Used at the top of /doc subpages to explain what they are and to link back to the page they document.
+
* {{tl|Barnstar documentation}}, a variant of {{tl|Documentation}} for use with [[Wikipedia:Barnstars|barnstar]] templates.
* {{tl|barnstar documentation}} – Variant specifically for [[WP:BARNSTAR|barnstar]] templates
+
* {{tl|Documentation/color scheme}} presents the color scheme used by {{tl|Documentation}}.
* [[Wikipedia:Template documentation]] – The how-to guide about template documentation.
+
* [[Wikipedia:Template documentation]] is a how-to guide to template documentation.
* [[Wikipedia:Template test cases]] – How to use /sandbox and /testcases subpages and more about template testing.
+
* [[Wikipedia:Template sandbox and test cases]] explains the use of /sandbox and /testcases subpages and includes more information about template testing.
  
<includeonly>
+
<includeonly><!-- Make sure that only page [[Template:Documentation]] is categorised. No other page (no subpages, not when transcluded).
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
-->{{#ifeq:{{FULLPAGENAME}}|Template:Documentation|
[[Category:Template documentation]]
+
[[Category:Template documentation| ]]
[[Category:Wikipedia formatting and function templates]]
+
[[Category:Template namespace templates|Documentation]]
</includeonly>
+
}}</includeonly>

Latest revision as of 00:43, 30 December 2020

This is the {{documentation}} template used on almost every template page to contain that template's documented instructions and information, including <templatedata>, on either the template page itself, or a created documentation subpage.

For detailed instructions on how and when to use this template, see Wikipedia:Template documentation (shortcut: WP:TDOC).

This template displays a green 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 do so.

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

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

Usage

Normally, this template is used without any parameters, and is placed at the bottom of the template page or other page being documented, within a <noinclude>...</noinclude> container:

<!--Last line of your template code--><noinclude>
{{Documentation}}
<!-- Add categories to the /doc subpage and interwikis in Wikidata, not here! -->
</noinclude>

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. For example:

<!--Last line of your template code--><noinclude>
{{Documentation |Template:Other page/doc}}
</noinclude>

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

The content can also be fed directly as text. For example:

<!--Last line of your template code--><noinclude>
{{Documentation
 | content =
<!-- template documentation -->
}}</noinclude>

When the |content= 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 |1= and the |content= parameter can also be combined, for example:

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

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

Placement and tags

This code should be added at the bottom of the template code page, with no space before <noinclude> (which causes extra whitespace to show on pages where the template is transcluded):

<!--Last line of your template code--><noinclude>
{{documentation}}
</noinclude>

To automatically insert the noinclude tags, the template call and the guiding comment, you can also use this substitution code shortcut:

{{subst:doc-code}}

Which results in:

<!--Last line of your template code--><noinclude>
{{documentation}}
<!-- Add categories to the /doc subpage and interwikis in Wikidata, not here! -->
</noinclude>

Categorization

When a documentation subpage is created by using this template, then to place the template itself into a category, add [[Category:Category name]] inside an <includeonly>{{Sandbox other||...}}</includeonly> section on the /doc subpage. For example, for placement on the documentation subpage:

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
== Usage ==

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Category name]]
[[Category:Category name2]]
}}</includeonly>

When a documentation subpage has not been created, and the documentation template is being used with a |content= parameter on the actual template page, then to place the template itself into a category, add [[Category:Category name]] inside the documentation template, after the content. For example, for placement on the actual template page:

<!--Last line of your template code--><noinclude>
{{Documentation
 | content =
<!-- template documentation -->

[[Category:Category name]]
[[Category:Category name2]]
}}</noinclude>

Interwiki links that apply to the template should be listed at Wikidata (more at Wikipedia:Wikidata). For more complex cases, see Script error: No such module "Section link"..

Best practices

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

Heading

When in the Template namespace, this template shows this heading:

Test Template Info-Icon - Version (2).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. For example:

{{Documentation |heading=Infobox documentation}}

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

{{Documentation |heading=}}

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

heading-style=font-size:150%;color:red;

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

You can also insert customised text into the link box, by setting the |link box= parameter. For example:

|link box=This documentation is automatically generated by Template:Country showdata

Automatic functions

If the documentation page does not 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 {{pp-template}} to templates that use {{Documentation}}.

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

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 <noinclude> tags. But in some cases this template needs to be on the talk page:

  • In the Mediawiki namespace, since <noinclude> 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 <noinclude>...</noinclude> tags.

The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki subpage feature enabled: Main, File, and Mediawiki. (Categories can have subpages, but documentation is created in the Category talk namespace to prevent creating empty categories.) (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.

Testing

You can simulate the output for a given page by using the |page= parameter. For example, if you use the code |page=Template:Edit protected, the template will behave exactly as if it were on the page Template:Edit protected, including showing the documentation from Template:Edit protected/doc, linking to Template:Edit protected/sandbox, etc. This parameter is useful for testing and is used extensively on the module testcases page.

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.

For more details, see the talk page.

Full syntax

{{Documentation}}

or

{{Documentation
 | content =
}}

or

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

See also