Template:ApiParam/nl

Template documentation

Overweeg aanroepen van dit sjabloon te vervangen door Special:ApiHelp transclusie (<translate> task <tvar name=1>T89318</tvar></translate>), omdat het invullen van dit sjabloon redundant API parameter documentatie in de broncode plaatst.

Gebruik

Dit sjabloon kan gebruikt worden om de API parameters te documenteren. De bedoeling is om het uiterlijk van de sjabloonparameters gelijk te maken op alle API-pagina's.

{{ApiParam
|name=
|description=
|required=
|maxallowed=
|maxallowedbot=
|type=
|values=
|default=
|version=
|deprecated=
|removed=
}}

ApiParam parameters
Parameternaam	Beschrijving
`name` (of eerste onbenoemde)	De parameternaam (verplicht).
`description` (of tweede onbenoemde)	Een beschrijving van de parameter.
`required`	Specificeer een waarde als de parameter verplicht is. De naam van een verplichte parameter is vet.
`maxallowed`	Voor met een 'pipe' gescheiden waarden of numerieke hoeveelheden, de maximale waarde.
`maxallowedbot`	Als boven, voor bots. Als 50 of 500 wordt gebruikt voor `maxallowed`, dan wordt dat resp. 500 en 5000.
`type`	Het type van de parameter.
`values`	Een lijst met mogelijke waarden van de parameter.
`default`	De standaardwaarde van de parameter.
`version`	De versie waarin de parameter is toegevoegd. Gebruik alleen het MediaWiki versienummer.
`deprecated`	De versie waarin de parameter is ontraden. Gebruik alleen het MediaWiki versienummer.
`removed`	De versie waarin de parameter is verwijderd. Gebruik alleen het MediaWiki versienummer.

Voorbeelden

*{{ApiParam|rcid|One or more recent changes IDs from  which to add or remove the tag.|maxallowed=50}}

<translate> <tvar <translate> No more than <tvar

*{{ApiParam|siprop|Which properties to get|default=general}}
**{{ApiParam|general|General site information}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}

<translate> <tvar1>{{{maxallowed}}}</> (<tvar (<translate> Default:</translate> general)
- <translate> <tvar1>{{{maxallowed}}}</> (<tvar
  - <translate> <tvar1>{{{maxallowed}}}</> (<tvar 1.15+

Zie ook

{{Parameter }} – oudere versies van ApiParam