Difference between revisions of "Template:Template Parameter"
m |
m |
||
| Line 12: | Line 12: | ||
|validvalues= | |validvalues= | ||
}}</nowiki> | }}</nowiki> | ||
| − | |||
}} | }} | ||
{{Template Parameter | {{Template Parameter | ||
Revision as of 12:45, 10 December 2009
Template:Template Parameter is designed for use on template pages to explain a parameter's function and usage.
Template
{{Parameter Explanation
|name=
|usage=
|takes=
|denotes=
|generates=
|defaultvalue=
|othernotes=
|validvalues=
}}
Parameters
[[Category:{{{category}}} Templates|Template Parameter]]
name
- Usage: Mandatory
- Description: The name parameter takes a string denoting the name of the parameter. This is used to generate the parameter's section header, as well as to display the parameter's name in the description.
- Valid Value(s): Any string.
usage
- Usage: Optional
- Description: The usage parameter takes a string denoting whether the use of the parameter is mandatory or optional. This is used to generate the "Usage" bullet point. If this parameter is left blank or omitted, a default value of "Optional" is used. The value of "Optional" will also be displayed if a value is supplied that is not "mandatory."
- Valid Value(s): "mandatory"
takes
- Usage: Mandatory
- Description: The takes parameter takes a string or strings denoting what type of values the parameter takes in. This is used to generate the middle of the first sentence in the parameter's "Description" bullet point.
- Valid Value(s): Any string or strings.
denotes
- Usage: Mandatory
- Description: The denotes parameter takes a string or strings denoting what the value passed to the parameter corresponds to. This is used to generate the end of the first sentence in the parameter's "Description" bullet point.
- Valid Value(s): Any string or strings.
generates
- Usage: Mandatory
- Description: The generates parameter takes a string or strings denoting what the parameter's data is used for. This is used to generate the second sentence in the parameter's "Description" bullet point.
- Valid Value(s): Any string or strings.
defaultvalue
- Usage: Optional
- Description: The defaultvalue parameter takes a string or strings denoting what will be displayed if a parameter that has a default value is left blank or omitted. This is used to generate a sentence reading "If this parameter is left blank or omitted, a default value of defaultvalue is displayed." after the sentence generated by generates.
- Valid Value(s): Any string or strings.
othernotes
- Usage: Optional
- Description: The othernotes parameter takes a string or strings denoting any other relevant information about the parameter. This is used to generate a sentence or sentences at the end of the "Description" bullet point.
- Valid Value(s): Any string or strings.
validvalues
- Usage: Mandatory
- Description: The validvalues parameter takes a string or strings denoting any and all values that are valid to be passed to the parameter. This is used to generate the "Valid Value(s)" bullet point.
- Valid Value(s): Any string or strings.