MediaWiki API ヘルプ

このページは自動生成された MediaWiki API の説明文書ページです。

action=help

(main | help)

指定したモジュールのヘルプを表示します。

パラメーター:

その他一般パラメーターが利用可能です。

modules: ヘルプを表示するモジュールです (action パラメーターおよび format パラメーターの値、または main)。+ を使用して下位モジュールを指定できます。; 複数の値は | または代わりの文字で区切ってください。; 値の最大値は 50（緩い制限が適用されるクライアントでは500）です。; 既定: main
submodules: 指定したモジュールの下位モジュールのヘルプを含めます。; 型: 真偽値 (詳細)
recursivesubmodules: 下位モジュールのヘルプを再帰的に含めます。; 型: 真偽値 (詳細)
wrap: Wrap the output in a standard API response structure.; 型: 真偽値 (詳細)
toc: HTML 出力に目次を含めます。; 型: 真偽値 (詳細)

例:

メインモジュールのヘルプ: 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 [サンドボックスで開く]