Template:ApiParam/nl

This page is a translated version of the page Template:ApiParam and the translation is 100% complete.
Template documentation
Overweeg aanroepen van dit sjabloon te vervangen door Special:ApiHelp transclusie (taak T89318), 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|Een of meer recente wijzigingen zorgden voor andere ID's voor het toevoegen / verwijderen van de tag.|maxallowed=50}}
  • rcid: Een of meer recente wijzigingen zorgden voor andere ID's voor het toevoegen / verwijderen van de tag. Niet meer dan 50 (500 voor bots) toegestaan.
*{{ApiParam|siprop|Welke eigenschappen op te halen|default=general}}
**{{ApiParam|general|Algemene informatie over de website}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}
  • siprop: Welke eigenschappen op te halen (Standaardwaarde: general)
    • general: Algemene informatie over de website

Zie ook