The Glest Wiki
(add autocheck for whether the preload template has been copied, misc tweaks to documentation)
 
(Removed references to preload function, as it is a failure)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{#ifeq: {{NAMESPACE}}:{{BASEPAGENAME}} | Template:Documentation
 
| {{#ifexist: Template:Documentation/preload | <!-- nothing; preload already copied --> | <span class="error">Please copy the documentation preload template from [[w:c:templates:Template:Documentation/preload]] to [[Template:Documentation/preload]]!</span> }}
 
}}<!-- you can remove the above code and this comment once you've copied the preload template -->
 
 
;Description
 
;Description
 
:This template is used to insert documentation on template pages.
 
:This template is used to insert documentation on template pages.
Line 34: Line 31:
   
 
Note that the above example also uses {{t|T}}.<includeonly>
 
Note that the above example also uses {{t|T}}.<includeonly>
[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>
 
[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
 

Latest revision as of 18:29, 26 March 2011

Description
This template is used to insert documentation 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 (<br style="clear: both;" />) 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 {{T}}.