Template:ServicesApiParam

(Difference between revisions)

Jump to: navigation, search

Revision as of 17:50, 5 February 2013

Usage:

{{ServicesApiParam|name=Parameter Name|required={Required|Optional}|type={String|Integer|...}|comment=description}}

All fields are required.

@@ Line 2: / Line 2: @@
 __NOCACHE__
 <span id="script-info" style="display:none">
-name={{{name|Error, None Provided!}}}
+name={{{name|none}}}
-required={{{Required|Optional}}}
+required={{{required|none}}}
-type={{{type|Error, None Provided!}}}}}
+type={{{type|none}}}}}
-comment={{{comment|Error, None Provided!}}}
+comment={{{comment|none}}}
 </span>
-:<span style="color:SteelBlue">{{{name}}}</Span> ('''{{{required}}}''')
+:<span style="color:SteelBlue">{{{name|none}}}</Span> ('''{{{required|none}}}''')
-:: '''Parameter Type:''' {{{type}}}
+:: '''Parameter Type:''' {{{type|none}}}
-:: {{{comment}}}.
+:: {{{comment|none}}}.
 </includeonly>
 <noinclude>
 Usage:
-<pre>{{ServicesApiParam|name=Parameter Name|required|type={String|Integer|...}|comment=description}}</pre>
+<pre>{{ServicesApiParam|name=Parameter Name|required={Required|Optional}|type={String|Integer|...}|comment=description}}</pre>
-Name, type and command are required. If required isn't used, the method will be marked as Optional.
+All fields are required.
 </noinclude>