עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/API
action=help
(main | help)
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
הצגת עזרה עבור היחידות שצוינו.
פרמטרים:
- modules
עזרה של אילו יחידות להציג (ערכים של הפרמטרים action ו־format, או main). אפשר להגדיר תת־יחידות עם +.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- ברירת מחדל: main
- submodules
לכלול עזרה לתת־יחידות ליחידה שצוינה.
- סוג: בוליאני (פרטים)
- recursivesubmodules
לכלול עזרה לתת־יחידות באופן רקורסיבי.
- סוג: בוליאני (פרטים)
- wrap
לעטוף את הפלט במבנה תשובת API תקני.
- סוג: בוליאני (פרטים)
- toc
לכלול תוכן עניינים בפלט HTML.
- סוג: בוליאני (פרטים)
דוגמאות:
- עזרה ליחידה הראשית.
- api.php?action=help [פתיחה בארגז חול]
- עזרה עבור action=query וכל התת־מודולים שלו.
- api.php?action=help&modules=query&submodules=1 [פתיחה בארגז חול]
- כל העזרה בדף אחד.
- api.php?action=help&recursivesubmodules=1 [פתיחה בארגז חול]
- עזרה ליחידת העזרה עצמה.
- api.php?action=help&modules=help [פתיחה בארגז חול]
- עזרה לשתי תת־יחידות של שאילתה.
- api.php?action=help&modules=query+info|query+categorymembers [פתיחה בארגז חול]