Template:Template documentation/Old

From Wikipedia, the free encyclopedia

This documentation template is deprecated; please use the documentation guidelines at WP:DOC instead.

Below is the documentation of this template. See the lists of templates on Wikipedia.
Purge server cache if the template uses noinclude, and your changes do not appear..
Use and syntax:

To document a template, copy, paste and adapt this code below at end of a template source (i.e. just before its last existing newline, and without any unneeded newline or blank addition before or after this code):

<noinclude>{{Template documentation}}

; Use<nowiki>:</nowiki>
Indicate the purpose of this template and when to use it.

; Syntax<nowiki>:</nowiki>
: <tt><nowiki>{{</nowiki>{{BASEPAGENAME}}</tt>
: <tt>|</tt>''value1''<tt>|</tt>''value2''<tt>|</tt>''etc.''<tt>|
: <tt>parameterA=</tt>''valueA''<tt>|</tt>
: <tt>parameterB=</tt>''valueB''<tt>|</tt>
: <tt>etc.|</tt>
: <tt><nowiki>}}</nowiki></tt>

<!-- describe each parameter, and whever they are required or optional, and if they have a default value:
(positional numbered parameters should be mandatory, optional parameters should not be positional)
* ''value1''&nbsp;= description1.
* ''value2''&nbsp;= description2.
* ''etc.''
* <tt>parameterA</tt>&nbsp;= descriptionA ''(required)''.
* <tt>parameterB</tt>&nbsp;= descriptionB ''(optional, by default&nbsp;= default2)''.
* etc.
-->

<!-- Indicate the name of templates that are variants of this template with different behavior:
; Variants<nowiki>:</nowiki>
* [[Template:Name of template variant]]
-->

<!-- Indicate related articles or templates that use this template:
; See also<nowiki>:</nowiki>
* [[Article|Article name]]
-->

<!-- Please locate a better category for this template -->
[[Category:Uncategorized templates|{{subst:PAGENAME}}]]

<!-- Locate the equivalent templates in other wiki projects, and specify their names:
[[de:Vorlage:Name of equivalent German template]]
[[es:Plantilla:Name of equivalent Spanish template]]
[[fr:Modèle:Name of equivalent French template]]
[[it:Template:Name of equivalent Italian template]]
[[ja:Template:Name of equivalent Japanese template]]
[[nl:Sjabloon:Name of equivalent Dutch template]]
[[pl:Szablon:Name of equivalent Polish template]]
[[pt:Predefinição:Name of equivalent Portuguese template]]
[[sv:Mall:Name of equivalent Swedish template]]
-->

</noinclude>
Note:
This template is intended for inclusion within templates themselves. It should provide only the basic documentation to use the template and see a limited number of examples. There’s another template for adding more complete documentation within the talk page of your templates, with special cases, warnings, and related information.
See also:
Languages