Template:API-head

API-head
generator>API:generator .
Prefix	none
Required rights	none
Post only?	No
Generated help	Current

Template documentation

Usage

Displays a box providing more information about an API module.

See also {{ApiEx}} which transcludes the generated API documentation

Examples

API-head
Perform a full text search This module can be used as a <tvar
Prefix	sr
Required rights	none
Post only?	No
Generated help	Current
Version added	≥ 1.11

{{API-head
|version=1.11
|prefix=sr
|rrights=None
|postonly=No
|description=Perform a full text search
|generator=yes
}}

edit
generator>API:generator .
Prefix
Required rights	edit
Post only?	Yes
Generated help	Current
Version added	≥ 1.13

{{API-head
|module=edit
|version=1.13
|prefix=
|rrights=edit
|postonly=Yes
|description=
|query=no
}}

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