Last modified on 26 July 2007, at 04:39

Template:Parm

|-
|{{{1}}}||{{{2}}}||{{{3}}}||


Template: Parm
Use on Template documentation pages
Use for A single parameter (see below)
Category template applies to page (none)

The {{parm}} parameter has been used four times in the table below, once for each row after the two heading rows.

Template Parameters
(See using templates).
Name Purpose Required? Comment
1 Parameter name yes
3 Purpose of the parameter yes
2 Normally yes or no to indicate whether use of the parameter is required yes see note A
4 Comment, including any default value no

NOTE A:

  • If a parameter has a default value (including an empty value), mark the "Required" column with "no", and explain the default (if not blank) in the "Comment" column.
  • If a parameter must be provided by the user but can be blank, mark this column with "yes", but see note B.
  • If a parameter must be provided by the user but cannot be blank, mark this section with "yes" and explain what's required in the comment column.

NOTE B:

If a field can be blank, make this a default value rather than expect the editor to provide an empty parameter. In the following example, the first two parameter have been provided (as "1" and blank respectively), but the remaining two parameters have not peen provided. Parameter 3 has no default value, so {{{3}}} shows instead. Parameter 4 has a blank default, so the column appears blank.

Example
Name Purpose Required? Comment
1 {{{3}}}