Template:ApiParam/fr

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Template:ApiParam and the translation is 100% complete.
Other languages:
English • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎русский • ‎العربية • ‎فارسی • ‎中文 • ‎日本語
Documentation du modèle
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.

{{ApiParam
|''name=''
|''description=''
|required=
|maxallowed=
|maxallowedbot=
|type=
|values=
|default=
|version=
|deprecated=
|removed=
}}
Paramètres du modèle ApiParam
Nom du paramètreDescription
name (ou le premier non nommé)Nom du paramètre (obligatoire).
description (ou second non nommé)Description du paramètre
requiredSpécifiez une valeur si le paramètre est obligatoire. Le nom du paramètre sera en gras.
maxallowedMaximum autorisé (pour les valeurs séparées par la barre verticale ou pour des quantités numériques)
maxallowedbotComme ci-dessus, pour les robots. Si 50 ou 500 est utilisé pour maxallowed, ceci vaudra respectivement 500 ou 5000 par défaut.
typeLe type de données pour le paramètre.
valuesUne liste des valeurs possibles pour le paramètre.
defaultValeur par défaut pour le paramètre.
versionVersion dans laquelle le paramètre a été introduit. Utilise uniquement le numéro de version brut de MediaWiki.
deprecatedVersion dans laquelle le paramètre a été déclaré obsolète. Utiliser uniquement le numéro de version brut de MediaWiki.
removedVersion dans laquelle le paramètre a été supprimé. Utiliser uniquement le numéro de version brut de MediaWiki.

Exemples

*{{ApiParam|rcid|One or more recent changes IDs from  which to add or remove the tag.|maxallowed=50}}
  • rcid: One or more recent changes IDs from which to add or remove the tag. Pas plus de 50 valeurs autorisées (500 pour les robots).
*{{ApiParam|siprop|Which properties to get|default=general}}
**{{ApiParam|general|General site information}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}
  • siprop: Which properties to get (Valeur par défaut: general)

Voir aussi

  • {{Parameter}} – ancienne version de ApiParam