nsTeam2RO, nsTeam2RW, nsTeam2_talkRO, nsTeam2_talkRW
13,254
edits
Changes
Jump to navigation
Jump to search
Line 5:
Line 5: − + − + − + + + + + + + + + + + + + + + +
Change documentation
The <nowiki>{{parm}}</nowiki> parameter has been used four times in the table below, once for each row after the two heading rows.
The <nowiki>{{parm}}</nowiki> parameter has been used four times in the table below, once for each row after the two heading rows.
{{parms2|
{{parms2|
{{parm2|1|parameter name|no|}}
{{parm2|1|Parameter name|yes|}}
{{parm2|3|Purpose of the parameter|no}}
{{parm2|3|Purpose of the parameter|yes}}
{{parm2|2|''yes'' or ''no'' to indicate whether use of the parameter is required|no}}
{{parm2|2|Normally ''yes'' or ''no'' to indicate whether use of the parameter is required|yes|see note A}}
{{parm2|4|Comment, including any default value|no}}
{{parm2|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.
{| class="wikitable"
!colspan=4|Example
|-
|{{!}}'''Name'''{{!}}{{!}}'''Purpose'''{{!}}{{!}}'''Required?'''{{!}}{{!}}'''Comment'''
{{Parm2|1|}}
|}
</noinclude>
</noinclude>