API:Help

From MediaWiki.org
Jump to: navigation, search
Language:Project:Language policy English  • polski
Tools clipart.png This page is part of the MediaWiki action API documentation.
MediaWiki APIsAPI:Main page

MediaWiki action API

v · d · e

Displays help for the specified modules, optionally including direct submodules or recursive submodules.

Parameters[edit]

  • modules: Modules to display help for. Can specify submodules with a +. Possible values: the action and format parameters in a query, or main. (Default: main) 1.17+
  • submodules: Include help for submodules of the named module. 1.25+
  • recursivesubmodules: Include help for submodules recursively. 1.25+
  • wrap: Wrap the output in a standard API response structure. 1.25+
  • toc: Include a table of contents in the HTML output. 1.25+
  • querymodules: List of query module names (value of prop=, meta= or list= parameter). From 1.21 forward, use query+value instead. (Deprecated in 1.21) (Removed in 1.25)

Examples[edit]

Get help for action=query&meta=tokens.




action=help

(main | help)

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)