Template:Documentation
Template documentation
|
|---|
| Note: portions of the template sample may not be visible without values provided. |
| View or edit this documentation. (About template documentation) |
| Editors can experiment in this template's sandbox and test case pages. |
This template uses Module:Documentation, a script written in Lua.
This template is used to insert documentation to template pages.
Syntax
- {{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
This 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 |