Template:Documentation/doc
Template page
More actions
This is the documentation page for Documentation. It contains usage information, categories, and other content not part of the original template page. | ||
|---|---|---|
| Main | Documentation | Usage |
This template is used on 294 pages, or on about 2.81% of all pages.
Edits to this template will be widely noticed. To avoid large-scale disruption and unnecessary server load, any changes to this template should be tested in its sandbox or testcases subpages, or in your own user space. The tested changes can then be added to this page in one single edit.
Please consider discussing any changes in the wiki's Discord.
This template uses Module:Documentation, a script written in Lua.
This template uses CSS found at MediaWiki:Gadget-Documentation.css.
This template is used to insert documentation to template pages.
Syntax
edit- {{Documentation}} will produce the documentation template.
- {{Documentation|foo}} will fill in the documentation from the "
foo" template. - {{Documentation|content = This template does something}} will fill in the documentation with the content "
This template does something." (not recommended except for very, very short documentation) - {{Documentation|heading = Important information}} will replace the default heading with "
Important information". - {{Documentation|type = category}} will add the "
category Templates" category.
Template Data
editThis template is used to insert descriptions on template pages.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Custom Documentation Page | 1 | Page containing the documentation
| Page name | optional |
| Heading | heading | Custom heading
| Line | optional |
| Preload Page | preload | The page to preload if the `/doc` subpage doesn't exist.
| Page name | optional |
| Content | content | Custom documentation content, prevents transclusion of `/doc` subpage. | Content | optional |
| Type | type | Category to categorize template in. | String | suggested |