模板:ApiParam/fr:修订间差异
外观
wiki>FuzzyBot Updating to match new version of source page |
小 导入1个版本 |
(没有差异)
| |
2025年12月16日 (二) 16:39的最新版本
模板文档
- Envisagez le remplacement de l'appel de ce modèle par la transclusion de Special:ApiHelp (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ètre | Description |
name (ou le premier non nommé) |
Nom du paramètre (obligatoire). |
description (ou second non nommé |
Description du paramètre |
required |
Spécifiez une valeur si le paramètre est obligatoire. Le nom du paramètre sera en gras. |
maxallowed |
Maximum autorisé (pour les valeurs séparées par la barre verticale ou pour des quantités numériques) |
maxallowedbot |
Comme ci-dessus, pour les robots. Si 50 ou 500 est utilisé pour maxallowed, ceci vaudra respectivement 500 ou 5000 par défaut.
|
type |
Le type de données pour le paramètre. |
values |
Une liste des valeurs possibles pour le paramètre. |
default |
Valeur par défaut pour le paramètre. |
version |
Version dans laquelle le paramètre a été introduit. Utilise uniquement le numéro de version brut de MediaWiki. |
deprecated |
Version dans laquelle le paramètre a été déclaré obsolète. Utiliser uniquement le numéro de version brut de MediaWiki. |
removed |
Version 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}}
- <translate> <tvar name=1>
rcid</tvar>:</translate> One or more recent changes IDs from which to add or remove the tag. <translate> No more than <tvar name=1>50</tvar> (<tvar name=2>500</tvar> for bots) allowed.</translate>
*{{ApiParam|siprop|Which properties to get|default=general}}
**{{ApiParam|general|General site information}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}
- <translate> <tvar name=1>
siprop</tvar>:</translate> Which properties to get (<translate> Default:</translate> general)- <translate> <tvar name=1>
general</tvar>:</translate> General site information- <translate> <tvar name=1>
articlepath</tvar>:</translate> $wgArticlePath 1.15+
- <translate> <tvar name=1>
- <translate> <tvar name=1>
Voir aussi
- {{Parameter}} – ancienne version de ApiParam