Difference between revisions of "Template:Documentation/doc"
Jump to navigation
Jump to search
m (project category overhaul - changing category linking & update content) |
m (re-cat) |
||
| Line 43: | Line 43: | ||
<includeonly>Any categories for the template itself</includeonly> | <includeonly>Any categories for the template itself</includeonly> | ||
| − | <noinclude>[[Category:Template | + | <noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
</pre> | </pre> | ||
| Line 50: | Line 50: | ||
Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates. | Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates. | ||
| − | <includeonly>[[Category:Templates]][[Category:Template | + | <includeonly>[[Category:Templates]][[Category:Template documentation]]</includeonly> |
| − | <noinclude>[[Category:Template | + | <noinclude>[[Category:Template documentation]]</noinclude> |
Revision as of 14:33, 1 August 2019
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude> at the end of the template page.
Usage
On the Template page
This is the normal format when used:
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{documentation}} is inserted (within the noinclude tags).
A line break right before {{documentation}} can also be useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page
Normally, you will want to write something like the following on the documentation page:
==Description==
This template is used to do something.
==Syntax==
Type <code>{{t|templatename}}</code> somewhere.
==Usage==
A more indepth description of when, how this template is used.
==Samples==
<code><nowiki>{{templatename|input}}</nowiki></code>
results in...
{{templatename|input}}
==See Also==
A list of all related links.
<includeonly>Any categories for the template itself</includeonly>
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
Use any or all of the above header sections. You may also add other header sections as required.
Note that the above example also uses the Template:T and Template:T/piece templates.