Difference between revisions of "Template:Template Overview"

m
m
Line 42: Line 42:
 
|othernotes=When entered into the Template Explanation template, the template's transclusion code must be enclosed in {{Monospace|<nowiki><nowiki></nowiki></nowiki>}} tags, or else the template itself will be transcluded into the {{Monospace|<nowiki><pre></pre></nowiki>}} block.
 
|othernotes=When entered into the Template Explanation template, the template's transclusion code must be enclosed in {{Monospace|<nowiki><nowiki></nowiki></nowiki>}} tags, or else the template itself will be transcluded into the {{Monospace|<nowiki><pre></pre></nowiki>}} block.
 
|validvalues=The text of the template for transclusion enclosed by {{Monospace|<nowiki><nowiki></nowiki></nowiki>}} tags.
 
|validvalues=The text of the template for transclusion enclosed by {{Monospace|<nowiki><nowiki></nowiki></nowiki>}} tags.
 +
}}
 +
{{Template Parameter
 +
|name=display
 +
|takes=a string
 +
|denotes=whether an example of the template should be displayed
 +
|generates=the "Display" section
 +
|validvalues="yes" or "no"
 
}}
 
}}
 
{{Template Parameter
 
{{Template Parameter
Line 57: Line 64:
 
==Template==
 
==Template==
 
{{Pre | {{{template}}} }}
 
{{Pre | {{{template}}} }}
 +
 +
{{#switch: {{{display}}}
 +
| yes = ==Display==
 +
{{{{PAGENAME}}}}
 +
| no
 +
| #default =
 +
}}
  
 
==Parameters==
 
==Parameters==

Revision as of 12:25, 10 December 2009

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=
|parameters=
}}

Parameters

[[Category:{{{category}}} Templates|Template Overview]]

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" or "no"

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 a "yes" is supplied, or a boilerplate message indicating that there are no parameters if a "no" is supplied.
  • Valid Value(s): "yes" or "no"