Template:Template

From SoftMC-Wiki
Revision as of 15:49, 13 October 2010 by Arwiebe (talk | contribs)
Jump to: navigation, search

This template should be used to add a description to all other templates.

Within a template page, the description has to be enclosed by <noinclude></noinclude>, so it is not shown on the page, which uses the template (see examples).

Template

{{Template
|description=
|template=
|parameters=
|operation=
|examples=
}}

Parameters

description
Main description of the template.
template
Prototype of the template definition, which can be copied and pasted to the place of use.
The content has to be enclosed into <nowiki></nowiki>, so it is not treated as a template itself.
parameters (optional)
Template parameters description.
operation (optional)
Description of automatic operations of the template.
examples
Please provide at least one example!

Operation

This template does not provide any automatic operations.

Examples

<includeonly>
%% Template content %%
</includeonly><!-- 

### TEMPLATE DESCRIPTION
--><noinclude>
{{Template
|description=
|template=
<nowiki>
</nowiki>
|parameters=
|operation=
|examples=
}}
</noinclude>

For more examples refer to pages, which use this template: What links here.

Help:Templates describes general usage of templates, including treatment of special characters.