Template:Parameter

  • {{{1}}} — {{{2}}}

Purpose

this is a really basic template used to quickly format descriptions for parameters used in the descriptions of other templates. Most cases it is used in conjunction with Desc.

Usage

To use this template, type:     {{Parameter| Parameter Name | Parameter Description | Parameter Required/Optional | Default Value (Optional) }}

  • Parameter Name — This is the name of the parameter in question.
  • Parameter Description — The description of the parameter.
  • Parameter Required/Optional — Whether or not the parameter is optional or required. (Optional)
  • Default Value — If an optional parameter has a default value, explain it here. (Optional)