امتداد:نبيطات
 حالة الإصدار مستقر |
|
|---|---|
 |
|
| تنفيذ | MyWiki, صفحة خاصة, واجهة برمجة التطبيقات |
| بيان | يسمح للمستخدمين بتمكين نبيطات تستند إلى جافا سكريبت يقدمها المستخدمين من صفحة تفضيلاتهم |
| المؤلف/المؤلفون | Daniel Kinzler (Duesentriebنقاش) |
| سياسة التوافق | تصدر اللقطات البرمجية مع ميدياويكي. الإصدار الرئيسي لا يتوافق مع الإصدارات السابقة. |
| MediaWiki | 1.19+ |
| ترخيص | رخصة جنو العمومية 2.0 أو ما بعدها |
| التنزيل | README |
| مثال | ويكيميديا كومنز: نظرة عامة على النبيطات، تفضيلات المستخدمين (انقر على «نبيطات»؛ يجب عليك أن تكون مسجل الدخول بالطبع) |
|
|
|
|
| ترجم الامتداد Gadgets لو كان متوفرا على translatewiki.net | |
| المسائل | المهام المفتوحة · الإبلاغ عن عطل تقني |
يقدم امتداد Gadgets سبيل للمستخدمين يمكنهم من اختيار «نبيطات» مبنية على جافا سكريبت أو سي إس إس التي يقدمها مستخدمي موقع الويكي الآخرين.
تصمم النبيطات باستخدام قصاصات جافا سكريبت أو سي إس إس أو كلاهما موجودة في صفحات على نطاق الاسم ميدياويكي. تحدد كل نبيطة باستخدام سطر في MediaWiki:Gadgets-definition، يقدم اسم وبيان للنبيطة، وقائمة بقصاصات جافا سكريبت وسي إس إس التي تستعين بها (طالع فقرة الاستخدام التالية).
منذ أن النبيطات تضاف إلى نطاق الاسم ميدياويكي (حيث توجد كلا من القائمة التي تحدد النبيطات وقصاصات الكود البرمجي ذاتها)، يمكن فقط لإداري النظام (وكذلك إداري الواجهة بدءا من الإصدار 1.32) تعديل الكود البرمجي. يتعين أن يكون الأمر كما يلي: يمنح فقط المستخدمين الذين يحظون بثقة مجتمع الويكي المتينة صلاحية تعديل كود جافا سكريبت البرمجي الذي يستخدمه المستخدمين الآخرين، منذ أنه يسهل استخدام جافا سكريبت في قرصنة الحسابات أو التلصص على الأفراد.
التنصيب
- نزّل الملف/الملفات وضعها في دليل يحمل اسم
Gadgetsداخل مجلد extensions/ لديك. - أضف الكود التالي في الجزء الأسفل من LocalSettings.php:
wfLoadExtension( 'Gadgets' );
تم التنفيذ – اذهب إلى Special:Version على موقع الويكي لديك كي تتحقق من أن الامتداد قد ثبت بنجاح.
للمستخدمين الذي يستخدمون إصدار ميدياويكي 1.24 أو ما قبله:
تبين التعليمات السالفة سبيل جديد لتثبيت الامتداد مستخدما wfLoadExtension().
لو كنت تحتاج لتثبيت الامتداد على هذه الإصدارات السابقة (ميدياويكي 1.24 أو ما قبله)، استخدم ما يلي بدلا من wfLoadExtension( 'Gadgets' );:
require_once "$IP/extensions/Gadgets/Gadgets.php";
الاستخدام
يوجد سبيلين اثنين لتحديد النبيطات استنادا إلى $wgGadgetsRepoClass.
لو كانت 'MediaWikiGadgetsDefinitionRepo' (القيمة الافتراضية)، سوف تحدد قائمة النبيطات المتاحة على MediaWiki:Gadgets-definition.
سبيل آخر، وهو تحديد النبيطات على صفحات في نطاق الاسم تعريف النبيطات حينما تكون قيمة $wgGadgetsRepoClass هي 'GadgetDefinitionNamespaceRepo'.
 تحذير: | ترحيل تعريفات النبيطات القائمة غير مدعوم بعد، لذا سوف تفقد النبيطات المعرفّة من قبل بعد تغيير هذا الخيار. |
حال استحداث هذا مستخدمًا نبيطة واحدة على الأقل، تظهر النبيطات المحددة هناك في قسم «النبيطات» من صفحة Special:Preferences، حتى يمكن للمستخدمين اختيار النبيطات التي يرغبون في استخدامها. نظرة عامة على النبيطات المحددة في MediaWiki:Gadgets-definition تظهر أيضًا في صفحة Special:Gadgets، إلى جانب وصلات شبكية إلى رسائل النظام المعنية بها، لتيسير التعديل. يمكن الاطلاع على إحصائيات تتناول استخدام النبيطات التي ليست افتراضية على الصفحة Special:GadgetUsage.
الصيغة
استخدام تعريف نبيطات ميدياويكي
كل سطر في MediaWiki:Gadgets-definition يبدأ بالمحرف «*» (النجمة) سواء كان نجمة واحدة أو أكثر يعرّف نبيطة؛ يتعين أن يكون بالصيغة التالية:
* gadget_name [خيارات (يمكن تخطيها)] | أسماء الصفحات
الخانة الأولى («gadget_name» في المثال) هي الاسم الداخلي للنبيطة، ويشير إلى رسالة من النظام (MediaWiki:Gadget-gadget_name في المثال) تحتوي على وصف موجز للنبيطة يستخدم إعراب نصوص الويكي.
[A-Za-z]) ويجوز أن يتبعه أي عدد من الأحرف والأرقام ([0-9]) والشرطات (-) والشرطات التحتية (_) والنقطتان المتعامدتان (:) والنقط (.).تنسيق الخيارات:
[option1 | option2 | ... optionN]
يجوز حذف المسافة. يجوز أن يحتوي خيار واحد على اسم خيار واحد (في هذه الحالة هو خيار وسم) أو يحتوي على قائمة قيم تفصلها فاصلة:
option = value1, value2, value3
أمثلة:
* mygadget[ResourceLoader]|mygadget.js|mygadget.css
أو
* mygadget[ResourceLoader|package]| mygadget.js | mygadget-Foo.js | mygadget-data.json | mygadget.css
أو
* mygadget[ ResourceLoader | rights=foo, bar ] | mygadget.js | mygadget.css
استخدام نطاق اسم تعريف النبيطات
إنشاء صفحة Gadget definition:mygadget ووضع نص جسون البرمجي التالي فيها سوف يكون له نفس أثر mygadget[ ResourceLoader | rights=foo, bar ] | mygadget.js | mygadget.css.
{
"settings": {
"rights": [ "foo", "bar" ],
"default": false,
"package": false,
"hidden": false,
"skins": [],
"actions": [],
"category": ""
},
"module": {
"scripts": [ "mygadget.js" ],
"styles": [ "mygadget.css" ],
"datas": [],
"peers": [],
"dependencies": [],
"messages": [],
"type": ""
}
}
في المثال السابق، يستخدم كلا من Gadget:Mygadget.js وGadget:mygadget.css.
تذكر أن خيار ResourceLoader تكون قيمته دائمًا «true» في تعريف نطاق الاسم المخصص للنبيطات.
يتطلب تعديل الصفحات الموجودة في نطاق الاسم «نبيطات» التمتع بحق gadgets-edit وتعديل الصفحات الموجودة في نطاق اسم تعريف النبيطات يتطلب التمتع بحق gadgets-definition-edit.
$wgGroupPermissions['interface-admin']['gadgets-edit'] = true;
$wgGroupPermissions['interface-admin']['gadgets-definition-edit'] = true;
خيارات
| الاسم | المتغيرات | الوصف | منذ |
|---|---|---|---|
ResourceLoader |
لا شيء | يسم النصوص البرمجية للنبيطات في صفة متوافقة مع ResourceLoader. | ? |
dependencies |
أسماء وحدات برمجية مفصولة بفاصلة | طالع قائمة الوحدات البرمجية الافتراضية. Note that this option has no effect if current gadget has no ResourceLoader-compatible resources (i.e. no styles and scripts not marked as compatible). | ? |
rights |
Comma-separated privilege names | Make the gadget available (and visible in preferences) only to users who have the specified privileges. | ? |
hidden
|
None | Hide the gadget from the Preferences page. This can be used in two ways:
|
1.28 |
skins |
Comma-separated skin names | Make the gadget available (and visible in preferences) only to users who use the specified skins. Before MediaWiki 1.32 it was taking into consideration the skin set in preferences for the user, not the current displayed one (like when adding ?useskin=monobook in the URL, مهمة T199478). |
? |
actions |
Comma-separated action names | Make the gadget available only on the specified page actions. E.g. actions = edit, history to load a gadget only while editing and on history pages. Specifying edit action will also load it on action=submit. Invalid actions effectively disable the gadget since it can't be run anywhere. |
1.38-wmf.16 |
default
|
None | Enable the gadget by default for everyone (including IPs). Registered users can still disable it in their preferences. | 1.18 |
package
|
None | Mark this gadget as packaged. In this mode, only the first JavaScript page will be executed. Other pages can be imported by using the require() function. This mode also enables use of JSON pages, which cannot be included otherwise. | 1.38-wmf.16 |
targets
|
desktop (default), mobile or desktop,mobile
|
Set the ResourceLoader target(s) for the gadget. | gerrit:60954 |
type
|
styles or general
|
Use styles for modules that only modify styling for elements already on the page (e.g. when customizing the skin, layout, or article content). It will cause the CSS files of the module to be included from the page HTML instead of being loaded via JavaScript. For details, see ResourceLoader/Migration guide (users)#Gadget type.
Using
styles will not load in any specified JavaScript files. For gadgets that modify styling for elements through both JavaScript and CSS, two individual gadget definitions are required. |
1.28 |
peers
|
أسماء وحدات برمجية مفصولة بفاصلة | Require CSS-only gadgets (which usually would be hidden). These gadgets will be loaded sooner than by dependencies, and will be loaded even if JavaScript is disabled. For details, see ResourceLoader/Migration guide (users)#Gadget peers.
|
1.29.0-wmf.11 (pre-release) |
supportsUrlLoad
|
None | true | false | Make the gadget available to be loaded with the ?withgadget URL query parameter.
|
1.38 |
|
None | (رفع في 1.29) Makes the gadget to be top-loaded. This should be used sparingly, but may be needed for some initialization stuff like registering plugins with VisualEditor. | gerrit:75506 |
يمكنك تحديد تبعيات إضافية لنبيطاتك، على سبيل المثال:
* mygadget[ResourceLoader|dependencies=jquery.ui, jquery.effects.clip]|mygadget.js|mygadget.css
Here, we ask ResourceLoader to load modules jquery.ui and jquery.effects.clip with mygadget.
Note that gadgets can't depend on scripts from pages, static files or external URLs, only on modules already registered in ResourceLoader.
To make a script from a page depend on another script from a page, each should be a gadget which registers itself as a module in ResourceLoader, then they can be made to have dependencies using the following syntax:
* childgadget[ResourceLoader|dependencies=ext.gadget.parentgadget]|childgadget.js
To enable a gadget by default, use "default":
* mygadget[ResourceLoader|default|dependencies=mediawiki.util]|mygadget.js|mygadget.css
To make the gadget available only to users with appropriate permissions, set the rights option, for example:
* ImprovedDeletion [rights=delete] | ImprovedDeletion.js
Makes the gadget available only to users who can actually delete pages.
Note that restrictions are based on permissions, not user groups like administrators or bureaucrats.
إليك بعض الأمثلة الحقيقية:
* modrollback[ResourceLoader|rights=rollback]|modrollback.js * UTCLiveClock[ResourceLoader|rights=purge]|UTCLiveClock.js * Ajax_sysop[ResourceLoader|rights=patrol,rollback,markbotedits,delete]|Ajax_sysop.js
صفحات
The remaining fields on the line refer to the JavaScript, CSS or JSON code that makes up the gadget, contained in system messages (MediaWiki:Gadget-mygadget.js and MediaWiki:Gadget-mygadget.css in the example); the names of those messages must end with ".js" or ".css", respectively.
A gadget can use any number of code messages, specifically, common code can be put into a code message used by several gadgets, in addition to their own specific code, e.g:
* frobinator[ResourceLoader]|commonStuff.js|frob.js|frob.css|pretty.css * l33t[ResourceLoader]|commonStuff.js|tools.js|l33t.js * foobar[ResourceLoader|package]|foo.js|bar.js|foobar.json
Please note that if your code contains strings that could be interpreted as wiki syntax (e.g. the signature code ~~~~), you may want to enclose your code into <nowiki>...</nowiki> and put these tags in JavaScript or CSS comments so they're not interpreted when actually used.
See the first and last lines of MediaWiki:Gadget-externalsearch-bar.js for an example.
فقرات
The list of gadgets in MediaWiki:Gadgets-definition can be broken into sections using lines that start and end with two or more "=" (equals) characters, enclosing the name of a system message that defines the section's name, for example:
== interface-gadgets ==
سوف يحدد هذا فقرة جديدة، ويكون عنوانها كما هو محدد في الصفحة MediaWiki:Gadget-section-interface-gadgets.
قائمة المطلوب عمله
- استيفاء النبيطات الأساسية
List of gadget scripts
| Gadgets | Usage | |||||
|---|---|---|---|---|---|---|
| MediaWiki.org | commons | meta | wikipedia | |||
| en | ||||||
| installed | installed | installed | installed | |||
| UTCLiveClock.js | 
|
|
|
| ||
| SearchFocus.js |
|
| ||||
| Syntax highlighter |
|
|||||
| mySandbox |
| |||||
| BugStatusUpdate |
|
| ||||
| Pages gadgets | ||||||
| edittop.js |
|
|
|
| ||
| Category gadgets | ||||||
| HotCat.js |
|
|
|
| ||
| Tab gadgets | ||||||
| addsection-plus.js |
|
|||||
| Sidebar gadgets | ||||||
| SubPages.js | ||||||
| UserRights.js | ||||||
انظر أيضا
| هذا الامتداد يستخدم على واحد من مشاريع ويكيميديا أو أكثر من واحد. يعني هذا الأمر أن الامتداد مستقر ويعمل/تعمل جيدا بما فيه الكفاية ليستخدم/لتستخدم في مواقع تتمتع بمستوى زيارات مرتفع مثل هذه. ابحث عن اسم هذا الامتداد في ملفات الضبط CommonSettings.php وكذلك InitialiseSettings.php كي ترى أين تنصب. توجد قائمة كاملة بالامتدادات المنصبة على موقع ويكي بعينه على صفحة Special:Version الخاصة بموقع الويكي. |