Arbundi: 1 revision imported: Media wiki templates

2023-08-05T23:00:31Z

1 revision imported: Media wiki templates

← Older revision	Revision as of 01:00, 6 August 2023
(No difference)

commons>Shirayuki: Undo revision 5099858 by Baris6161TURK (talk): wrong markup

2022-03-07T21:06:20Z

Undo revision 5099858 by Baris6161TURK (talk): wrong markup

New page

<noinclude>
<languages />
</noinclude><includeonly>{{#if:{{{2|{{{description|}}}}}}
|<translate> <tvar|1><code {{#if:{{{required|}}}|style="font-weight:bold"}} {{#if:{{{id|{{{1|{{{name|}}}}}}}}}|id="{{{id|{{{1|{{{name}}}}}}}}}"}}>{{{1|{{{name|}}}}}}</code></>:</translate> {{{2|{{{description|}}}}}}
|<code {{#if:{{{required|}}}|style="font-weight:bold"}} {{#if:{{{id|{{{1|{{{name|}}}}}}}}}|id="{{{id|{{{1|{{{name}}}}}}}}}"}}>{{{1|{{{name|}}}}}}</code>
}}{{#if:{{{maxallowed|}}}
| <translate> No more than <tvar|1>{{{maxallowed}}}</> (<tvar|2>{{#if:{{{maxallowedbot|}}}|{{{maxallowedbot}}}|{{#switch:{{{maxallowed}}}|50=500|500=5000}}}}</> for bots) allowed.</translate>}}{{#if:{{{type|}}}| '''<translate> Type:</translate>''' {{{type}}}}}{{#if:{{{values|}}}| <translate> Possible values:</translate> {{{values}}}}}{{#if:{{{default|}}}| (<translate> Default:</translate> {{{default}}})}}{{#if:{{{version|}}}| {{MW version-inline|{{#switch:{{#if:{{{removed|}}}|R}}|={{{version}}}+|R={{{version}}}-{{{removed}}}}}}}
}}{{#if:{{{deprecated|}}}| {{deprecated-inline|1={{{deprecated}}}}}}}{{#if:{{{removed|}}}| {{removed-inline|{{{removed}}}}}}}</includeonly><noinclude>
{{Documentation|content=

:<translate> ''Consider replacing invocations of this template with Special:ApiHelp transclusion (<tvar|task>{{task|T89318}}</>), since filling in this template redundantly repeats API parameter documentation in source code.''</translate>

<translate>
== Usage == 


This template can be used to document API parameters.</translate>
<translate> Its intent is to harmonize the appearance of template parameters across all of the API pages.</translate>

{{Pre2|style=display:inline-block
|1=<nowiki>{{ApiParam
|</nowiki>''name=''<nowiki>
|</nowiki>''description=''<nowiki>
|required=
|maxallowed=
|maxallowedbot=
|type=
|values=
|default=
|version=
|deprecated=
|removed=
}}</nowiki>}}

{{(}}{{!}} class="wikitable sortable"
! colspan=2 {{!}} <translate> ApiParam parameters</translate>
{{!}}-
! <translate> Parameter Name</translate> !! <translate> Description</translate>
{{!}}-
{{!}} <code>'''name'''</code> ''<translate> (or first unnamed)</translate>'' {{!}}{{!}} <translate> The parameter name (required).</translate>
{{!}}-
{{!}} <code>description</code> ''<translate> (or second unnamed)</translate>'' {{!}}{{!}} <translate> A description of the parameter.</translate>
{{!}}-
{{!}} <code>required</code> {{!}}{{!}} <translate> Specify a value if the parameter is required.</translate> <translate> The name of the required parameter will be bolded.</translate>
{{!}}-
{{!}} <code>maxallowed</code> {{!}}{{!}} <translate> For pipe-separated values or numeric quantities, the maximum allowed.</translate>
{{!}}-
{{!}} <code>maxallowedbot</code> {{!}}{{!}} <translate> As above, for bots.</translate> <translate> If 50 or 500 is used for <code>maxallowed</code>, this will default to 500 or 5000, respectively.</translate>
{{!}}-
{{!}} <code>type</code> {{!}}{{!}} <translate> The data type of the parameter.</translate>
{{!}}-
{{!}} <code>values</code> {{!}}{{!}} <translate> A list of possible values for the parameter.</translate>
{{!}}-
{{!}} <code>default</code> {{!}}{{!}} <translate> The default value for the parameter.</translate>
{{!}}-
{{!}} <code>version</code> {{!}}{{!}} <translate> The version the parameter was introduced in.</translate> <translate> Use the plain MediaWiki version number only.</translate>
{{!}}-
{{!}} <code>deprecated</code> {{!}}{{!}} <translate> The version the parameter was deprecated in.</translate> <translate> Use the plain MediaWiki version number only.</translate>
{{!}}-
{{!}} <code>removed</code> {{!}}{{!}} <translate> The version the parameter was removed in.</translate> <translate> Use the plain MediaWiki version number only.</translate>
{{!}}{{)}}

<translate>
== Examples == 
</translate>
<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}}

<pre style="display:inline-block">*{{ApiParam|siprop|Which properties to get|default=general}}
**{{ApiParam|general|General site information}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}</pre>
*{{ApiParam|siprop|Which properties to get|default=general}}
**{{ApiParam|general|General site information}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}

<translate>
== See also == 
</translate>
* {{tl|Parameter}} – <translate> older version of <tvar|1>ApiParam</></translate>

}}
[[Category:Typing-aid templates{{#translation:}}]]
[[Category:Formatting templates{{#translation:}}]]
</noinclude>

Template:ApiParam - Revision history

Arbundi: 1 revision imported: Media wiki templates

commons>Shirayuki: Undo revision 5099858 by Baris6161TURK (talk): wrong markup