Template:ApiParam/de

Vorlagendokumentation

Consider replacing invocations of this template with Special:ApiHelp transclusion (task T89318), since filling in this template redundantly repeats API parameter documentation in source code.

Verwendung

This template can be used to document API parameters.

Its intent is to harmonize the appearance of template parameters across all of the API pages.

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

ApiParam-Parameter
Parametername	Beschreibung
name (or first unnamed)	The parameter name (required).
description (or second unnamed)	Eine Beschreibung des Parameters.
required	Specify a value if the parameter is required. The name of the required parameter will be bolded.
maxallowed	For pipe-separated values or numeric quantities, the maximum allowed.
maxallowedbot	As above, for bots. If 50 or 500 is used for maxallowed, this will default to 500 or 5000, respectively.
type	The data type of the parameter.
values	A list of possible values for the parameter.
default	Der Standardwert für den Parameter.
version	Die Version, wo der Parameter eingeführt wurde. Benutze nur die einfache MediaWiki-Versionsnummer.
deprecated	Die Version, wo der Parameter veraltet wurde. Benutze nur die einfache MediaWiki-Versionsnummer.
removed	Die Version, wo der Parameter entfernt wurde. Benutze nur die einfache MediaWiki-Versionsnummer.

Beispiele

*{{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. Nicht mehr als 50 (500 für bots) erlaubt.

*{{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 (Standard: general)
  • general: General site information
    • articlepath: $wgArticlePath 1.15+

Siehe auch

• {{Parameter }} – Ältere Version von ApiParam

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.