راهنمای واسط برنامه‌نویسی کاربردی مدیاویکی

این یک صفحهٔ مستندات برای واسط برنامه‌نویسی کاربردی مدیاویکی است که به‌طور خودکار ایجاد شده‌است.

action=help

(main | help)

نمایش راهنمای پودمان‌های مشخص‌شده.

پارامترها:

modules: پودمان‌های مورد نظر برای نمایش راهنمای آن‌ها (مقدارهای پارامترهای action و format، یا main). زیرپودمان‌ها با استفاده از یک + قابل تعیین هستند.; Separate values with | or alternative.; حداکثر تعداد مقدارها ۵۰ است (۵۰۰ برای متقضایانی که مجوز محدودیت‌های بالاتر را دارند).; پیش‌فرض: main
submodules: گنجاندن راهنمای زیرپودمان‌های پودمان ذکر شده.; نوع: بولی (جزئیات)
recursivesubmodules: گنجاندن راهنمای زیرپودمان‌ها به‌صورت بازگشتی.; نوع: بولی (جزئیات)
wrap: بسته‌بندی خروجی در یک ساختار استاندارد پاسخ واسط برنامه‌نویسی.; نوع: بولی (جزئیات)
toc: گنجاندن فهرست محتویات در خروجی اچ‌تی‌ام‌ال.; نوع: بولی (جزئیات)

نمونه‌ها:

راهنما برای پودمان اصلی.: 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 [باز کردن در صفحهٔ تمرین]