Template:Documentation/testcases
This is the template test cases page for the sandbox of Template:Documentation. to update the examples. If there are many examples of a complicated template, later ones may break due to limits in MediaWiki; see the HTML comment "NewPP limit report" in the rendered page. You can also use Special:ExpandTemplates to examine the results of template uses. You can test how this page looks in the different skins with these links: |
Documentation
---- {{documentation}} ---- {{documentation|Template:Documentation/testcases/test1}} ---- {{documentation|Template:Documentation/testcases/test2}} ---- {{documentation|content=This is in line documentation.}} ---- {{documentation|Template:Documentation/testcases/nodoc|content=Documentation.}} ---- {{documentation|Template:Documentation/testcases/test1|content=Documentation.}} ----
Default Documentation
| |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is the 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. UsageNormally, this template is used without any parameters, and is placed at the bottom of the template page or other page being documented, within a <!--Last line of your template code--><noinclude>
{{Documentation}}
<!-- Add categories to the /doc subpage -->
</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 Parameter <!--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 Placement and tagsThis 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:
<!--Last line of your template code--><noinclude>
{{documentation}}
<!-- Add categories to the /doc subpage -->
</noinclude>
CategorizationWhen a documentation subpage is created by using this template, then to place the template itself into a category, add {{Documentation subpage}}
== Usage ==
<include<includeonly></includeonly>only>{{sandbox other||
<!-- Categories below this line -->
[[Category:Category name]]
[[Category:Category name2]]
}}</includeonly>
When a documentation subpage has not been created, and the documentation template is being used with a <!--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 Wikipedia:Template documentation § Categories and interwiki links. HeadingWhen in the Template namespace, this template shows this heading: On the Module namespace, the template shows this heading instead: In most other namespaces, such as "Wikipedia:", it shows this heading:
The heading parameter can be used to set the heading to something else. For example:
If the heading parameter is empty but defined, no heading is shown and no [edit] [purge] links are shown. For example:
The heading-style parameter can be fed optional CSS values. Without quotation marks
Link boxBelow 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 You can also insert customised text into the link box, by setting the
Automatic functionsIf 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 namespacesTerminology: 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
When placed on talk pages, this template usually is placed near the top of the page and without 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. TestingYou can simulate the output for a given page by using the Technical detailsThe 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 = }} Color scheme
See also
|
This is in line documentation.
Documentation/sandbox
---- {{documentation/sandbox}} ---- {{documentation/sandbox|Template:Documentation/testcases/test1}} ---- {{documentation/sandbox|Template:Documentation/testcases/test2}} ---- {{documentation/sandbox|content=This is in line documentation.}} ---- {{documentation/sandbox|Template:Documentation/testcases/nodoc|content=Documentation.}} ---- {{documentation/sandbox|Template:Documentation/testcases/test1|content=Documentation.}} ----
Default Documentation
|
---|
Template:Documentation/sandbox
Template:Documentation/sandbox
Template:Documentation/sandbox
Template:Documentation/sandbox
Template:Documentation/sandbox
Notest
For {{File mover granted}}:
Live documentation
{{documentation|page=Template:File mover granted|notest=y}}
This template should always be substituted (i.e., use {{subst:Documentation/testcases}}). |
Sandbox documentation
{{documentation/sandbox|page=Template:File mover granted|notest=y}}