Difference between revisions of "Template:Template Parameter"

m (Progressing.)
m (Testing.)
Line 21: Line 21:
  
 
===name===
 
===name===
−
* '''Usage:''' {{#ifeq:  | optional | Optional | Mandatory}}
+
* '''Usage:''' Mandatory
−
* '''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}}} | }}
+
* '''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.
 
* '''Valid Value(s):''' Any string.
 
* '''Valid Value(s):''' Any string.
  
  
 
===usage===
 
===usage===
−
* '''Usage:''' {{#ifeq:  | optional | Optional | Mandatory}}
+
* '''Usage:''' Optional
−
* '''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}}} | }}
+
* '''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 this parameter is left blank or omitted, a default value of "Optional" is displayed.
 
* '''Valid Value(s):''' "mandatory"
 
* '''Valid Value(s):''' "mandatory"
  
  
 
===takes===
 
===takes===
−
* '''Usage:''' {{#ifeq:  | optional | Optional | Mandatory}}
+
* '''Usage:''' 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}}} | }}
+
* '''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.
 
* '''Valid Value(s):''' Any string or strings.
 
* '''Valid Value(s):''' Any string or strings.
  
  
 
===denotes===
 
===denotes===
−
* '''Usage:''' {{#ifeq:  | optional | Optional | Mandatory}}
+
* '''Usage:''' 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}}} | }}
+
* '''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.
 
* '''Valid Value(s):''' Any string or strings.
 
* '''Valid Value(s):''' Any string or strings.
  
  
 
===generates===
 
===generates===
−
* '''Usage:''' {{#ifeq:  | optional | Optional | Mandatory}}
+
* '''Usage:''' 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}}} | }}
+
* '''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.
 +
* '''Valid Value(s):''' Any string or strings.
 +
 
 +
{{Template:Parameter Explanation
 +
|name=test
 +
|usage=mandatory
 +
}}
 +
{{Template:Parameter Explanation
 +
|name=test2
 +
}}
 +
 
 +
===defaultvalue===
 +
* '''Usage:''' Optional
 +
* '''Description:''' The <span style="font-family:monospace;">defaultvalue</span> 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 <span style="font-family:monospace;">defaultvalue</span> is displayed." after the sentence generated by <span style="font-family:monospace;">generates</span>.
 
* '''Valid Value(s):''' Any string or strings.
 
* '''Valid Value(s):''' Any string or strings.
 
</noinclude><includeonly>==={{{name}}}===
 
</noinclude><includeonly>==={{{name}}}===

Revision as of 12:50, 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: 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 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.

Template:Parameter Explanation Template:Parameter Explanation

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.
Retrieved from "https://www.uoguide.com/index.php?title=Template:Template_Parameter&oldid=35862"