Nápověda k MediaWiki API
Toto je automaticky generovaná dokumentační stránka k MediaWiki API.
Dokumentace a příklady: https://www.mediawiki.org/wiki/API
action=help
(main | help)
- Zdroj: MediaWiki
- Licence: GPL-2.0-or-later
Zobrazuje nápovědu k uvedeným modulům.
Parametry:
- modules
Moduly, pro které se má zobrazit nápověda (hodnoty parametrů action a format anebo main). Submoduly lze zadávat pomocí +.
- Hodnoty oddělujte pomocí | nebo alternativou. Maximální počet hodnot je 50 (pro boty 500).
- Implicitní hodnota: main
- submodules
Zahrnout nápovědu pro podmoduly uvedeného modulu.
- Typ: boolean (podrobnosti)
- recursivesubmodules
Zahrnout nápovědu pro podmoduly rekurzivně.
- Typ: boolean (podrobnosti)
- wrap
Obalit výstup do standardní struktury API odpovědi.
- Typ: boolean (podrobnosti)
- toc
Zahrnout v HTML výstupu tabulku obsahu.
- Typ: boolean (podrobnosti)
Příklady:
- Nápověda k hlavnímu modulu
- api.php?action=help [otevřít v pískovišti]
- Help for action=query and all its submodules.
- api.php?action=help&modules=query&submodules=1 [otevřít v pískovišti]
- Veškerá nápověda na jedné stránce
- api.php?action=help&recursivesubmodules=1 [otevřít v pískovišti]
- Nápověda k samotnému modulu nápovědy
- api.php?action=help&modules=help [otevřít v pískovišti]
- Nápověda pro dva podmoduly query
- api.php?action=help&modules=query+info|query+categorymembers [otevřít v pískovišti]