EnduranceWiki: Created page with "{{Template Overview |usedon=template |purpose=explain a parameter's function and usage |template={{Template Parameter |name= |usage= |takes= |denotes= |generates= |defaultvalue= |anonymous= |othernotes= |validvalues= }} |category=Information }} {{Template Parameter |name=name |usage=mandatory |takes=a string |denotes=the name of the parameter |generates=the parameter's section header, as well as to display the parameter's name in the descripti..."

2025-11-15T20:09:20Z

Created page with "<noinclude>{{Template Overview |usedon=template |purpose=explain a parameter's function and usage |template=<nowiki>{{Template Parameter |name= |usage= |takes= |denotes= |generates= |defaultvalue= |anonymous= |othernotes= |validvalues= }}</nowiki> |category=Information }} {{Template Parameter |name=name |usage=mandatory |takes=a string |denotes=the name of the parameter |generates=the parameter's section header, as well as to display the parameter's name in the descripti..."

New page

<noinclude>{{Template Overview
|usedon=template
|purpose=explain a parameter's function and usage
|template=<nowiki>{{Template Parameter
|name=
|usage=
|takes=
|denotes=
|generates=
|defaultvalue=
|anonymous=
|othernotes=
|validvalues=
}}</nowiki>
|category=Information
}}
{{Template Parameter
|name=name
|usage=mandatory
|takes=a string
|denotes=the name of the parameter
|generates=the parameter's section header, as well as to display the parameter's name in the description
|validvalues=Any string.
}}
{{Template Parameter
|name=usage
|takes=a string
|denotes=whether the use of the parameter is mandatory or optional
|generates=the "Usage" bullet point
|defaultvalue=Optional
|othernotes=The value of "Optional" will also be displayed if a value is supplied that is not "mandatory."
|validvalues="mandatory"
}}
{{Template Parameter
|name=takes
|usage=mandatory
|takes=a string or strings
|denotes=what type of values the parameter takes in
|generates=the middle of the first sentence in the parameter's "Description" bullet point
|validvalues=Any string or strings.
}}
{{Template Parameter
|name=denotes
|usage=mandatory
|takes=a string or strings
|denotes=what the value passed to the parameter corresponds to
|generates=the end of the first sentence in the parameter's "Description" bullet point
|validvalues=Any string or strings.
}}
{{Template Parameter
|name=generates
|usage=mandatory
|takes=a string or strings
|denotes=what the parameter's data is used for
|generates=the second sentence in the parameter's "Description" bullet point
|validvalues=Any string or strings.
}}
{{Template Parameter
|name=defaultvalue
|takes=a string or strings
|denotes=what will be displayed if a parameter that has a default value is left blank or omitted
|generates=a sentence reading "If this parameter is left blank or omitted, a default value of {{Monospace|defaultvalue}} is displayed." after the sentence generated by {{Monospace|generates}}
|validvalues=Any string or strings.
}}
{{Template Parameter
|name=anonymous
|takes=the value "true"
|denotes=that the only parameter in the template is an anonymous numbered parameter
|generates=a sentence indicating this fact
|validvalues="true"
}}
{{Template Parameter
|name=othernotes
|takes=a string or strings
|denotes=any other relevant information about the parameter
|generates=a sentence or sentences at the end of the "Description" bullet point
|validvalues=Any string or strings.
}}
{{Template Parameter
|name=validvalues
|usage=mandatory
|takes=a string or strings
|denotes=any and all values that are valid to be passed to the parameter
|generates=the "Valid Value(s)" bullet point
|validvalues=Any string or strings.
}}
</noinclude><includeonly>==={{{name}}}===
* '''Usage:''' {{#ifeq: {{{usage|}}} | mandatory | Mandatory | Optional}}
* '''Description:''' The {{Monospace|{{{name}}}}} parameter takes {{{takes}}} denoting {{{denotes}}}. This is used to generate {{{generates}}}. {{#if: {{{defaultvalue|}}} | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: {{{anonymous|}}} | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using [[{{FULLPAGENAME}}]]. }} }} {{#if: {{{othernotes|}}} | {{{othernotes}}} }}
* '''Valid Value(s):''' {{{validvalues}}}</includeonly>

Template:Template Parameter - Revision history