Template:ApiParam/ar

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Template:ApiParam and the translation is 100% complete.
Other languages:
English • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎русский • ‎العربية • ‎فارسی • ‎বাংলা • ‎中文 • ‎日本語
توثيق القالب
يرجى التفكير جديا في رفع استدعاءات هذا القالب ووضع مكانها حالات ضم 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|One or more recent changes IDs from  which to add or remove the tag.|maxallowed=50}}
  • rcid: One or more recent changes IDs from which to add or remove the tag. لا يسمح بما يزيد عن 50 (500 للبوتات).
*{{ApiParam|siprop|Which properties to get|default=general}}
**{{ApiParam|general|General site information}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}
  • siprop: Which properties to get (افتراضي: general)

طالع أيضا

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