Template:Api help/en

The following documentation is the output of Special:ApiHelp, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).

Template documentation

This transcludes Special:ApiHelp/module-name and explains what's going on.

Usage

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Api help

This transcludes the API help page from “Special:ApiHelp” with a message box.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
API method name	`1`	The name of the API method. You can reference query submodules by using “module”+“submodule” (e.g.: “query+extracts”). Auto value `{{subst:lc:{{subst:PAGENAME}}}}`	String	required
Frame	`frame`	If set, add a light frame around the generated documentation. Auto value `yes`	Boolean	optional

Sample

{{Api help|query+extracts}} produces

The following documentation is the output of Special:ApiHelp/query+extracts, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).

prop=extracts (ex)

(main | query | extracts)

This module requires read rights.
Source: TextExtracts
License: GPL-2.0-or-later

Returns plain-text or limited HTML extracts of the given pages.

https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:TextExtracts#API

Specific parameters:

Other general parameters are available.

exchars

How many characters to return. Actual text returned might be slightly longer.

Type: integer

The value must be between 1 and 1,200.

exsentences

How many sentences to return.

Type: integer

The value must be between 1 and 10.

exlimit

How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)

Type: integer or max

The value must be between 1 and 20.

Default: 20

exintro

Return only content before the first section.

Type: boolean (details)

explaintext

Return extracts as plain text instead of limited HTML.

Type: boolean (details)

exsectionformat

How to format sections in plaintext mode:

plain: No formatting.
wiki: Wikitext-style formatting (== like this ==).
raw: This module's internal representation (section titles prefixed with <ASCII 1><ASCII 2><section level><ASCII 2><ASCII 1>).

One of the following values: plain, raw, wiki

Default: wiki

excontinue

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

Type: integer

Example:

Get a 175-character extract: api.php?action=query&prop=extracts&exchars=175&titles=Therion [open in sandbox]

You can't transclude the help of multiple API modules at once