Template:Documentation/doc: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
sims>Kirkburn mNo edit summary |
sims>Kirkburn No edit summary |
||
| Line 3: | Line 3: | ||
;Syntax |
;Syntax |
||
:Type <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page. |
:Type <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page. |
||
==General usage== |
|||
===On the Template page=== |
|||
<pre> |
|||
Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude> |
|||
{{documentation}}</noinclude> |
|||
</pre> |
|||
Note that, depending on the template, you may need to add a clear or complete a table/div just before <code><nowiki>{{documentation}}</nowiki></code> 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=== |
|||
<pre> |
|||
;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> |
|||
</pre> |
|||
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:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
||
Revision as of 15:52, 14 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>{{templatename|foo}}</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.