MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
action=help
(main | help)
- Source: MediaWiki
- License: GPL-2.0-or-later
Display help for the specified modules.
Parameters:
- modules
Modules to display help for (values of the action and format parameters, or main). Can specify submodules with a +.
- Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
- Default: main
- submodules
Include help for submodules of the named module.
- Type: boolean (details)
- recursivesubmodules
Include help for submodules recursively.
- Type: boolean (details)
- wrap
Wrap the output in a standard API response structure.
- Type: boolean (details)
- toc
Include a table of contents in the HTML output.
- Type: boolean (details)
Examples:
- Help for the main module.
- api.php?action=help [open in sandbox]
- Help for action=query and all its submodules.
- api.php?action=help&modules=query&submodules=1 [open in sandbox]
- All help in one page.
- api.php?action=help&recursivesubmodules=1 [open in sandbox]
- Help for the help module itself.
- api.php?action=help&modules=help [open in sandbox]
- Help for two query submodules.
- api.php?action=help&modules=query+info|query+categorymembers [open in sandbox]