الملف Plugin.xml في كوردوفا

من موسوعة حسوب
اذهب إلى: تصفح، ابحث

يعرِّف الملف Plugin.xml بنية وإعدادات الإضافة في مشروعك، ويحتوي على العديد من العناصر التي يمكن استخدامها لتوفير تفاصيل عن الإضافة.

العنصر plugin

العنصر plugin هو العنصر الجذري (top-level) لبيان (manifest) الإضافة.

الخاصيات (النوع)

فقط للمنصة

الوصف
xmlns (سلسلة نصية) (مطلوب)

مجال أسماء (namespace) الإضافة، http://apache.org/cordova/ns/plugins/1.0. إن كان المستند يحتوي على وُسوم XML من مجالات أسماء أخرى، مثل الوسوم المراد إضافتها إلى الملف AndroidManifest.xml في حالة استهداف منصة أندرويد، فيجب أيضًا تضمين مجالات الأسماء تلك في العنصر.

id (سلسلة نصية) (مطلوب)

مُعرف نمط (style identifier) مدير الحُزم npm الخاص بالإضافة.

version (سلسلة نصية) (مطلوب)

رقم إصدار الإضافة. يمكن اعتماد صياغة الإدارة الدلالية لنُسخ البرمجيات (SemVer، اختصار للكملتين Semantic Versioning).

إليك المثال التالي:
<?xml version="1.0" encoding="UTF-8"?>
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
    xmlns:android="http://schemas.android.com/apk/res/android"
    id="my-plugin-id"
    version="1.0.2">

العنصرين engines و engine

تحدد العناصر الفرعية من العنصر <engines> إصدارات بيئات العمل المستندة إلى أباتشي كوردوفا التي تدعمها هذه الإضافة. ستعيد واجهة سطر الأوامر عند الخروج قيمةً غير معدومة لكل الإضافات التي لا يلبي مشروعها المستهدف القيود المحددة من طرف الوسم engine. في حال عدم تحديد أي وسم، فستحاول واجهة سطر الأوامر التثبيت في مجلد مشروع كوردوفا المحدد دون القيام بأي عملية تحقق.

ملاحظة: في الإصدار Cordova 6.1.0‎ وما بعده، المكان الموصى به لتحديد المنصة أو الإضافة أو اعتماديات (dependencies) واجهة سطر الأوامر هو الملف package.json الخاص بالإضافة. انظر صفحة تحديد اعتماديات كوردوفا لمزيد من المعلومات.

الخاصيات (النوع)

فقط للمنصة:

الوصف
name (سلسلة نصية) (مطلوب)

تمثل هذه الخاصية اسم المحرك (engine). فيما يلي المحركات الافتراضية المدعومة:

  • cordova
  • cordova-plugman
  • cordova-android
  • cordova-ios
  • cordova-windows
  • cordova-osx
  • windows-os
  • android-sdk (تعيد أعلى مستوى لواجهة أندرويد البرمجية المثبتة)
  • windows-sdk (تعيد إصدار إطار العمل الأصلي SDK الخاص بويندوز)
  • apple-xcode (تعيد إصدار xcode)
  • apple-ios (تعيد أعلى إصدار مثبت من منصة iOS)
  • apple-osx (تعيد إصدار OSX)

يمكنك أيضًا تحديد إطار عمل مخصص إضافةً للبيئات الافتراضية.

version (سلسلة نصية) (مطلوب)

إصدار إطار العمل اللازم لكي يتم تثبيته. الإدارة الدلالية لنُسخ البرمجيات (Semver) مدعوم.

scriptSrc (سلسلة نصية) لإطارات العمل المُخصصة فقط

(مطلوب)

ملف البرنامج النصي الذي يُعلِم الأمر plugman بإصدار إطار العمل المخصص. يُفضل أن يكون هذا الملف ضمن المجلد الجذري في مجلد الإضافات.

platform (سلسلة نصية) لإطارات العمل المُخصصة فقط

(مطلوب)

المنصات التي يدعمها إطار العمل خاصتك. يمكنك استخدام المحرف * العام لتعبّر عن حقيقة أنَّ إطار العمل يدعم جميع المنصات، أو تحديد عدة منصات مفصولة بخط شاقولي ("|").

اطلع على المثال التالي:
<engines>
  <engine name="cordova-android" version="=1.8.0" />
</engines>

قد تحدد عناصر المحرك (engine) أيضًا التطابقات غير المضبوطة باستخدام المحارف "‎>‎‎" و "‎>=‎" ...إلخ. وذلك لتجنب التكرار وتقليل أعباء الصيانة والمراجعة عند تحديث المنصة.

<engines>
  <engine name="cordova-android" version=">=1.8.0" />
</engines>

كذلك تدعم وسوم <engine> افتراضيًا جميع المنصات التي تعمل عليها كوردوفا. تحديد الوسم engine يعني أنّ جميع إصدارات كوردوفا، على كل المنصات، يجب أن تتطابق مع قيمة الخاصية version الواردة في الوسم engine. يمكنك أيضًا سرد قائمة من منصات محددة مع إصداراتها لاستبدال الاختيار العام للوسم engine:

<engines>
  <engine name="cordova" version=">=1.7.0" />
  <engine name="cordova-android" version=">=1.8.0" />
  <engine name="cordova-ios" version=">=1.7.1" />
</engines>

مثال على بيئة عمل مخصصة:

<engines>
  <engine name="my_custom_framework" version="1.0.0" platform="android" scriptSrc="path_to_my_custom_framework_version"/>
  <engine name="another_framework" version=">0.2.0" platform="ios|android" scriptSrc="path_to_another_framework_version"/>
  <engine name="even_more_framework" version=">=2.2.0" platform="*" scriptSrc="path_to_even_more_framework_version"/>
</engines>

العنصر name

يُستخدم الوسم name لتحديد اسم الإضافة. هذا الوسم لا يدعم (إلى الآن) إعدادات اللغة المحلية.

مثال على استخدام الوسم name:

<name>Foo</name>

العنصر description

يُستخدم الوسم description لتحديد وصفٍ للإضافة. هذا العنصر لا يدعم (إلى الآن) اللغات المحلية.

مثال على استخدام الوسم description:

<description>Foo plugin description</description>

العنصر author

يحتوي الوسم author على اسم مؤلف الإضافة. مثال على استخدام الوسم author:
<author>Foo plugin author</author>

العنصر keywords

يحتوي العنصر keywords على كلمات مفتاحية مفصولة بفاصلة لوصف الإضافة.

مثال على استخدام الوسم keywords:

<keywords>foo,bar</keywords>

العنصر license

يُستخدم هذا العنصر لتحديد ترخيص الإضافة.

مثال على استخدام الوسم license:

<license>Apache 2.0 License</license>

العنصر asset

يُستخدم هذا العنصر لسرد الملفات أو المجلدات المراد نسخها في مجلد التطبيق www. عناصر <asset> المتشعبة (nested) داخل العنصر <platform> ستحدد أصول الويب (web assets) الخاصة بالمنصة.

الخاصيات (النوع)

فقط للمنصة

الوصف
src (سلسلة نصية) (مطلوب)

تحدد هذه الخاصية المكان الذي يوجد فيه الملف أو المجلد في حزمة الإضافة نسبةً إلى المستند plugin.xml. إن لم يكن الملف موجودًا في الموضع src المحدد، فستتوقف واجهة سطر الأوامر وستعكس عملية التثبيت، وستطلق تنبيهًا حول وجود تعارض، ثم تخرج مع إعادة قيمة غير معدومة.

target (سلسلة نصية) (مطلوب)

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

إليك المثال التالي:
<!-- ملف سيُنسخ داخل المجلد الجذري -->
<asset src="www/foo.js" target="foo.js" />
<!-- مجلد سيُنسخ داخل المجلد الجذري -->
<asset src="www/foo" target="foo" />

يمكن أيضًا استهداف الأصول (Assets) في المجلدات الفرعية. وسيؤدي ذلك إلى إنشاء المجلد js/experimental داخل المجلد www، ما لم يكن موجودًا بالفعل، وسيُنسَخ الملف new-foo.js وسيُعطَى الاسم foo.js.

<asset src="www/new-foo.js" target="js/experimental/foo.js" />

العنصر js-module

معظم الإضافات تتضمن ملف JavaScript واحدًا على الأقل. كل وسم <js-module> يقابل ملف JavaScript، إذ يُعفي ذلك مستخدمي الإضافة من إضافة وسم <script> لكل ملف.

لا تقم بتغليف (wrap) الملف بواسطة cordova.define، لأنه سيُضاف تلقائيًا. يتم تغليف الوحدة في دالة مجهولة (closure)، حيث ستكون module و exports وrequire في النطاق، كما هو معتاد في الوحدات AMD غير المتزامنة.

تشعيب (Nesting) عناصر <js-module> ضمن الوسم <platform> سيُصرّح بارتباطات (bindings) وحدة JavaScript الخاصة بالمنصة.

الخاصيات (النوع)

فقط للمنصة

الوصف
src (سلسلة نصية) تحدد هذه الخاصية مرجعًا لملف ما في مجلد الإضافة نسبةً إلى الملف plugin.xml. إذا لم يكن المسار المُستنتج من src يشير إلى ملف موجود فعلًا، فستوقف واجهة سطر الأوامر التثبيت وتعكسه، وتطلق تنبيهًا بالمشكلة، ثم تخرج مع إعادة قيمة غير معدومة.
name (سلسلة نصية) توفر هذه الخاصية الجزء الأخير من اسم الوحدة. يمكن أن تعطيها أي قيمة تريد، وليس لذلك أهمية إلا إن كنت تريد استخدام cordova.require لاستيراد أجزاء أخرى من الإضافات في شيفرة JavaScript. اسم الوحدة <js-module> يساوي مُعرّف (id) الإضافة متبوعًا بقيمة الاسم.
عند تثبيت الإضافة في المثال أدناه، يُنسخ الملف socket.js في المسار www/plugins/my-plugin-id/socket.js، ويُضاف كمُدخلة (entry) إلى الملف www/cordova_plugins.js. في وقت التحميل، تستخدم الشيفرة البرمجية في الملف cordova.js الواجهة البرمجية XHR لقراءة كل الملفات وإدارج الوسم <script> في ملف HTML:
<js-module src="socket.js" name="Socket">
</js-module>

باعتبار أن مُعرف (id) الإضافة يساوي chrome-socket، فسيكون اسم الوحدة هو chrome-socket.Socket.

الوسم clobbers

هذا الوسم مسموح به داخل العنصر <js-module>. ويُستخدم لتحديد مجال الأسماء (namespace) في الكائن window حيث يتم إدراج module.exports. يمكنك إدارج ما تشاء من الوسوم <clobbers>. الكائنات غير المتوفرة في الكائن window سيتم إنشاؤها.

الخاصيات (النوع)

فقط للمنصة

الوصف
target (سلسلة نصية) مجال الأسماء حيث يتم إدراج module.exports.
ألقِ نظرة فاحصة على المثال التالي:
<js-module src="socket.js" name="Socket">
  <clobbers target="chrome.socket" />
</js-module>

تُدرج module.exports هنا في الكائن window بحيث يمكن الوصول إليها عبر window.chrome.socket.

الوسم merges

هذا الوسم مسموح به داخل العنصر <js-module>. ويُستخدم لتحديد مجال الأسماء المرتبط بالكائن window حيث يُدمج module.exports مع القيمة الموجودة. إذا كان هناك مفتاح (key) موجود سلفًا، فسيستبدل (overrides) إصدارُ الوحدة الإصدارَ الأصلي. يمكنك إدارج أي عدد تريد من الوسوم <merges>. سيتم إنشاء الكائنات غير المتوفرة في الكائن window.

الخاصيات (النوع)

فقط للمنصة

الوصف
target (سلسلة نصية) مجال الأسماء حيث يتم إدراج module.exports
إليك المثال التالي:
<js-module src="socket.js" name="Socket">
  <merges target="chrome.socket" />
</js-module>

في هذا المثال ستُدمَج module.exports مع أي قيمة موجودة في window.chrome.socket.

الوسم runs

هذا الوسم مسموح به داخل العنصر <js-module>. ويستلزم ضرورة تحديد شيفرتك البرمجية عبر cordova.require، لكن دون أن تكون مثبتة في الكائن window. هذا مفيد عند تهيئة الوحدة، أو عند إرفاق معالجات الأحداث (event handlers) و غير ذلك. يمكن استخدام الوسم <runs/> مرةً واحدةً فقط. لاحظ أن تضمين <runs/> مع <clobbers/> أو <merges/> فيه تكرار، لأنها تستورد الوحدة عبر الأمر cordova.require.

اطلع على الشيفرة التالية:

<js-module src="socket.js" name="Socket">
  <runs/>
</js-module>

العنصر dependency

يسمح لك الوسم <dependency> بتحديد الإضافات الأخرى التي تعتمد عليها الإضافة الحالية. يُشار إلى الإضافات بواسطة معرفات مدير الحُزم npm، أو عن طريق عنوان مستودع github.

الخاصيات (النوع)

فقط للمنصة

الوصف
id (سلسلة نصية) توفّر هذه الخاصية معرف الإضافة.
url (سلسلة نصية) عنوان URL الخاص بالإضافة. يجب أن يشير هذا العنوان إلى مستودع git الذي ستحاول واجهة سطر الأوامر نسخه.
commit (سلسلة نصية) مرجع لمستودع git مفهوم من قبل git checkout: يمكن أن يكون فرعًا أو وسمًا (مثل master، أو 0.3.1)، أوقيمة hash) عبر commit hash مثل 975ddb228af811dd8bb37ed1dfd092a3d05295f9).
subdir (سلسلة نصية) تبيّن هذه الخاصية أن اعتماديات الإضافة المستهدفة موجودة كمجلد فرعي في مستودع git. وهذا مفيد لأنه يسمح للمستودع بأن يحتوي على العديد من الإضافات ذات الصلة، بحيث تُحدد كلها بشكل فردي.

إذا قمت بتعيين الخاصية url في الوسم <dependency> وأعطيتها القيمة "."، وقمت بتحديد الخاصية subdir، فستُثبّت الإضافة المرتبطة من نفس مستودع git المحلي أو البعيد مثل الإضافة الأب (parent plugin) التي حددت الوسم <dependency>. لاحظ أن المسار الذي تحدده subdir منسوب دائمًا إلى جذر مستودع git، وليس الإضافة الأم. هذا الأمر لن يتغير حتى لو قمت بتثبيت الإضافة عبر مسار محلي موجه مباشرة إليها. ستجد واجهة سطر الأوامر جذر مستودع git، ثم ستجد الإضافة الأخرى من هناك.

version (سلسلة نصية) إصدار الإضافة المعتمد عليها. الإدارة الدلالية لنُسخ البرمجيات (SemVer، اختصار للكملتين Semantic Versioning) مدعوم.
مثال على استخدام الوسم dependency:
<dependency id="cordova-plugin-someplugin" url="https://github.com/myuser/someplugin" commit="428931ada3891801" subdir="some/path/here" />
<dependency id="cordova-plugin-someplugin" version="1.0.1">

العنصر platform

يعرّف هذا الوسم المنصات التي لها أكواد برمجية أصيلة (native code) مرتبطة بها، أو تتطلب تعديلات على ملفات الإعدادات الخاصة بها. يمكن للأدوات التي تستخدم هذه المواصفات التعرف على المنصات المدعومة وتثبيت الشيفرة البرمجية في مشروعات كوردوفا. الإضافات التي لا تستخدم الوسوم <platform> يُفترض أن تكون بلغة JavaScript فقط، وبالتالي ستكون قابلة للتثبيت على كل المنصات.

الخاصيات (النوع)

فقط للمنصة

الوصف
name (سلسلة نصية) (مطلوب)

القيم المسموح بها هي: ios و android و windows و browser و osx

تجعل هذه الخاصية المنصة المحددة مدعومة، مع ربط العنصر الفرعي (element's children) بتلك المنصة.

مثال على استخدام الوسم platform:
<platform name="android">
  <!-- عناصر خاصة بأندرويد -->
</platform>

العنصر source-file

يحدد هذا الوسم الشيفرة المصدرية القابلة للتنفيذ التي يجب تثبيتها في المشروع.

الخاصيات (النوع)

فقط للمنصة

الوصف
src (سلسلة نصية) (مطلوب)

تحدد هذه الخاصية موقع الملف نسبةً إلى الملف plugin.xml. إذا تعذر العثور على الملف src، فستوقف واجهة سطر الأوامر التثبيت وتعكسه، وتطلق تنبيهًا حول المشكلة، ثم تخرج مع إعادة قيمة غير معدومة.

target-dir (سلسلة نصية) المجلد الذي يجب أن تُنسخ الملفات فيه نسبةً إلى جذر مشروع كوردوفا. من الناحية العملية، يعد هذا أكثر أهمية للمنصات القائمة على جافا، حيث يجب وضع الملفات الموجودة في الحزمة com.alunny.foo داخل المجلد com/alunny/foo. بالنسبة للمنصات التي لا يكون للمجلد المصدري أهمية كبيرة فيها، فيجب حذف هذه الخاصية.
framework (قيمة منطقية)

(المنصة iOS)

القيمة الافتراضية: false

عند تعيين هذه الخاصية إلى القيمة true، فستضيف أيضًا الملف المحدد كإطار عمل للمشروع.

compiler-flags (سلسلة نصية)

(المنصة iOS)

هذه الخاصية ستعيّن رايات المُصرّف (compiler flags) الخاصة بالملف المصدري المحدد.
مثال على استخدام الوسم source-file:
<!-- android -->
<source-file src="src/android/Foo.java" target-dir="src/com/alunny/foo" />
<!-- ios -->
<source-file src="src/ios/CDVFoo.m" />
<source-file src="src/ios/someLib.a" framework="true" />
<source-file src="src/ios/someLib.a" compiler-flags="-fno-objc-arc" />

العنصر header-file

هذا الوسم يشبه <source-file>، ولكنه مُخصص لمنصات مثل iOS و Android، والتي تُميز بين الملفات المصدرية (source files)، والملفات الرئيسية (headers) والموارد (resources). هذا الوسم غير مدعوم من قبل ويندوز.

الخاصيات (النوع)

فقط للمنصة

الوصف
src (سلسلة نصية) (مطلوب)

موضع الملف نسبةً إلى الملف plugin.xml. إذا تعذر العثور على الملف الذي تحدده src، فستوقف واجهة سطر الأوامر التثبيت وتعكسه، وتطلق تنبيهًا حول المشكلة، ثم تخرج مع إعادة قيمة غير معدومة.

target-dir (سلسلة نصية) المجلد حيث يجب نسخ الملفات، يُحدد نسبةُ إلى جذر مشروع كوردوفا.
مثال خاص بمنصة iOS:
<header-file src="CDVFoo.h" />

العنصر resource-file

هذا الوسم يشبه <source-file>، ولكنه مخصوص بمنصات مثل iOS و Android التي تميز بين الملفات المصدرية والملفات الرئيسية والموارد.

الخاصيات (النوع)

فقط للمنصة:

الوصف
src (سلسلة نصية) (مطلوب)

موضع الملف نسبةً إلى الملف plugin.xml. إذا تعذر العثور على الملف src، فستوقف واجهة سطر الأوامر التثبيت وتعكسه، وتطلق تنبيهًا حول المشكلة، ثم تخرج مع إعادة قيمة غير معدومة.

target-dir (سلسلة نصية) المسار حيث سيُنسخ الملف داخل المجلد خاصتك.
arch (سلسلة نصية)

(منصة ويندوز)

القيم المسموح بها: x86 أو x64 أو ARM.

تشير هذه الخاصية إلى أنه يجب ألا يتم تضمين الملف إلا عند بناء معمارية (architecture) محددة.

device-target

(منصة ويندوز)

القيم المسموح بها: win (أو windows) أو phone أو all.

تشير هذه الخاصية إلى أنه لا ينبغي تضمين الملف إلا عند القيام بالبناء لأجل نوع الجهاز المستهدف.

versions

(ويندوز)

تشير هذه الخاصية إلى أنه لا ينبغي تضمين الملف إلا عند القيام بالبناء لأجل الإصدارات التي تطابق السلسلة النصية المحددة. قيمة هذه الخاصية يمكن أن تكون أي سلسلة نصية تحتوي مجالًا لإصدار دلالي (node semantic version) صالح.
reference

(منصة ويندوز)

تشير هذه الخاصية إلى أنه يجب الرجوع إلى الملف عبر src بدلًا من نسخه في الوجهة المستهدفة. سيظهر الملف في Visual Studio مع اسم الملف المحدد من طرف target، ولكنه سيشير إلى الموضع src المقابل، وذلك بحسب المعمارية (architecture) المستخدمة.
مثال لأجهزة الأندرويد:
<resource-file src="FooPluginStrings.xml" target="res/values/FooPluginStrings.xml" />

مثال خاص بمنصة ويندوز:

<resource-file src="src/windows/win81/MobServices.pri" target="win81\MobServices.pri" device-target="windows" versions="8.1" arch="x64"/>
<!-- Example of referencing  -->
<resource-file src="x86/foo.dll" target="foo.dll" arch="x86" reference="true" />
<resource-file src="x64/foo.dll" target="foo.dll" arch="x64" reference="true" />

ملاحظة: يجب أن تستخدم الخاصية target الخطوط المائلة العكسية ("\") لتجنب الخطأ DEP2100 deploy في Visual Studio.

العنصر config-file

يحدد هذا الوسم ملف الإعداد (XML) المراد تعديله، ويحدد موضع التعديل في ذلك المستند، وما الذي ينبغي تعديله.

هناك نوعان من الملفات تم اختبارها وتعديلها عبر هذا العنصر، وهما الملفان xml و plist. لا يسمح العنصر config-file إلا بإلحاق الوسوم الفرعية الجديدة إلى شجرة المستند XML. الوسوم الفرعية هي عناصر XML حرفية (literals) يتم إدراجها في الوثيقة المستهدفة.

الخاصيات (النوع)

فقط للمنصة

الوصف
target (سلسلة نصية) تحدد هذه الخاصية الملف المراد تعديله، والمسار نسبةً لجذر مشروع كوردوفا. إن لم يكن الملف المحدد موجودًا، فستتجاهل الأداة التعديلات على الإعدادات وستستمر في التثبيت.

يمكن أن يتضمن الهدف المحرف العام (*). في هذه الحالة، ستبحث واجهة سطر الأوامر عوديًا (recursively) في مجلد المشروع، وستستخدم أول تطابق.

في منصة iOS، موضع ملفات الإعدادات نسبةً إلى جذر مجلد المشروع غير معروف، لذلك فاعتماد القيمة config.xml سيُترجم إلى cordova-ios-project/MyAppName/config.xml.

parent (سلسلة نصية) محدد XPath ‏(XPath selector‏) يشير إلى أصل (parent) العناصر المراد إضافتها إلى ملف الإعدادات. إن استخدمت محددًا مطلقًا (absolute selectors)، فيمكنك استخدام المحرف العام (*) لتحديد العنصر الجذري، على سبيل المثال، ‎/*/plugins. إن لم يكن المحدد يُشير إلى وسم فرعي (child) من المستند المحدد، فستوقف الأداة عملية التثبيت وتعكسها، وتطلق تنبيًها، ثم تخرج وتعيد قيمة غير معدومة.

بالنسبة للملفات plist، تحدد الخاصية parent المفتاح الأصلي (parent key) الذي ينبغي أن يُدرج فيه عنصر XML المحدد.

after (سلسلة نصية) قائمة مرتبة حسب الأولوية للوسوم الإخوة (siblings) المقبولة التي ينبغي إضافة بيانات XML بعدها. هذه الخاصية مفيدة لتحديد التغييرات في الملفات التي تتطلب ترتيبًا صارمًا لعناصر XML، كما هو الحال هنا.
device-target (سلسلة نصية)

(منصة ويندوز)

القيم المسموح بها: win و phone و all.

هذه الخاصية قابلةً للتطبيق عند التأثير على الاسم الوصفي package.appxmanifest، تشير هذه الخاصية إلى ضرورة عدم تعديل الملف إلا عند القيام بالبناء لأجل نوع الجهاز المستهدف المحدد.

versions (سلسلة نصية)

(منصة ويندوز)

تُطبق هذه الخاصية عند التأثير على الاسم الوصفي package.appxmanifest، تشير هذه الخاصية إلى ضرورة عدم تعديل ملفات بيان (manifests) التطبيق الخاصة بإصدارات ويندوز المحددة إلا في الإصدارات التي تطابق السلسلة النصية المُعيّنة في الخاصية versions. يمكن أن تكون قيمة هذه الخاصية أي سلسلة نصية تحتوي مجالًا صالحًا للإصدارات الدلالية (semantic version).
مثال عن XML:
<config-file target="AndroidManifest.xml" parent="/manifest/application">
    <activity android:name="com.foo.Foo" android:label="@string/app_name">
        <intent-filter>
        </intent-filter>
    </activity>
</config-file>

مثال آخر عن plist:

<config-file target="*-Info.plist" parent="CFBundleURLTypes">
    <array>
        <dict>
            <key>PackageName</key>
            <string>$PACKAGE_NAME</string>
        </dict>
    </array>
</config-file>

مثال آخر من أجل الخاصيات الخاصة بويندوز:

<config-file target="package.appxmanifest" parent="/Package/Capabilities" versions="&lt;8.1.0">
    <Capability Name="picturesLibrary" />
    <DeviceCapability Name="webcam" />
</config-file>
<config-file target="package.appxmanifest" parent="/Package/Capabilities" versions=">=8.1.0" device-target="phone">
    <DeviceCapability Name="webcam" />
</config-file>

المثال أعلاه سيجعل المنصات السابقة للإصدار 8.1 (ويندوز 8، على وجه التحديد) تطالب باستيراد مكتبة webcam والمكتبة العامة picturesLibrary، مع تطبيق مكتبة الجهاز webcam حصريًا على مشاريع ويندوز 8.1 التي تُبنى لأجل Windows Phone. أما منصات Windows 8.1 المكتبية فلن تُعدَّل.

العنصر edit-config

هذا الوسم مشابه للعنصر config-file. يعرّف edit-config ملف الإعداد (XML) المراد تعديله، وأين ينبغي إجراء التعديل في ذلك الملف، وما الذي يجب تعديله. بدلًا من إلحاق وسوم فرعية (children) جديدة لشجرة المستند XML، يجري العنصر edit-config تعديلات على خاصيات عناصر XML. هناك وضعان سيحددان نوع التعديل الذي سيُجرى على الخاصيات، وهما merge و overwrite. الوسم edit-config لديه وسم فرعي واحد، والذي سيحتوي على الخاصيات المراد إضافتها.

الخاصيات (النوع)

فقط للمنصة

الوصف
file (سلسلة نصية) تحدد هذه الخاصية الملف المراد تعديله، والمسار نسبةً إلى المجلد الجذري لمشروع كوردوفا. إن لم يكن الملف المحدد موجودًا، فستتجاهل الأداة تغييرات الإعدادات وستستمر في عملية التثبيت.

يمكن أن يتضمن الهدف المحرف العام (*). في هذه الحالة، ستبحث واجهة سطر الأوامر عوديًا (recursively) في مجلد المشروع، وستستخدم أول تطابق.

في منصة iOS، موضع ملفات الإعداد نسبةً إلى المجلد الجذري للمشروع غير معروف، لذلك فتحديد الهدف عند القيمة config.xml سينتج عنه cordova-ios-project/MyAppName/config.xml.

target (سلسلة نصية) محدد XPath يشير إلى العنصر المستهدف المراد تعديل خاصياته. إن كنت تستخدم محددات مطلقة (absolute selectors)، فيمكنك استخدام المحرف العام (*) لتحديد العنصر الجذري (root element)، على سبيل المثال، ‎/*/plugins. إن لم يكن المحدد يشير إلى وسم فرعي (child) من المستند المحدد، فستوقف الأداة عملية التثبيت وتعكسها، وتطلق تنبيهًا، ثم ستخرُج مع إعادة قيمة غير معدومة.
mode (سلسلة نصية) تحدد هذه الخاصية الوضع الذي سيحدد نوع التعديلات التي سيتم إجراؤها على الخاصيات.
  • merge - يضيف هذا الوضع الخاصيات المحددة إلى العنصر المستهدف. سيتم استبدال قيم الخاصيات إن كانت الخاصيات المحددة موجودة سلفًا في العنصر المستهدف.
  • overwrite - يستبدل هذا الوضع كل الخاصيات في العنصر المستهدف بالخاصيات المحددة.
إليك المثال التالي:
<!-- plugin-1 -->
<edit-config file="AndroidManifest.xml" target="/manifest/uses-sdk" mode="merge">
    <uses-sdk android:minSdkVersion="16" android:maxSdkVersion="23" />
</edit-config>
<edit-config file="AndroidManifest.xml" target="/manifest/application/activity[@android:name='MainActivity']" mode="overwrite">
    <activity android:name="MainActivity" android:label="NewLabel" android:configChanges="orientation|keyboardHidden" />
</edit-config>

الملف AndroidManifest.xm قبل إضافة plugin-1:

<manifest android:hardwareAccelerated="true" android:versionCode="1" android:versionName="0.0.1" package="io.cordova.hellocordova" xmlns:android="http://schemas.android.com/apk/res/android">
    ...
        <activity android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale" android:label="@string/activity_name" android:launchMode="singleTop" android:name="MainActivity" android:theme="@android:style/Theme.DeviceDefault.NoActionBar" android:windowSoftInputMode="adjustResize">
            ...
        </activity>
    ...
    <uses-sdk android:minSdkVersion="14" android:targetSdkVersion="23" />
</manifest>

الملف AndroidManifest.xml بعد إضافة plugin-1:

<manifest android:hardwareAccelerated="true" android:versionCode="1" android:versionName="0.0.1" package="io.cordova.hellocordova" xmlns:android="http://schemas.android.com/apk/res/android">
    ...
        <activity android:configChanges="orientation|keyboardHidden" android:label="NewLabel" android:name="MainActivity">
            ...
        </activity>
    ...
    <uses-sdk android:maxSdkVersion="23" android:minSdkVersion="16" android:targetSdkVersion="23" />
</manifest>

إدارة تعارضات edit-config

لا يمكن أن تعدل أكثرُ من إضافة واحدة نفس الخاصيات، لأنها قد تتسبب في مشاكل في التطبيق. وسيُطلق خطأ ويفشل تثبيت الإضافة. لذلك يجب حل التعارض في الوسوم edit-config قبل إضافة الإضافة.

أدخل تعديلات على الوسوم المتعارضة لأجل حل التعارض، ثم أزل الإضافات المحدّثة وأعد إضافتها.

هناك خيار يمكن استخدامه إن أردت تثبيت الإضافة حتى بوجود تعارضات. يمكن استخدام الراية ‎--force مع الأمر cordova plugin add. وهذا سيجبر كوردوفا على أن تضيف الإضافة، وسيؤدي إلى عكس التغييرات المتعارضة التي أجرتها الإضافات الأخرى لأجل تجنب المشاكل.

يجب استخدام الراية ‎--force بحذر، لأن عكس التغييرات التي أجرتها الإضافات الأخرى قد يتسبب بمشاكل في عمل التطبيق.

إن لاحظت وجود مشاكل في عمل الإضافات، فأزلها جميعًا ثم أعد إضافتها.

لتفترض أنَّ الإضافة plugin-1 الواردة أعلاه مثبتةٌ بالفعل. إنّ محاولة تثبيت الإضافة plugin-2 أدناه ستؤدي إلى حدوث خطأ، نظرًا لكون الإضافة plugin-1 قد عدّلت سلفًا العنصر uses-sdk الموجود في الملف AndroidManifest.xml.

<!-- plugin-2 -->
<edit-config file="AndroidManifest.xml" target="/manifest/uses-sdk" mode="merge">
    <uses-sdk android:minSdkVersion="15" />
</edit-config>

يمكن إضافة plugin-2 بطريقتين:

الطريقة الأولى لحل التعارضات هي إزالة الوسم edit-config من الإضافة plugin-2 ودمجه في الوسم edit-config الخاص بالإضافة plugin-1 (على افتراض أنَّ الإضافة plugin-1 ليس لها أي مشكلة مع هذا التغيير). أزل كلا الإضافتين، ثم أعد إضافتهما مع هذه التغييرات. يُفترض أن تُضاف الإضافة plugin-2 بدون مشاكل هذه المرة.

إزالة الوسم edit-config من plugin-2 ودمجه في plugin-1:

<!-- plugin-1 -->
<edit-config file="AndroidManifest.xml" target="/manifest/uses-sdk" mode="merge">
    <uses-sdk android:minSdkVersion="15" android:maxSdkVersion="23" />
</edit-config>
<edit-config file="AndroidManifest.xml" target="/manifest/application/activity[@android:name='MainActivity']" mode="overwrite">
    <activity android:name="MainActivity" android:label="NewLabel" android:configChanges="orientation|keyboardHidden" />
</edit-config>

الملف AndroidManifest.xml الناتج بعد إزالة وإعادة إضافة كلا الإضافتين:

<manifest android:hardwareAccelerated="true" android:versionCode="1" android:versionName="0.0.1" package="io.cordova.hellocordova" xmlns:android="http://schemas.android.com/apk/res/android">
    ...
        <activity android:configChanges="orientation|keyboardHidden" android:label="NewLabel" android:name="MainActivity">
            ...
        </activity>
    ...
    <uses-sdk android:maxSdkVersion="23" android:minSdkVersion="15" android:targetSdkVersion="23" />
</manifest>

الطريقة الثانية لإضافة plugin-2 تتطلب أن تُضيف الإضافة مع الراية ‎ --force. سيتم التراجع عن التغييرات المتعارضة التي أجرتها الإضافة plugin-1 في الوسم edit-config وسيتم تطبيق تغييرات plugin-2. الملف AndroidManifest.xml الناتج سيتضمن التغيير uses-sdk من plugin-2 والتغيير activity من plugin-1. لاحظ أنه لم يتم استبدال إلا التغيير uses-sdk وحده من بين التغييرات التي قامت بها الإضافة plugin-1، إذ أنه هو التغيير الوحيد المتعارض.

الملف AndroidManifest.xml الناتج بعد فرض إضافة الإضافة plugin-2:

<manifest android:hardwareAccelerated="true" android:versionCode="1" android:versionName="0.0.1" package="io.cordova.hellocordova" xmlns:android="http://schemas.android.com/apk/res/android">
    ...
        <activity android:configChanges="orientation|keyboardHidden" android:label="NewLabel" android:name="MainActivity">
            ...
        </activity>
    ...
    <uses-sdk android:minSdkVersion="15" android:targetSdkVersion="23" />
</manifest>

ملاحظة: التغييرات المعكوسة عبر الراية ‎--force ستُفقَد بشكل دائم. ولن تعود بعد إزالة الإضافة التي أُضيفت بالقوة. إن كنت بحاجة إلى تلك التغييرات المعكوسة، فينبغي إزالة جميع الإضافات المرتبطة وإعادة إضافتها.

العنصر plugins-plist

يحدد هذا الوسم مفتاحًا (key) وقيمة لإلحاقهما بالملف AppInfo.plist المناسب في مشروع iOS Cordova. هذا الوسم أصبح مهملًا لأنه لا ينطبق إلا على الإصدار cordova-ios 2.2.0 وما قبله. استخدم الوسم <config-file> في إصدارات كوردوفا الأحدث. إليك المثال التالي:
<plugins-plist key="Foo" string="CDVFoo" />

العنصر lib-file

الوسم lib-file يشبه الملفات المصدرية (sources)، والموارد (resources)، والملفات الرئيسية (header files)، ولكنه مخصوص بمنصات مثل BlackBerry 10 التي تستخدم المكتبات المُولّدة من قبل المستخدمين. بالنسبة لمنصة ويندوز، يسمح الوسم <lib-file> بتضمين العنصر <SDKReference> في ملفات مشروع ويندوز المُنشأة.

الخاصيات (النوع)

فقط للمنصة

الوصف
src (سلسلة نصية) (مطلوب)

موضع الملف نسبةً إلى الملف plugin.xml. إذا تعذر العثور على src، فستوقف واجهة سطر الأوامر التثبيت وتعكسه، وتصدر تنبيهًا بشأن المشكلة، ثم تخرج مع إعادة قيمة غير معدومة.

بالنسبة لمنصة ويندوز، فهذه الخاصية تشير إلى اسم إطار العمل SDK المراد تضمينه (والذي سيُستخدَم كقيمة للخاصية Include في العنصر المولد <SDKReference>).

arch (سلسلة نصية) تمثل هذه الخاصية المعمارية (architecture) التي بُنِي الملف ‎.so على أساسها، والتي ستكون إما device أو simulator.

بالنسبة لمنصة ويندوز، هذه الخاصية ستشير إلى أنه لا يجب تضمين العنصر <SDKReference> إلا عند القيام بالبناء لأجل البنية المحددة.

القيم المدعومة هي x86 أو x64 أو ARM.

device-target (سلسلة نصية)

(منصة ويندوز)

القيم المسموح بها: win (أو windows) أو phone أو all.

توضح هذه الخاصية أنه لا يجب تضمين العنصر <SDKReference> إلا عند القيام بالبناء لأجل نوع الجهاز المحدد.

versions (سلسلة نصية)

(منصة ويندوز)

توضح هذه الخاصية أنَّه لا يجب تضمين <SDKReference> إلا عند القيام بالبناء لأجل الإصدارات التي تطابق السلسلة النصية المحددة. قيمة هذه الخاصية قد تكون أي سلسلة نصية تحتوي مجال إصدارات دلالية (semantic version range) صالحة

بالنسبة للأندرويد، يُستخدم العنصر <lib-file> لتثبيت الملفات ‎.jar في المجلد libs الخاص بالمشروع. ولا يدعم إلا الخاصية src التي تحتوي على المسار النسبي للملف ‎.jar.

اطلع على المثال التالي:

<lib-file src="src/BlackBerry10/native/device/libfoo.so" arch="device" />
<lib-file src="src/BlackBerry10/native/simulator/libfoo.so" arch="simulator" />

مثال آخر لمنصة لويندوز:

<lib-file src="Microsoft.WinJS.2.0, Version=1.0" arch="x86" />
<lib-file src="Microsoft.WinJS.2.0, Version=1.0" versions=">=8.1" />
<lib-file src="Microsoft.WinJS.2.0, Version=1.0" target="phone" />
<lib-file src="Microsoft.WinJS.2.0, Version=1.0" target="win" versions="8.0" arch="x86" />

العنصر framework

يحدد هذ الوسم إطار العمل (عادة ما يكون جزءًا من نظام التشغيل أو المنصة) الذي تعتمد عليه الإضافة.

الخاصيات (النوع)

فقط للمنصة

الوصف
src (سلسلة نصية) (مطلوب)

تحدد هذه الخاصية اسم الإطار، أو المسار النسبي لإطارٍ مُضمّنٍ كجزء من ملفات الإضافات.

custom (قيمة منطقية) توضح هذه الخاصية ما إن كان الإطار مضمّنًا كجزء من ملفات الإضافات.
weak (قيمة منطقية) القيمة الافتراضية: false

تبيّن ما إن كان ينبغي أن يكون الإطار موصولًا بروابط ضعيفة (weakly linked).

type (سلسلة نصية) تبيّن نوع الإطار المراد إضافته.
parent (سلسلة نصية) القيمة الافتراضية: .

تضبط هذه الخاصية المسار النسبي إلى المجلد الذي يحتوي على المشروع الفرعي الذي تريد إضافة المرجع إليه. القيمة الافتراضية " ." تعني مشروع التطبيق.

arch (سلسلة نصية)

(منصة ويندوز)

القيم المسموح بها: x86 أو x64 أو ARM.

توضح هذه الخاصية أنه لا يجب تضمين الملف إلا عند القيام بالبناء لأجل المعمارية (architecture) المحددة.

device-target (سلسلة نصية)

(منصة ويندوز)

القيم المسموح بها: win (أو windows) أو phone أو all.

توضح هذه الخاصية أنه لا يجب تضمين الإطار إلا عند القيام بالبناء لأجل نوع الجهاز المحدد.

versions (سلسلة نصية)

(منصة ويندوز)

توضح هذه الخاصية أنه لا يجب تضمين الإطار إلا عند القيام بالبناء لأجل الإصدارات التي تطابق السلسلة النصية المحددة. يمكن أن تكون القيمة أي سلسلة نصية تحتوي مجالًا صالحًا للإصدارات الدلالية (semantic version).
target-dir (سلسلة نصية)

(منصة ويندوز)

تشير هذه الخاصية إلى المجلد الفرعي الذي سيُنسخ فيه الإطار. من الناحية العملية، أهمية هذه الخاصية تظهر عندما تحتوي الإضافة على عدة إصدارات للإطار، ولمُختلف بنيات الشرائح (chip architectures) أو الأجهزة، ولكنها تشترك في نفس الاسم. تتيح لك هذه الخاصية تحديد مجلدات فرعية مختلفة لكل إصدارٍ من الإطار، حتى لا تتداخل مع بعضها البعض.
implementation (سلسلة)

(منصة ويندوز)

تُعيّن هذه الخاصية قيمة المسار النسبي عند الملف dll. الذي يحتوي على تنفيذ (implementation) المُكوِّن WinMD المكتوب بلغة في C++‎.
spec (سلسلة نصية)

(منصة iOS)

تُقرَن هذه الخاصية بالتعبير type="podspec"‎، وتمثل السلسلة النصية التي تحتوي مواصفات مدير الاعتماديات CocoaPod التي تريد تثبيتها (المكتبة الثابتة فقط). CocoaPod ليس مدعومًا إلا في cordova-ios 4.3.0 و cordova-cli 6.4.0. بالنسبة للإضافة الخاصة بك، تأكد من إضافة الوسم <engine> والاعتماديات package.json المناسبة لضمان التوافق مع الإصدارات السابقة.
embed (قيمة منطقية)

(منصة iOS)

القيمة الافتراضية: false

تُقرَن هذه الخاصية مع custom="true"‎

اعط لهذه الخاصية القيمة true إن كنت ترغب في تضمين الإطار المخصص في حزمة التطبيق (app bundle)، بحيث يمكن تحميله ديناميكيًا في وقت التشغيل (إطار ديناميكي). هذا سيضع إطارك المخصص في القسم "Embedded Binaries" في إعدادات مشروع Xcode.

هذه الخاصية مدعومة فقط عند الجمع بين الإصدارين cordova-ios@4.4.0 و cordova-cli@7.0.0.

مثال خاص بمنصة iOS:
<framework src="libsqlite3.dylib" />
<framework src="social.framework" weak="true" />
<framework src="relative/path/to/my.framework" custom="true" />
<framework src="GoogleCloudMessaging" type="podspec" spec="~> 1.2.0" />

على منصة أندرويد (اعتبارًا من الإصدار cordova-android@4.0.0)، يُستخدم الوسم framework لتضمين اعتماديات مُدير المشاريع Maven، أو لتضمين مشروعات المكتبة المجمعة (bundled):

<!-- play من الخدمة GCM الاعتماد على الإصدار الأحدث من -->
<framework src="com.google.android.gms:play-services-gcm:+" />
<!-- appcompat-v7 من مكتبة الدعم v21 الاعتماد على  -->
<framework src="com.android.support:appcompat-v7:21+" />
<!-- الاعتماد على مكتبة المشروع المُتضمنة في الإضافة -->
<framework src="relative/path/FeedbackLib" custom="true" />

يمكن استخدام الوسم framework أيضًا لتضمين الملفات ‎.gradle المخصصة في الملف build.gradle الخاص بالمشروع الرئيسي:

<framework src="relative/path/rules.gradle" custom="true" type="gradleReference" />

على منصة ويندوز، سيؤدي استخدام custom='true'‎ و type='projectReference'‎ إلى إضافة مرجع إلى المشروع، والذي سيُضاف إلى خطوتي الربط والتصريف (compile+link) في مشروع كوردوفا. هذه هي الطريقة الوحيدة حاليًا التي تُمكّن أُطُر العمل المخصصة من استهداف عدة معماريات (architectures)، لأنها تُبنَى بشكل صريح كاعتماديات من قبل تطبيق كوردوفا الذي أنشأ المرجع.

<framework src="path/to/project/LibProj.csproj" custom="true" type="projectReference"/>

أمثلة على استخدام هذه الخاصيات الموجهة لويندوز:

<framework src="src/windows/example.dll" arch="x64" />
<framework src="src/windows/example.dll" versions=">=8.0" />
<framework src="src/windows/example.vcxproj" type="projectReference" target="win" />
<framework src="src/windows/example.vcxproj" type="projectReference" target="all" versions="8.1" arch="x86" />
<framework src="src/windows/example.dll" target-dir="bin/x64" arch="x64" custom="true"/>

هذا مثال آخر على استخدام الخاصيات الموجهة لويندوز لإضافة مرجع إلى مكوّنات WinMD المكتوبة بلغتي C#‎ و C++‎، والتي ستكون واجهتها البرمجية (API) متاحةً وقت التشغيل:

<!-- .winmd يتألف من ملف واحد من النوع C# مكون -->
<framework src="lib\windows\component.winmd" versions="<10.0" />
<!-- مع بيانات وصفية وتقديم منفصل C++ مكون -->
<framework src="lib\windows\x86\cppcomponent.winmd"
           implementation="lib\windows\x86\cppcomponent.dll"
           target-dir="component\x86" arch="x86" versions=">=10.0" />

العنصر info

يحتوي هذا الوسم على معلومات إضافية لأجل تقديمها للمستخدمين. وهو أمر مفيد عندما تحتاج إلى توضيح خطوات إضافية لا يمكن أتمتتها بسهولة، أو تتجاوز إمكانيات واجهة سطر الأوامر. تُطبَع محتويات هذا الوسم عندما تثبّت واجهة سطر الأوامر الإضافة.

مثال على استخدام الوسم info:

<info>
`Android Extras`  من القسم __Google Play Services__ عليك تثبيت 
(run `android`) SDK باستخدام المُدير 

:local.properties تحتاج إلى إضافة السطر التالي إلى 
android.library.reference.1=PATH_TO_ANDROID_SDK/sdk/extras/google/google_play_services/libproject/google-play-services_lib
</info>

العنصر hook

يمثل هذا الوسمُ برنامجك النصي (script) المخصص، والذي سيٌستدعى من قبل كوردوفا عند وقوع حدثٍ معينٍ (بعد إضافة الإضافة مثلًا أو عند استدعاء سلسلة تحضير المنصة). هذا مفيد إن كنت تحتاج إلى توسيع وظائف كوردوفا.

مثال على استخدام الوسم hook:

<hook type="after_plugin_install" src="scripts/afterPluginInstall.js" />
راجع صفحة الخطافات لمزيد من المعلومات.

العنصر uses-permission

في بعض الحالات، قد تحتاج الإضافة إلى إجراء تغييرات على الإعدادات بحسب التطبيق المستهدف. على سبيل المثال، للتسجيل في خدمة C2DM على أندرويد، سيتطلب التطبيق الذي يحمل رقم تعريفه my-app-id إذنًا على النحو التالي:

<uses-permission android:name="my-app-id.permission.C2D_MESSAGE"/>

في حال لم يكن المحتوى المدرج من الملف plugin.xml معروفًا مُقدمًا، يمكن الإشارة إلى المتغيرات بالرمز $ متبوعًا بسلسلة من الحروف الكبيرة، أو الأرقام، أو الشرطات السفلية. في المثال أعلاه، سيتضمن الملف plugin.xml هذا الوسم:

<uses-permission android:name="$PACKAGE_NAME.permission.C2D_MESSAGE"/>

تستبدل واجهة سطر الأوامر مراجع المتغيرات بالقيمة المحددة، أو بسلسلة نصية فارغة إذا لم يتم العثور عليها. قد تُرصَد قيمة مرجع المتغير (في هذه الحالة، من الملف AndroidManifest.xml)، أو تُحدَّد من قبل مستخدم الأداة فيما تعتمد تفاصيل العملية على الأداة المستخدمة.

يمكن أن تطلب الأداة Plugman من المستخدمين تحديد المتغيرات المطلوبة للإضافة. على سبيل المثال، يمكن تحديد مفاتيح الواجهة البرمجية من أجل C2M وخرائط Google كوسائط لسطر الأوامر:

plugman --platform android --project /path/to/project --plugin name|git-url|path --variable API_KEY=!@CFATGWE%^WGSFDGSDFW$%^#$%YTHGsdfhsfhyer56734‎

بعض أسماء المتغيرات يجب أن تكون محجوزةً، مثل الاسم PACKAGE_NAME$. هذا هو معرِّف نمط النطاق العكسي (reverse-domain style identifier) للحزمة، ويقابله CFBundleIdentifier على منصة iOS، والخاصية package في العنصر الجذري manifest في الملف AndroidManifest.xml.

العنصر preference

كما هو موضح في القسم السابق، قد تتطلب الإضافة أحيانًا من المستخدم تحديد قيمٍ لمتغيراتها. لجعل تلك المتغيرات إلزامية، يجب أن يحتوي الوسم <platform> على الوسم <preference>. تتحقق واجهة سطر الأوامر من أنَّ تلك التفضيلات الإلزامية متوفرة. وإلا، فستنبه المستخدم إلى كيفية تمرير المتغيرات، ثم ستخرج مع إعادة قيمة مخالفة للصفر. يمكن الإشارة إلى التفضيلات في أماكن أخرى في الملف plugin.xml باستخدام الصياغة PREFERENCE_NAME$.

الخاصيات (النوع)

فقط للمنصة

الوصف
name (سلسلة نصية) (مطلوب)

اسم المتغير. لا يمكن أن يحتوي إلا على الأحرف الكبيرة والأرقام والشرطات السفلية.

default (سلسلة نصية) القيمة الافتراضية للمتغير. في حال تحديدها، فسيتم استخدامها، ولن يُطلق أي خطأ إذا لم يُدخِل المستخدم أي قيمة.
مثال على استخدام الوسم preference:
<preference name="MY_CUSTOM_STRING" default="default-value" />
<!--
    plugin.xml التفضيلات يمكن أن توضع في أي مكان في الملف
-->
<config-file target="./res/values/strings.xml" parent="/resources">
    <string name="custom">$MY_CUSTOM_STRING</string>
</config-file>

انظر أيضًا

مصادر