Template:Documentation/doc: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
sims>Kirkburn No edit summary |
sims>Kirkburn mNo edit summary |
||
Line 22: | Line 22: | ||
:Type <code>{{t|templatename}}</code> somewhere. |
:Type <code>{{t|templatename}}</code> somewhere. |
||
;Sample output |
;Sample output |
||
:<code> |
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives... |
||
:{{templatename|foo}} |
:{{templatename|foo}} |
||
Revision as of 16:07, 20 November 2008
- 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>{{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|{{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.
Note that the above example also uses the Template:T and Template:T/piece templates.