Template:Documentation/doc: Difference between revisions
From Mariopedia, a wiki on Mario, Yoshi, Wario, Donkey Kong, Super Smash Bros., and more!
Jump to navigationJump to search
Content added Content deleted
(fix) |
(remove unnecessary notice) |
||
| Line 2: | Line 2: | ||
:This template is used to insert descriptions on template pages. |
:This template is used to insert descriptions on template pages. |
||
;Syntax |
;Syntax |
||
:Type <code><nowiki><noinclude></nowiki>{{ |
:Type <code><nowiki><noinclude></nowiki>{{tem|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page. |
||
==General usage== |
==General usage== |
||
| Line 20: | Line 20: | ||
:This template is used to do something. |
:This template is used to do something. |
||
;Syntax |
;Syntax |
||
:Type <code>{{ |
:Type <code>{{tem|templatename}}</code> somewhere. |
||
;Sample output |
;Sample output |
||
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives... |
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives... |
||
| Line 29: | Line 29: | ||
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. |
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 the [[Template:T]] and [[Template:T/piece]] templates. |
|||
<includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
<includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
||
Revision as of 01:28, May 21, 2022
- Description
- This template is used to insert descriptions on template pages.
- Syntax
- Type
<noinclude>{{documentation}}</noinclude>at the end of the template page.
General usage
On the Template page
Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
Note that, depending on the template, you may need to add a clear or complete a table/div just before {{documentation}} is inserted (within the noinclude tags).
The line break is also useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page
;Description
:This template is used to do something.
;Syntax
:Type <code>{{tem|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|{{PAGENAME}}]]</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.
