MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
prop=extracts (ex)
- This module requires read rights.
- Source: TextExtracts
- License: GPL-2.0+
Returns plain-text or limited HTML extracts of the given pages.
Parameters:
- exchars
How many characters to return. Actual text returned might be slightly longer.
- The value must be between 1 and 1,200.
- Type: integer
- exsentences
How many sentences to return.
- The value must be between 1 and 10.
- Type: integer
- exlimit
How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)
- No more than 20 (20 for bots) allowed.
- Type: integer or max
- 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, wiki, raw
- Default: wiki
- excontinue
When more results are available, use this to continue.
- Type: integer
Example:
- Get a 175-character extract
- api.php?action=query&prop=extracts&exchars=175&titles=Therion [open in sandbox]