الفرق بين المراجعتين ل"Cordova/plugman"
سطر 4: | سطر 4: | ||
منذ الإصدار 3.0 وما بعده، صارت كوردوفا تقدم كل الواجهات البرمجية الخاصة بالجهاز (device APIs) على شكل إضافات، لكن لا تمكّنها افتراضيًا. كما أنها تدعم طريقتين مختلفتين لإضافة وإزالة الإضافات، اعتمادًا على سير العمل المُعتمد (راجع الصفحة [https://cordova.apache.org/docs/en/latest/guide/overview/index.html Overview)]: | منذ الإصدار 3.0 وما بعده، صارت كوردوفا تقدم كل الواجهات البرمجية الخاصة بالجهاز (device APIs) على شكل إضافات، لكن لا تمكّنها افتراضيًا. كما أنها تدعم طريقتين مختلفتين لإضافة وإزالة الإضافات، اعتمادًا على سير العمل المُعتمد (راجع الصفحة [https://cordova.apache.org/docs/en/latest/guide/overview/index.html Overview)]: | ||
* إن كنت تستخدم سير عمل عابر للمنصات (cross-platform)، فعليك استخدام الأمر <code>cordova</code> في [[Cordova/cli|واجهة سطر الأوامر]] لكي تضيف الإضافات، كما هو موضح في صفحة [[Cordova/cli|واجهة سطر الأوامر]] . تُعدل واجهة سطر الأوامر الإضافات في جميع المنصات المحددة في نفس الوقت. | * إن كنت تستخدم سير عمل عابر للمنصات (cross-platform)، فعليك استخدام الأمر <code>cordova</code> في [[Cordova/cli|واجهة سطر الأوامر]] لكي تضيف الإضافات، كما هو موضح في صفحة [[Cordova/cli|واجهة سطر الأوامر]] . تُعدل واجهة سطر الأوامر الإضافات في جميع المنصات المحددة في نفس الوقت. | ||
− | * إن كنت تستخدم سير عمل مرتكز على منصة واحدة، فعليك استخدام الأمر منخفض المستوى [https://github.com/apache/cordova-plugman/ Plugman] في [[Cordova/cli|واجهة سطر الأوامر]] | + | * إن كنت تستخدم سير عمل مرتكز على منصة واحدة، فعليك استخدام الأمر منخفض المستوى [https://github.com/apache/cordova-plugman/ Plugman] في [[Cordova/cli|واجهة سطر الأوامر]] لكل منصة مستهدفة على حِدة. |
− | يقدم هذا القسم تفاصيل | + | يقدم هذا القسم تفاصيل عن كيفية استخدام الأداة <code>Plugman</code>. لمزيد من المعلومات حول استخدام <code>Plugman</code> كوحدة عقدية (node module)، أو لتعديل الشيفرة المصدرية، راجع الصفحة [https://github.com/apache/cordova-plugman/blob/master/README.md README file in its repository]. |
== تثبيت Plugman == | == تثبيت Plugman == | ||
سطر 16: | سطر 16: | ||
'''تنبيه''': إن وجدت أنك بعد تثبيت <code>plugman</code> بواسطة <code>npm</code> لا تزال غير قادر على تنفيذ أوامر <code>plugman</code>، فتأكد من إضافة المجلد <code>/npm/</code> إلى المتغير العام <code>PATH</code>. | '''تنبيه''': إن وجدت أنك بعد تثبيت <code>plugman</code> بواسطة <code>npm</code> لا تزال غير قادر على تنفيذ أوامر <code>plugman</code>، فتأكد من إضافة المجلد <code>/npm/</code> إلى المتغير العام <code>PATH</code>. | ||
− | '''ملاحظة''': يمكنك تخطي هذه الخطوة إن لم تُرد تلويث مجال الأسماء العام <code>npm</code> | + | '''ملاحظة''': يمكنك تخطي هذه الخطوة إن لم تُرد تلويث مجال الأسماء العام <code>npm</code> بتثبيت <code>Plugman</code> بشكل عام (globally). في هذه الحالة، سيكون هناك مجلد <code>node_modules</code> داخل مشروعك يتضمن <code>Plugman</code> عندما تنشئ مشروع كوردوفا باستخدام أدوات الصدفة (shell). ولأنك لم تُثبّت <code>Plugman</code> بشكل عام، فسيكون عليك استدعاء <code>node</code> مع كل أوامر <code>Plugman</code>، مثل الأمر: <code>node ./node_modules/plugman/main.js -version</code>. |
سنفترض في بقية هذا الدليل أنك قمت بتثبيت <code>Plugman</code> بشكل عام، ما يعني أنه بمقدورك استدعاؤها عبر الأمر <code>plugman</code> وحده. | سنفترض في بقية هذا الدليل أنك قمت بتثبيت <code>Plugman</code> بشكل عام، ما يعني أنه بمقدورك استدعاؤها عبر الأمر <code>plugman</code> وحده. | ||
سطر 29: | سطر 29: | ||
<syntaxhighlight lang="console">$ plugman install --platform <ios|android> --project <directory> --plugin <name|url|path> [--plugins_dir <directory>] [--www <directory>] [--variable <name>=<value> [--variable <name>=<value> ...]]</syntaxhighlight> | <syntaxhighlight lang="console">$ plugman install --platform <ios|android> --project <directory> --plugin <name|url|path> [--plugins_dir <directory>] [--www <directory>] [--variable <name>=<value> [--variable <name>=<value> ...]]</syntaxhighlight> | ||
− | باستخدام الحد الأدنى من الوسائط، يقوم هذا الأمر بتثبيت الإضافة في مشروع كوردوفا. من اللازم تحديد منصة وموضع مشروع كوردوفا الخاص بها. يجب عليك أيضًا تحديد إضافة عقِب العبارة <code>--plugin</code> | + | باستخدام الحد الأدنى من الوسائط، يقوم هذا الأمر بتثبيت الإضافة في مشروع كوردوفا. من اللازم تحديد منصة وموضع مشروع كوردوفا الخاص بها. يجب عليك أيضًا تحديد إضافة عقِب العبارة <code>--plugin</code> عبر المعاملات التالية: |
* <code>name</code>: اسم المجلد الذي يتضمّن محتويات الإضافة. يجب أن يكون مجلدًا موجودًا داخل المسار <code>--plugins_dir</code> (انظر أدناه لمزيد من المعلومات) أو إضافة في سجل (registry) كوردوفا. | * <code>name</code>: اسم المجلد الذي يتضمّن محتويات الإضافة. يجب أن يكون مجلدًا موجودًا داخل المسار <code>--plugins_dir</code> (انظر أدناه لمزيد من المعلومات) أو إضافة في سجل (registry) كوردوفا. | ||
− | * <code>url</code>: عنوان يبدأ بـ <code>https://</code> أو <code>git://</code>، ويشير إلى مستودع git صالح وقابل للنسخ، ويحتوي على ملف <code>plugin.xml</code>. ستُنسخ محتويات هذا المستودع في <code>--plugins_dir</code>. | + | * <code>url</code>: عنوان يبدأ بـ <code>https://</code> أو <code>git://</code>، ويشير إلى مستودع git صالح وقابل للنسخ، ويحتوي على ملف <code>plugin.xml</code>. ستُنسخ محتويات هذا المستودع في المجلد <code>--plugins_dir</code>. |
− | * <code>path</code>: مسار إلى مجلد يحتوي على إضافة صالحة مرفوقة بالملف <code>plugin.xml</code>. ستُنسخ محتويات هذا المسار في <code>--plugins_dir</code>. | + | * <code>path</code>: مسار إلى مجلد يحتوي على إضافة صالحة مرفوقة بالملف <code>plugin.xml</code>. ستُنسخ محتويات هذا المسار في المجلد <code>--plugins_dir</code>. |
معاملات أخرى: | معاملات أخرى: | ||
سطر 41: | سطر 41: | ||
== إزالة الإضافات == | == إزالة الإضافات == | ||
− | لإزالة | + | لإزالة إضافةٍ محددةٍ، كل ما عليك فعله هو تمرير الأمر <code>uninstall</code> مرفوقًا بمعرف (ID) الإضافة. |
<syntaxhighlight lang="console">$ plugman uninstall --platform <ios|android> --project <directory> --plugin <id> [--www <directory>] [--plugins_dir <directory>]</syntaxhighlight> | <syntaxhighlight lang="console">$ plugman uninstall --platform <ios|android> --project <directory> --plugin <id> [--www <directory>] [--plugins_dir <directory>]</syntaxhighlight> | ||
== أوامر طلب المساعدة == | == أوامر طلب المساعدة == | ||
− | يوفر <code>Plugman</code> الأمر <code>help</code> لاستخدامه لأجل الحصول على | + | يوفر <code>Plugman</code> الأمر <code>help</code> لاستخدامه لأجل الحصول على المساعدة في حال واجهتك مشكلة. إذ سيقوم بعرض قائمة بجميع أوامر <code>Plugman</code> المتاحة مرفوقة بطريقة صياغتها: |
<syntaxhighlight lang="console">plugman -help | <syntaxhighlight lang="console">plugman -help | ||
plugman # same as above</syntaxhighlight> | plugman # same as above</syntaxhighlight> | ||
سطر 64: | سطر 64: | ||
=== البحث عن الإضافات === | === البحث عن الإضافات === | ||
− | يمكنك استخدام <code>Plugman</code> للبحث في سجل الإضافات ([http://plugins.cordova.io/ Plugin registry]) عن مُعرِّف (id) الإضافة | + | يمكنك استخدام <code>Plugman</code> للبحث في سجل الإضافات ([http://plugins.cordova.io/ Plugin registry]) عن مُعرِّف (id) الإضافة التي تُطابق لائحة من الكلمات الرئيسية مفصولة بمسافات بيضاء. |
<syntaxhighlight lang="console">plugman search <plugin keywords></syntaxhighlight> | <syntaxhighlight lang="console">plugman search <plugin keywords></syntaxhighlight> | ||
=== تغيير سجل الإضافة === | === تغيير سجل الإضافة === | ||
− | يمكنك الحصول على | + | يمكنك الحصول على سجل الإضافة الحالية التي يستخدمها <code>plugman</code> أو تعيين عنوانها. لكن يجب عليك عمومًا تركه عند القيمة <code><nowiki>http://registry.cordova.io</nowiki></code>، إلا إن كنت ترغب في استخدام سجل إضافة من طرف ثالث. |
<syntaxhighlight lang="console">plugman config set registry <url-to-registry> | <syntaxhighlight lang="console">plugman config set registry <url-to-registry> | ||
plugman config get registry</syntaxhighlight> | plugman config get registry</syntaxhighlight> | ||
سطر 80: | سطر 80: | ||
== تثبيت الإضافات الأساسية (Installing Core Plugins) == | == تثبيت الإضافات الأساسية (Installing Core Plugins) == | ||
− | توضح الأمثلة أدناه كيف تضيف الإضافات بحسب الحاجة، بحيث أن | + | توضح الأمثلة أدناه كيف تضيف الإضافات بحسب الحاجة، بحيث أن كل الواجهات البرمجية لكوردوفا التي تستخدمها في مشروعك ستستمر بالعمل حتى بعد الترقية إلى الإصدار 3.0. |
− | مع كل أمرٍ (command) سيكون عليك تحديد المنصة المستهدفة، والإشارة إلى مجلد المشروع في المنصة. | + | مع كل أمرٍ (command)، سيكون عليك تحديد المنصة المستهدفة، والإشارة إلى مجلد المشروع في المنصة. |
*<code>cordova-plugin-battery-status</code> | *<code>cordova-plugin-battery-status</code> | ||
<syntaxhighlight lang="console">plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-battery-status</syntaxhighlight> | <syntaxhighlight lang="console">plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-battery-status</syntaxhighlight> |
مراجعة 23:02، 23 نوفمبر 2018
منذ الإصدار 3.0 وما بعده، صارت كوردوفا تقدم كل الواجهات البرمجية الخاصة بالجهاز (device APIs) على شكل إضافات، لكن لا تمكّنها افتراضيًا. كما أنها تدعم طريقتين مختلفتين لإضافة وإزالة الإضافات، اعتمادًا على سير العمل المُعتمد (راجع الصفحة Overview):
- إن كنت تستخدم سير عمل عابر للمنصات (cross-platform)، فعليك استخدام الأمر
cordova
في واجهة سطر الأوامر لكي تضيف الإضافات، كما هو موضح في صفحة واجهة سطر الأوامر . تُعدل واجهة سطر الأوامر الإضافات في جميع المنصات المحددة في نفس الوقت. - إن كنت تستخدم سير عمل مرتكز على منصة واحدة، فعليك استخدام الأمر منخفض المستوى Plugman في واجهة سطر الأوامر لكل منصة مستهدفة على حِدة.
يقدم هذا القسم تفاصيل عن كيفية استخدام الأداة Plugman
. لمزيد من المعلومات حول استخدام Plugman
كوحدة عقدية (node module)، أو لتعديل الشيفرة المصدرية، راجع الصفحة README file in its repository.
تثبيت Plugman
لتثبيت Plugman
، يجب أن يكونnode مثبتًا على جهازك. بعد ذلك، يمكنك تنفيذ الأمر التالي من أي مكان في بيئة العمل لتثبيت Plugman
بشكل عام (globally) حتى يكون متاحًا من أي مجلد:
$ npm install -g plugman
ينبغي أيضًا أن يكون git
مضافًا إلى المتغير العام PATH
لتتمكن من تثبيت الإضافات عن بُعد مباشرة من عناوين git.
تنبيه: إن وجدت أنك بعد تثبيت plugman
بواسطة npm
لا تزال غير قادر على تنفيذ أوامر plugman
، فتأكد من إضافة المجلد /npm/
إلى المتغير العام PATH
.
ملاحظة: يمكنك تخطي هذه الخطوة إن لم تُرد تلويث مجال الأسماء العام npm
بتثبيت Plugman
بشكل عام (globally). في هذه الحالة، سيكون هناك مجلد node_modules
داخل مشروعك يتضمن Plugman
عندما تنشئ مشروع كوردوفا باستخدام أدوات الصدفة (shell). ولأنك لم تُثبّت Plugman
بشكل عام، فسيكون عليك استدعاء node
مع كل أوامر Plugman
، مثل الأمر: node ./node_modules/plugman/main.js -version
.
سنفترض في بقية هذا الدليل أنك قمت بتثبيت Plugman
بشكل عام، ما يعني أنه بمقدورك استدعاؤها عبر الأمر plugman
وحده.
إنشاء مشروع كوردوفا
قبل أن تتمكن من استخدام Plugman
، سيكون عليك إنشاء مشروع كوردوفا. يمكنك القيام بذلك إما بواجهة سطر الأوامر أو ببرامج الصدفة منخفضة المستوى (lower level shell scripts).
كيف تضيف الإضافات
بمجرد تثبيت Plugman
وإنشاء مشروع كوردوفا، يمكنك أت تضبف إضافات إلى المنصة عبر الشيفرة التالية:
$ plugman install --platform <ios|android> --project <directory> --plugin <name|url|path> [--plugins_dir <directory>] [--www <directory>] [--variable <name>=<value> [--variable <name>=<value> ...]]
باستخدام الحد الأدنى من الوسائط، يقوم هذا الأمر بتثبيت الإضافة في مشروع كوردوفا. من اللازم تحديد منصة وموضع مشروع كوردوفا الخاص بها. يجب عليك أيضًا تحديد إضافة عقِب العبارة --plugin
عبر المعاملات التالية:
name
: اسم المجلد الذي يتضمّن محتويات الإضافة. يجب أن يكون مجلدًا موجودًا داخل المسار --plugins_dir
(انظر أدناه لمزيد من المعلومات) أو إضافة في سجل (registry) كوردوفا.url
: عنوان يبدأ بـhttps://
أوgit://
، ويشير إلى مستودع git صالح وقابل للنسخ، ويحتوي على ملفplugin.xml
. ستُنسخ محتويات هذا المستودع في المجلد --plugins_dir
.path
: مسار إلى مجلد يحتوي على إضافة صالحة مرفوقة بالملفplugin.xml
. ستُنسخ محتويات هذا المسار في المجلد --plugins_dir
.
معاملات أخرى:
-
--plugins_dir
: قيمته الافتراضية تساوي <project>/cordova/plugins
، ولكن يمكن أن يكون أي مجلد يحتوي على مجلدات فرعية مقابلة لكل إضافة مجلوبة (fetched). -
--www
: قيمته الافتراضية تساوي موضع مجلد المشروعwww
، ولكن قد يكون أي مجلد يمكن استخدامه كموضع لأصول (assets) مشروع كوردوفا. -
--variable
: يسمح بتحديد متغيرات معينة وقتَ التثبيت، وهو ضروري لبعض الإضافات التي تتطلب مفاتيح واجهة برمجية (API keys) أو غيرها من المعاملات المخصصة والمعرفة من قبل المستخدم. يرجى الاطلاع على صفحة plugin specification لمزيد من المعلومات.
إزالة الإضافات
لإزالة إضافةٍ محددةٍ، كل ما عليك فعله هو تمرير الأمر uninstall
مرفوقًا بمعرف (ID) الإضافة.
$ plugman uninstall --platform <ios|android> --project <directory> --plugin <id> [--www <directory>] [--plugins_dir <directory>]
أوامر طلب المساعدة
يوفر Plugman
الأمر help
لاستخدامه لأجل الحصول على المساعدة في حال واجهتك مشكلة. إذ سيقوم بعرض قائمة بجميع أوامر Plugman
المتاحة مرفوقة بطريقة صياغتها:
plugman -help
plugman # same as above
ملاحظة: قد يظهر الأمر plugman -help
بعض أوامر السّجل (registry-related commands) الإضافية. هذه الأوامر مخصصة لمطوري الإضافات، وقد لا تُفدّم على سجلات الإضافات القادمة من طرف ثالث.
يمكنك أيضًا إضافة الراية --debug|-d
إلى أي أمرٍ من أوامر Plugman
لتنفيذه في الوضع المفصّل (verbose mode)، حيث سيعرض رسائل تصحيح الأخطاء الداخلية عند إصدارها، وقد يساعدك في تعقب مصدر المشكلة، مثل مشكلة عدم إيجاد الملفات.
# Adding Android battery-status plugin to "myProject":
plugman -d install --platform android --project myProject --plugin cordova-plugin-battery-status
وأخيرًا، يمكنك استخدام الراية --version|-v
لمعرفة إصدار Plugman
الذي تستخدمه.
plugman -v
إجراءات السجلات (Registry Actions)
هناك عدد من أوامر plugman
التي يمكن استخدامها للتفاعل مع سجل الإضافات (Plugin registry). يرجى ملاحظة أن أوامر السجلات هذه مخصوصة بسجل الإضافات plugins.cordova.io
، وقد لا تقدّم (implemented) من قبل سجلات الإضافات القادمة من طرف ثالث.
البحث عن الإضافات
يمكنك استخدام Plugman
للبحث في سجل الإضافات (Plugin registry) عن مُعرِّف (id) الإضافة التي تُطابق لائحة من الكلمات الرئيسية مفصولة بمسافات بيضاء.
plugman search <plugin keywords>
تغيير سجل الإضافة
يمكنك الحصول على سجل الإضافة الحالية التي يستخدمها plugman
أو تعيين عنوانها. لكن يجب عليك عمومًا تركه عند القيمة http://registry.cordova.io
، إلا إن كنت ترغب في استخدام سجل إضافة من طرف ثالث.
plugman config set registry <url-to-registry>
plugman config get registry
الحصول على معلومات عن الإضافات
يمكنك الحصول على معلومات حول أي إضافة مُخزّنة في مستودع الإضافات عبر الأمر التالي:
plugman info <id>
سيتصل هذا الأمر بسجل الإضافة وسيجلب معلومات مثل رقم إصدار الإضافة.
تثبيت الإضافات الأساسية (Installing Core Plugins)
توضح الأمثلة أدناه كيف تضيف الإضافات بحسب الحاجة، بحيث أن كل الواجهات البرمجية لكوردوفا التي تستخدمها في مشروعك ستستمر بالعمل حتى بعد الترقية إلى الإصدار 3.0.
مع كل أمرٍ (command)، سيكون عليك تحديد المنصة المستهدفة، والإشارة إلى مجلد المشروع في المنصة.
cordova-plugin-battery-status
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-battery-status
cordova-plugin-camera
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-camera
cordova-plugin-console
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-console
cordova-plugin-contacts
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-contacts
cordova-plugin-device
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-device
cordova-plugin-device-motion (accelerometer)
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-device-motion
cordova-plugin-device-orientation (compass)
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-device-orientation
cordova-plugin-dialogs
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-dialogs
cordova-plugin-file
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-file
cordova-plugin-file-transfer
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-file-transfer
cordova-plugin-geolocation
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-geolocation
cordova-plugin-globalization
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-globalization
cordova-plugin-inappbrowser
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-inappbrowser
cordova-plugin-media
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-media
cordova-plugin-media-capture
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-media-capture
cordova-plugin-network-information
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-network-information
cordova-plugin-splashscreen
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-splashscreen
cordova-plugin-vibration
plugman install --platform <ios|android> --project <directory> --plugin cordova-plugin-vibration
انظر أيضا
- صفحة دليل تطوير الإضافات