 | This is a documentation subpage for Template:documentation. It contains usage information, categories and other content that are not part of the original template page. |
This template is used to show the documentation of the template or a module that is stored in the /doc subpage and wraps a green box around it depending on the namespace of the page using the template.
Usage
On any page, this template is best used using the following syntax:
<!-- Your template code --><noinclude>
{{documentation}}
<!-- Categories, interwikis and TemplateData goes to the /doc subpage -->
</noinclude>
The documentation page is then created through the links provided by the template when the page is saved. If a /doc subpage exists, this template will transclude it accordingly with the respective categories and TemplateData documentation if the page is in the Template: namespace.
Technical notes
This template invokes Module:Documentation and passes given parameters over to it. The module is the main place where the processing and formatting of the page is done.
TemplateData
This is the TemplateData documentation for the template used by the new VisualEditor.
Documentation
A template to display documentation from the /doc subpage.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Documentation page | 1 docpage | The page holding the documentation, if not in the default /doc subpage. | Page name | optional |
| Sandbox page | sandbox | The sandbox page to link to. | Page name | optional |
| Testcases page | testcases | The testcases page to link to. | Page name | optional |
| Heading | heading | A custom heading to use instead of the defaults. Use "off" for this parameter to disable the heading text. | String | optional |
| Content | content | Contents to put in the documentation box, used to put documentation on the template page itself. | String | optional |