Difference between revisions of "Template:ApiParam"
Jump to navigation
Jump to search
Template documentation
Joelmartin (talk | contribs) m (1 revision imported) |
Joelmartin (talk | contribs) m (Text replacement - "<tvar|2>" to "") |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
<languages /> | <languages /> | ||
| − | </noinclude><includeonly>{{#switch: | + | </noinclude><includeonly>{{#switch:<!-- |
-->| =<!-- | -->| =<!-- | ||
| − | --><code {{#if:{{{required|}}}|style="font-weight:bold"}} {{#if:{{{id|{{{1|{{{name|}}}}}}}}}|id="{{{id|{{{1|{{{name}}}}}}}}}"}}>{{{1|{{{name|}}}}}}</code>{{#if:{{{2|{{{description|}}}}}}|: {{{2|{{{description|}}}}}}}}{{#if:{{{maxallowed|}}}|  | + | --><code {{#if:{{{required|}}}|style="font-weight:bold"}} {{#if:{{{id|{{{1|{{{name|}}}}}}}}}|id="{{{id|{{{1|{{{name}}}}}}}}}"}}>{{{1|{{{name|}}}}}}</code>{{#if:{{{2|{{{description|}}}}}}|: {{{2|{{{description|}}}}}}}}{{#if:{{{maxallowed|}}}|  No more than {{{maxallowed}}} ({{#if:{{{maxallowedbot|}}}|{{{maxallowedbot}}}|{{#switch:{{{maxallowed}}}|50=500|500=5000}}}} for bots) allowed.}}{{#if:{{{type|}}}| ''' Type:''' {{{type}}}}}{{#if:{{{values|}}}|  Possible values: {{{values}}}}}{{#if:{{{default|}}}| ( Default: {{{default}}})}}{{#if:{{{version|}}}| {{MW version-inline|{{#switch:{{#if:{{{removed|}}}|R}} |
|={{{version}}}+ | |={{{version}}}+ | ||
|R={{{version}}}-{{{removed}}} | |R={{{version}}}-{{{removed}}} | ||
| Line 12: | Line 12: | ||
{{Documentation|content= | {{Documentation|content= | ||
| − | : | + | : ''Consider replacing invocations of this template with Special:ApiHelp transclusion (<tvar|task>[[phab:T89318]]), since filling in this template redundantly repeats API parameter documentation in source code.'' |
| + | |||
| + | |||
| + | == Usage == | ||
| + | |||
| + | |||
| + | This template can be used to document API parameters. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Its intent is to harmonize the appearance of template parameters across all of the API pages. | Its intent is to harmonize the appearance of template parameters across all of the API pages. | ||
| − | + | ||
{{Pre2|style=display:inline-block | {{Pre2|style=display:inline-block | ||
| Line 40: | Line 40: | ||
<table class="wikitable sortable"> | <table class="wikitable sortable"> | ||
| − | <tr><th colspan=2 | + | <tr><th colspan=2> ApiParam parameters</th></tr> |
| − | <tr><th | + | <tr><th> Parameter Name</th><th> Description</th></tr> |
| − | <tr><td><code>'''name'''</code> '' | + | <tr><td><code>'''name'''</code> '' (or first unnamed)''</td><td> The parameter name (required).</td></tr> |
| − | <tr><td><code>description</code> '' | + | <tr><td><code>description</code> '' (or second unnamed)''</td><td> A description of the parameter.</td></tr> |
| − | <tr><td><code>required</code></td><td | + | <tr><td><code>required</code></td><td> Specify a value if the parameter is required. The name of the required parameter will be bolded.</td></tr> |
| − | <tr><td><code>maxallowed</code></td><td | + | <tr><td><code>maxallowed</code></td><td> For pipe-separated values or numeric quantities, the maximum allowed.</td></tr> |
| − | <tr><td><code>maxallowedbot</code></td><td | + | <tr><td><code>maxallowedbot</code></td><td> As above, for bots. If 50 or 500 is used for <code>maxallowed</code>, this will default to 500 or 5000, respectively.</td></tr> |
| − | <tr><td><code>type</code></td><td | + | <tr><td><code>type</code></td><td> The data type of the parameter.</td></tr> |
| − | <tr><td><code>values</code></td><td | + | <tr><td><code>values</code></td><td> A list of possible values for the parameter.</td></tr> |
| − | <tr><td><code>default</code></td><td | + | <tr><td><code>default</code></td><td> The default value for the parameter.</td></tr> |
| − | <tr><td><code>version</code></td><td | + | <tr><td><code>version</code></td><td> The version the parameter was introduced in. Use the plain MediaWiki version number only.</td></tr> |
| − | <tr><td><code>deprecated</code></td><td | + | <tr><td><code>deprecated</code></td><td> The version the parameter was deprecated in. Use the plain MediaWiki version number only.</td></tr> |
| − | <tr><td><code>removed</code></td><td | + | <tr><td><code>removed</code></td><td> The version the parameter was removed in. Use the plain MediaWiki version number only.</td></tr> |
</table> | </table> | ||
| − | + | ||
| − | == Examples == | + | == Examples == |
| − | + | ||
<pre style="display:inline-block">*{{ApiParam|rcid|One or more recent changes IDs from which to add or remove the tag.|maxallowed=50}}</pre> | <pre style="display:inline-block">*{{ApiParam|rcid|One or more recent changes IDs from which to add or remove the tag.|maxallowed=50}}</pre> | ||
*{{ApiParam|rcid|One or more recent changes IDs from which to add or remove the tag.|maxallowed=50}} | *{{ApiParam|rcid|One or more recent changes IDs from which to add or remove the tag.|maxallowed=50}} | ||
| Line 68: | Line 68: | ||
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}} | ***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}} | ||
| − | + | ||
| − | == See also == | + | == See also == |
| − | + | ||
| − | * {{tl|Parameter}} – | + | * {{tl|Parameter}} – older version of ApiParam |
}} | }} | ||
| − | [[Category:Typing-aid templates | + | [[Category:Typing-aid templates]] |
| − | [[Category:Formatting templates | + | [[Category:Formatting templates]] |
</noinclude> | </noinclude> | ||
Latest revision as of 19:19, 21 December 2019
Template documentation- Consider replacing invocations of this template with Special:ApiHelp transclusion (<tvar