MediaWiki API ヘルプ
このページは自動生成された MediaWiki API の説明文書ページです。
説明文書と例: https://www.mediawiki.org/wiki/API
action=help
(main | help)
- Source: MediaWiki
- License: GPL-2.0-or-later
指定したモジュールのヘルプを表示します。
パラメーター:
- modules
ヘルプを表示するモジュールです (action パラメーターおよび format パラメーターの値、または main)。+ を使用して下位モジュールを指定できます。
- 複数の値は | もしくは代わりの文字で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
- 既定値: main
- submodules
指定したモジュールの下位モジュールのヘルプを含めます。
- Type: boolean (details)
- recursivesubmodules
下位モジュールのヘルプを再帰的に含めます。
- Type: boolean (details)
- wrap
Wrap the output in a standard API response structure.
- Type: boolean (details)
- toc
HTML 出力に目次を含めます。
- Type: boolean (details)
例:
- メイン モジュールのヘルプ
- api.php?action=help [サンドボックスで開く]
- action=query とそのすべての下位モジュールに関するヘルプ。
- api.php?action=help&modules=query&submodules=1 [サンドボックスで開く]
- すべてのヘルプを1つのページに
- api.php?action=help&recursivesubmodules=1 [サンドボックスで開く]
- ヘルプ モジュール自身のヘルプ
- api.php?action=help&modules=help [サンドボックスで開く]
- 2つの下位モジュールのヘルプ
- api.php?action=help&modules=query+info|query+categorymembers [サンドボックスで開く]