Senik: 1 версия импортирована

2020-02-25T12:42:33Z

1 версия импортирована

Template>Wladek92: keep examples in english for coherence of the topic

2019-09-26T19:46:41Z

keep examples in english for coherence of the topic

Новая страница

<noinclude>
<languages />
</noinclude><includeonly>{{#switch:<translate></translate>| =<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|}}}| <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}}}}}}}| #default={{#invoke:Template translation|renderTranslatedTemplate|template=Template:ApiParam|noshift=1}}}}</includeonly><noinclude>
{{Documentation|content=

:<translate> ''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.''</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>}}

<table class="wikitable sortable">
<tr><th colspan=2><translate> ApiParam parameters</translate></th></tr>
<tr><th><translate> Parameter Name</translate></th><th><translate> Description</translate></th></tr>
<tr><td><code>'''name'''</code> ''<translate> (or first unnamed)</translate>''</td><td><translate> The parameter name (required).</translate></td></tr>
<tr><td><code>description</code> ''<translate> (or second unnamed</translate>)''</td><td><translate> A description of the parameter.</translate></td></tr>
<tr><td><code>required</code></td><td><translate> Specify a value if the parameter is required.</translate> <translate> The name of the required parameter will be bolded.</translate></td></tr>
<tr><td><code>maxallowed</code></td><td><translate> For pipe-separated values or numeric quantities, the maximum allowed.</translate></td></tr>
<tr><td><code>maxallowedbot</code></td><td><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></td></tr>
<tr><td><code>type</code></td><td><translate> The data type of the parameter.</translate></td></tr>
<tr><td><code>values</code></td><td><translate> A list of possible values for the parameter.</translate></td></tr>
<tr><td><code>default</code></td><td><translate> The default value for the parameter.</translate></td></tr>
<tr><td><code>version</code></td><td><translate> The version the parameter was introduced in.</translate> <translate> Use the plain MediaWiki version number only.</translate></td></tr>
<tr><td><code>deprecated</code></td><td><translate> The version the parameter was deprecated in.</translate> <translate> Use the plain MediaWiki version number only.</translate></td></tr>
<tr><td><code>removed</code></td><td><translate> The version the parameter was removed in.</translate> <translate> Use the plain MediaWiki version number only.</translate></td></tr>
</table>

<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>

← Предыдущая	Версия 12:42, 25 февраля 2020
(нет различий)

Шаблон:ApiParam - История изменений

Senik: 1 версия импортирована

Template>Wladek92: keep examples in english for coherence of the topic