API:Cправка

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page API:Help and the translation is 100% complete.
Other languages:
English • ‎dansk • ‎polski • ‎русский • ‎ไทย • ‎日本語

Отображает справку для указанных модулей, опционально включая прямые подмодули или рекурсивные подмодули.

Параметры

  • modules: Модули для отображения справки. Можно указать подмодули с помощью +. Возможные значения: параметры action и format в запросе или main (По умолчанию: main) 1.17+
  • submodules: Включить справку для подмодулей заданного модуля. 1.25+
  • recursivesubmodules: Рекурсивно включить справку для подмодулей. 1.25+
  • wrap: Обернуть вывод в стандартную структуру API-ответа. 1.25+
  • toc: Включить содержание в вывод HTML. 1.25+
  • querymodules: Список имен модулей запросов (значение параметра prop=, meta= или list=). Начиная с 1.21, используйте вместо этого query+value. (устарело  в 1.21) (удалено  в 1.25)

Примеры

Получение справки для 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)