Difference between revisions of "Template:Template Overview"

m
m
Line 57: Line 57:
 
|takes=a string
 
|takes=a string
 
|denotes=whether the template has parameters or not
 
|denotes=whether the template has parameters or not
|generates=either a blank space beneath the "Parameters" section if either a "true" is supplied, the parameter is left out, or left blank, or a boilerplate message indicating that there are no parameters if a "false" is supplied
+
|generates=either a blank space beneath the "Parameters" section if the parameter is left out or left blank, or a boilerplate message indicating that there are no parameters if a "none" is supplied
|validvalues="true" or "false"
+
|validvalues="none" or blank
 
}}
 
}}
 
{{Template Parameter
 
{{Template Parameter
Line 85: Line 85:
 
==Parameters==
 
==Parameters==
 
{{#switch: {{{parameters}}}
 
{{#switch: {{{parameters}}}
| false = This template has no parameters.
+
| none = This template has no parameters.
| true
+
|  
 
| #default =  
 
| #default =  
 
}}
 
}}
 
[[Category:{{{category}}} Templates|{{PAGENAME}}]]</includeonly>
 
[[Category:{{{category}}} Templates|{{PAGENAME}}]]</includeonly>

Revision as of 07:51, 4 January 2010

Template:Template Overview is designed for use on template pages to display the general template information and the required template text for copying, pasting, and using in pages.

Template

{{Template Overview
|usedon=
|purpose=
|othernotes=
|template=
|display=
|parameters=
|category=
}}

Parameters

usedon

  • Usage: Mandatory
  • Description: The usedon parameter takes a string or strings denoting the type or types of pages this template is designed for use on. This is used to generate the middle of the template description's introductory sentence.
  • Valid Value(s): Any string or strings.

purpose

  • Usage: Mandatory
  • Description: The purpose parameter takes a string or strings denoting what the template was designed to do or display. This is used to generate the end of the template description's introductory sentence.
  • Valid Value(s): Any string or strings.

othernotes

  • Usage: Optional
  • Description: The othernotes parameter takes a string or strings denoting any further relevant information about the usage or functionality of the template. This is used to generate a sentence or sentences after the template description's introductory sentence.
  • Valid Value(s): Any string or strings.

template

  • Usage: Mandatory
  • Description: The template parameter takes a string or strings denoting the actual text of the template that a user must copy and paste onto a page in order to use the template. This is used to generate the "Template" section. When entered into the Template Explanation template, the template's transclusion code must be enclosed in <nowiki></nowiki> tags, or else the template itself will be transcluded into the <pre></pre> block.
  • Valid Value(s): The text of the template for transclusion enclosed by <nowiki></nowiki> tags.

display

  • Usage: Optional
  • Description: The display parameter takes a string denoting whether an example of the template should be displayed. This is used to generate the "Display" section.
  • Valid Value(s): "yes" to automatically display the template in its entirety, or any string or strings making up the display of the template.

parameters

  • Usage: Mandatory
  • Description: The parameters parameter takes a string denoting whether the template has parameters or not. This is used to generate either a blank space beneath the "Parameters" section if the parameter is left out or left blank, or a boilerplate message indicating that there are no parameters if a "none" is supplied.
  • Valid Value(s): "none" or blank

category

  • Usage: Mandatory
  • Description: The category parameter takes a string denoting the template-related category in which to place the template. This is used to generate the template page's category.
  • Valid Value(s): Any string or strings.