Template:Documentation
(Redirected from Template:Doc)
Template documentationNote: parts of or the entire template might not be visible without values provided.
| Main | Documentation | Usage |
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 | |
|---|---|---|---|---|
| Type | type | Optional template type.. Do not include "Templates" suffix.
| String | suggested |
| Type 2 | type2 | Optional template type. Do not include "Templates" suffix.
| String | optional |
| Is draft | draft | Set to 1 if this is for a draft template. | Boolean | optional |
| Alternative doc page | 1 | Optional alternative page for documentation instead of Template:{name}/doc. Unless if there's a specific reason to not use the default doc page, you shouldn't use an alternative. | Page name | optional |