Pomocník API MediaWiki
Toto je automaticky generovaná dokumentačná stránka MediaWiki Action API.
action=help
(main | help)
- Zdroj: MediaWiki
- Licencia: GPL-2.0-or-later
Zobraziť pomocníka pre zadané moduly.
Konkrétne parametre:
K dispozícii sú aj ďalšie všeobecné parametre.
- modules
Moduly, pre ktoré sa má zobraziť pomocník (hodnoty parametrov action a format, alebo main). Podmoduly možno zadať pomocou +.
- Hodnoty oddeľte pomocou | alebo alternatívy.
- Maximálny počet hodnôt je 50 (500 pre klientov s povolenými vyššími limitmi).
- Predvolené: main
- submodules
Zahrnúť pomocníka pre podmoduly daného modulu.
- Typ: logická hodnota (boolean) (podrobnosti)
- recursivesubmodules
Zahrnúť pomocníka pre podmoduly rekurzívne.
- Typ: logická hodnota (boolean) (podrobnosti)
- wrap
Zabaliť výstup do štandardnej štruktúry odpovede API.
- Typ: logická hodnota (boolean) (podrobnosti)
- toc
Zahrnúť obsah do HTML výstupu.
- Typ: logická hodnota (boolean) (podrobnosti)
Príklady:
- Pomocník pre hlavný modul.
- api.php?action=help [otvoriť na pieskovisku]
- Pomocník pre action=query a všetky jeho podmoduly.
- api.php?action=help&modules=query&submodules=1 [otvoriť na pieskovisku]
- Celý pomocník na jednej stránke.
- api.php?action=help&recursivesubmodules=1&toc [otvoriť na pieskovisku]
- Pomocník pre samotný modul pomocníka.
- api.php?action=help&modules=help [otvoriť na pieskovisku]
- Pomocník pre dva podmoduly dotazu.
- api.php?action=help&modules=query+info|query+categorymembers [otvoriť na pieskovisku]