Template:Documentation/doc
Jump to navigation
Jump to search
This is a page documentation subpage for Template:Documentation.
It contains usage information, categories, interlanguage links and other content that is not part of the original Template page.
It contains usage information, categories, interlanguage links and other content that is not part of the original Template page.
- Description
- This template is used to insert documentation on template pages.
- Syntax
- Type
<noinclude>
at the end of the template page.{{documentation}}
</noinclude>
General usage
On the Template page
Template code<noinclude> {{Documentation}} </noinclude>
On the Template/doc page
; Description : This template is used to do something. ; Dependencies: :* Uses (some CSS, JS, file, or other template). ; Syntax : Type <code>{{t|templatename}}</code> somewhere. ; Sample output : <code><nowiki>{{templatename|foo}}</nowiki></code> gives... : {{templatename|foo}} <includeonly>Any categories for the template itself </includeonly><noinclude> [[Category:Template documentation]] </noinclude>
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections.
Note that the above example also uses {{T}}
.
TemplateData
This template is used to display documentation on template pages. It also adds some tools to help the editor to modify the /doc subpage and the template.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Custom Documentation Location | 1 | The name of the custom /doc subpage.
| String | optional |
Inline Documentation Content | content | Content if documentation page will not be transcluded
| String | optional |
Heading text | heading | Changes the default "Documentation" header to a different one
| String | optional |
Custom footer content | footer | Replaces the default link box with a custom one
| Unbalanced wikitext | optional |