Changes
Jump to navigation
Jump to search
Template:ApiParam/fr (view source)
Revision as of 19:47, 26 September 2019
, 19:47, 26 September 2019Updating to match new version of source page
<noinclude>
<languages />
</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|}}}| Pas plus de {{{maxallowed}}} valeurs autorisées ({{#if:{{{maxallowedbot|}}}|{{{maxallowedbot}}}|{{#switch:{{{maxallowed}}}|50=500|500=5000}}}} pour les robots).}}{{#if:{{{type|}}}| '''Type:''' {{{type}}}}}{{#if:{{{values|}}}| Valeurs possibles : {{{values}}}}}{{#if:{{{default|}}}| (Valeur par défaut: {{{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=
:''Envisagez le remplacement de l'appel de ce modèle par la transclusion de Special:ApiHelp ([[phab:T89318]]), puisque l'initialisation de ce modèle répète la documentation des paramètres de l'API dans le code source.''
== Utilisation ==
Ce modèle peut être utilisé pour documenter les paramètres de l'API.
Son but est d'harmoniser la présentation des paramètres de modèles au travers toutes les pages d'API.
{{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>Paramètres du modèle ApiParam</th></tr>
<tr><th>Nom du paramètre</th><th>Description</th></tr>
<tr><td><code>'''name'''</code> ''(ou le premier non nommé)''</td><td>Nom du paramètre (obligatoire).</td></tr>
<tr><td><code>description</code> ''(ou second non nommé)''</td><td>Description du paramètre</td></tr>
<tr><td><code>required</code></td><td>Spécifiez une valeur si le paramètre est obligatoire. Le nom du paramètre sera en gras.</td></tr>
<tr><td><code>maxallowed</code></td><td>Maximum autorisé (pour les valeurs séparées par la barre verticale ou pour des quantités numériques)</td></tr>
<tr><td><code>maxallowedbot</code></td><td>Comme ci-dessus, pour les robots. Si 50 ou 500 est utilisé pour <code>maxallowed</code>, ceci vaudra respectivement 500 ou 5000 par défaut.</td></tr>
<tr><td><code>type</code></td><td>Le type de données pour le paramètre.</td></tr>
<tr><td><code>values</code></td><td>Une liste des valeurs possibles pour le paramètre.</td></tr>
<tr><td><code>default</code></td><td>Valeur par défaut pour le paramètre.</td></tr>
<tr><td><code>version</code></td><td>Version dans laquelle le paramètre a été introduit. Utilise uniquement le numéro de version brut de MediaWiki.</td></tr>
<tr><td><code>deprecated</code></td><td>Version dans laquelle le paramètre a été déclaré obsolète. Utiliser uniquement le numéro de version brut de MediaWiki.</td></tr>
<tr><td><code>removed</code></td><td>Version dans laquelle le paramètre a été supprimé. Utiliser uniquement le numéro de version brut de MediaWiki.</td></tr>
</table>
== Exemples ==
<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}}
== Voir aussi ==
* {{tl|Parameter}} – ancienne version de ApiParam
}}
[[Category:Typing-aid templates{{#translation:}}]]
[[Category:Formatting templates{{#translation:}}]]
</noinclude>
<languages />
</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|}}}| Pas plus de {{{maxallowed}}} valeurs autorisées ({{#if:{{{maxallowedbot|}}}|{{{maxallowedbot}}}|{{#switch:{{{maxallowed}}}|50=500|500=5000}}}} pour les robots).}}{{#if:{{{type|}}}| '''Type:''' {{{type}}}}}{{#if:{{{values|}}}| Valeurs possibles : {{{values}}}}}{{#if:{{{default|}}}| (Valeur par défaut: {{{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=
:''Envisagez le remplacement de l'appel de ce modèle par la transclusion de Special:ApiHelp ([[phab:T89318]]), puisque l'initialisation de ce modèle répète la documentation des paramètres de l'API dans le code source.''
== Utilisation ==
Ce modèle peut être utilisé pour documenter les paramètres de l'API.
Son but est d'harmoniser la présentation des paramètres de modèles au travers toutes les pages d'API.
{{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>Paramètres du modèle ApiParam</th></tr>
<tr><th>Nom du paramètre</th><th>Description</th></tr>
<tr><td><code>'''name'''</code> ''(ou le premier non nommé)''</td><td>Nom du paramètre (obligatoire).</td></tr>
<tr><td><code>description</code> ''(ou second non nommé)''</td><td>Description du paramètre</td></tr>
<tr><td><code>required</code></td><td>Spécifiez une valeur si le paramètre est obligatoire. Le nom du paramètre sera en gras.</td></tr>
<tr><td><code>maxallowed</code></td><td>Maximum autorisé (pour les valeurs séparées par la barre verticale ou pour des quantités numériques)</td></tr>
<tr><td><code>maxallowedbot</code></td><td>Comme ci-dessus, pour les robots. Si 50 ou 500 est utilisé pour <code>maxallowed</code>, ceci vaudra respectivement 500 ou 5000 par défaut.</td></tr>
<tr><td><code>type</code></td><td>Le type de données pour le paramètre.</td></tr>
<tr><td><code>values</code></td><td>Une liste des valeurs possibles pour le paramètre.</td></tr>
<tr><td><code>default</code></td><td>Valeur par défaut pour le paramètre.</td></tr>
<tr><td><code>version</code></td><td>Version dans laquelle le paramètre a été introduit. Utilise uniquement le numéro de version brut de MediaWiki.</td></tr>
<tr><td><code>deprecated</code></td><td>Version dans laquelle le paramètre a été déclaré obsolète. Utiliser uniquement le numéro de version brut de MediaWiki.</td></tr>
<tr><td><code>removed</code></td><td>Version dans laquelle le paramètre a été supprimé. Utiliser uniquement le numéro de version brut de MediaWiki.</td></tr>
</table>
== Exemples ==
<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}}
== Voir aussi ==
* {{tl|Parameter}} – ancienne version de ApiParam
}}
[[Category:Typing-aid templates{{#translation:}}]]
[[Category:Formatting templates{{#translation:}}]]
</noinclude>