Template:Template Parameter

Revision as of 12:18, 2 October 2009 by Cogniac (Talk | contribs) (Progressing.)

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.