Difference between revisions of "Template:Template Overview"
m (Template:Template Explanation moved to Template:Template Overview) |
m |
||
Line 1: | Line 1: | ||
− | <noinclude>{{Template | + | <noinclude>{{Template Overview |
|usedon=template | |usedon=template | ||
|purpose=display the general template information and the required template text for copying, pasting, and using in pages | |purpose=display the general template information and the required template text for copying, pasting, and using in pages | ||
Line 9: | Line 9: | ||
}}</nowiki> | }}</nowiki> | ||
}} | }} | ||
− | {{Parameter | + | {{Template Parameter |
|name=usedon | |name=usedon | ||
|usage=mandatory | |usage=mandatory | ||
Line 17: | Line 17: | ||
|validvalues=Any string or strings. | |validvalues=Any string or strings. | ||
}} | }} | ||
− | {{Parameter | + | {{Template Parameter |
|name=purpose | |name=purpose | ||
|usage=mandatory | |usage=mandatory | ||
Line 25: | Line 25: | ||
|validvalues=Any string or strings. | |validvalues=Any string or strings. | ||
}} | }} | ||
− | {{Parameter | + | {{Template Parameter |
|name=othernotes | |name=othernotes | ||
|takes=a string or strings | |takes=a string or strings | ||
Line 32: | Line 32: | ||
|validvalues=Any string or strings. | |validvalues=Any string or strings. | ||
}} | }} | ||
− | {{Parameter | + | {{Template Parameter |
|name=template | |name=template | ||
|usage=mandatory | |usage=mandatory |
Revision as of 13:36, 3 October 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 Explanation |usedon= |purpose= |othernotes= |template= }}
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.