Difference between revisions of "Template:Template Parameter"

(Test)
 
m (Progressing.)
Line 19: Line 19:
  
 
==Parameters==
 
==Parameters==
{{Parameter Explanation
+
 
|name=name
+
===name===
|takes=a string
+
* '''Usage:''' {{#ifeq:  | optional | Optional | Mandatory}}
|denotes=the name of the parameter
+
* '''Description:''' The <span style="font-family:monospace;">name</span> 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. {{#if:  | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is displayed. | }} {{#if:  | {{{othernotes}}} | }}
|generates=the parameter's section header, as well as to display the parameter's name in the description.
+
* '''Valid Value(s):''' Any string.
|validvalues=The parameter name.
+
 
}}</noinclude><includeonly>
+
 
==={{{name}}}===
+
===usage===
* '''Usage:''' {{#ifeq: {{{usage|}}} | optional | Optional | Mandatory}}
+
* '''Usage:''' {{#ifeq:  | optional | Optional | Mandatory}}
 +
* '''Description:''' The <span style="font-family:monospace;">usage</span> 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: Optional | If this parameter is left blank or omitted, a default value of "Optional" is displayed. | }} {{#if:  | {{{othernotes}}} | }}
 +
* '''Valid Value(s):''' "mandatory"
 +
 
 +
 
 +
===takes===
 +
* '''Usage:''' {{#ifeq:  | optional | Optional | Mandatory}}
 +
* '''Description:''' The <span style="font-family:monospace;">takes</span> 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. {{#if:  | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is displayed. | }} {{#if:  | {{{othernotes}}} | }}
 +
* '''Valid Value(s):''' Any string or strings.
 +
 
 +
 
 +
===denotes===
 +
* '''Usage:''' {{#ifeq: | optional | Optional | Mandatory}}
 +
* '''Description:''' The <span style="font-family:monospace;">denotes</span> 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. {{#if:  | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is displayed. | }} {{#if:  | {{{othernotes}}} | }}
 +
* '''Valid Value(s):''' Any string or strings.
 +
 
 +
 
 +
===generates===
 +
* '''Usage:''' {{#ifeq:  | optional | Optional | Mandatory}}
 +
* '''Description:''' The <span style="font-family:monospace;">generates</span> 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. {{#if:  | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is displayed. | }} {{#if:  | {{{othernotes}}} | }}
 +
* '''Valid Value(s):''' Any string or strings.
 +
</noinclude><includeonly>==={{{name}}}===
 +
* '''Usage:'''
 
* '''Description:''' The <span style="font-family:monospace;">{{{name}}}</span> parameter takes {{{takes}}} denoting {{{denotes}}}. This is used to generate {{{generates}}}. {{#if: {{{defaultvalue|}}} | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is displayed. | }} {{#if: {{{othernotes|}}} | {{{othernotes}}} | }}
 
* '''Description:''' The <span style="font-family:monospace;">{{{name}}}</span> parameter takes {{{takes}}} denoting {{{denotes}}}. This is used to generate {{{generates}}}. {{#if: {{{defaultvalue|}}} | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is displayed. | }} {{#if: {{{othernotes|}}} | {{{othernotes}}} | }}
* '''Valid Value(s):''' {{{validvalues}}}
+
* '''Valid Value(s):''' {{{validvalues}}}</includeonly>
</includeonly>
+

Revision as of 12:18, 2 October 2009

Template:Parameter Explanation is designed for use on template pages to explain each parameter's function and usage.

Full Template

{{Parameter Explanation
|name=
|usage=
|takes=
|denotes=
|generates=
|defaultvalue=
|othernotes=
|validvalues=
}}

Parameters

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: Mandatory
  • 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 displayed.
  • 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.