Template:ApiParam/ar

توثيق القالب

يرجى التفكير جديا في رفع استدعاءات هذا القالب ووضع مكانها حالات ضم Special:ApiHelp (مهمة T89318) منذ أن ملء متغيرات هذا القالب يكرر بلا داعي توثيق متغيرات واجهة برمجة التطبيقات في النص المصدر.

الاستخدام

يمكن استخدام هذا القالب في توثيق متغيرات واجهة برمجة التطبيقات. الغرض منه هو توحيد هيئة قوالب المتغيرات على كافة صفحات واجهة برمجة التطبيقات.

{{ApiParam
|name=
|description=
|required=
|maxallowed=
|maxallowedbot=
|type=
|values=
|default=
|version=
|deprecated=
|removed=
}}

متغيرات ApiParam
اسم المتغير	بيان
name (أو أول متغير غير مسمى)	اسم المتغير (إلزامي):
description (أو ثاني متغير غير مسمى	بيان المتغير.
required	حدد قيمة لو كان المتغير مطلوبا. اسم المتغير المطلوب سوف يكون بخط أسود عريض.
maxallowed	لأغراض القيم المقسمة باستخدام شريط رأسي أو الكميات المكونة من أرقام، ما هو الحد الأقصى.
maxallowedbot	كما سلف، للبوتات. لو استخدمت 50 أو 500 لأغراض maxallowed، سوف تصبح القيمة الافتراضية هي 500 أو 5000 على التوالي.
type	نوع بيانات المتغير.
values	قائمة بالقيم المحتملة للمتغير.
default	القيمة الافتراضية للمتغير.
version	الإصدار الذي أضيف له هذا المتغير. استخدم رقم إصدار برمجيات ميدياويكي الصرف لا غير.
deprecated	الإصدار الذي أصبح فيه المتغير متقادما. استخدم رقم إصدار برمجيات ميدياويكي الصرف لا غير.
removed	الإصدار الذي رفع منه هذا المتغير. استخدم رقم إصدار برمجيات ميدياويكي الصرف لا غير.

أمثلة

*{{ApiParam|rcid|معرّف أحدث تغييرات واحد أو أكثر الذي منه يمكن إضافة الوسم أو إزالته.|maxallowed=50}}

• rcid: معرّف أحدث تغييرات واحد أو أكثر الذي منه يمكن إضافة الوسم أو إزالته. لا يسمح بما يزيد عن 50 (500 للبوتات).

*{{ApiParam|siprop|أيّ الخصائص المطلوب الحصول عليها|default=general}}
**{{ApiParam|general|معلومات عامة عن الموقع}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}

• siprop: أيّ الخصائص المطلوب الحصول عليها (افتراضي: general)
  • general: معلومات عامة عن الموقع
    • articlepath: $wgArticlePath 1.15+

طالع أيضا

• {{Parameter }} – نسخة قديمة من ApiParam

يمكن للمحررين تجريب تعديلاتهم على القالب في صفحات ملعب (أنشئ | مرآة) و مختبر (أنشئ).
الصفحات الفرعية لـ قالب.