cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tim...@apache.org
Subject docs commit: [CB-4036] - updated docs on engine tags
Date Tue, 27 Aug 2013 22:50:19 GMT
Updated Branches:
  refs/heads/master fcd56a46a -> 9854fb170


[CB-4036] - updated docs on engine tags


Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/9854fb17
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/9854fb17
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/9854fb17

Branch: refs/heads/master
Commit: 9854fb170280c93007c25260fde066b106f46db3
Parents: fcd56a4
Author: Tim Kim <timk@adobe.com>
Authored: Tue Aug 27 15:49:25 2013 -0700
Committer: Tim Kim <timk@adobe.com>
Committed: Tue Aug 27 15:50:03 2013 -0700

----------------------------------------------------------------------
 docs/en/edge/plugin_ref/spec.md | 45 +++++++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9854fb17/docs/en/edge/plugin_ref/spec.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/plugin_ref/spec.md b/docs/en/edge/plugin_ref/spec.md
index d6d2ee8..53551d7 100644
--- a/docs/en/edge/plugin_ref/spec.md
+++ b/docs/en/edge/plugin_ref/spec.md
@@ -61,7 +61,7 @@ Apache Cordova-based frameworks that this plugin supports. An example:
     <engines>
         <engine name="cordova" version="1.7.0" />
         <engine name="cordova" version="1.8.1" />
-        <engine name="worklight" version="1.0.0" />
+        <engine name="worklight" version="1.0.0" platform="android" scriptSrc="worklight_version"/>
     </engines>
 
 Similar to the `<plugin>` element's `version` attribute, the specified
@@ -80,6 +80,49 @@ example:
         <engine name="cordova" version="<1.8.1" />
     </engines>
 
+The '<engine>' tags also has default support for all of the main platforms Cordova
exists on. 
+Specifying the 'cordova' engine tag means that all versions of Cordova on any platform must
+satisfy the engine version attribute. You may also list specific platforms and their versions
+in order to override the catch-all 'cordova' 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>
+
+Here's a list of the default engines that the '<engine>' tag supports:
+    * 'cordova' 
+    * 'cordova-plugman' 
+    * 'cordova-android'
+    * 'cordova-ios'
+    * 'cordova-blackberry10' 
+    * 'cordova-wp7'
+    * 'cordova-wp8'
+    * 'cordova-windows8'  
+    
+Specifying custom Apache Cordova-based frameworks should be listed under the engine tag like
so:
+
+    <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>
+
+A custom Apache Cordova-based framework requires that an engine element includes the following
attributes: 
+'name', 'version', 'scriptSrc', and 'platform'. 
+
+* `name` (required): A human-readable name for your custom framework. 
+
+* `version` (required): The version that your framework must have in order to install.
+
+* `scriptSrc` (required): The script file that tells plugman what version of the custom framework
is. 
+Ideally, this file should be within the top level directory of your plugin folder.
+
+* `platform` (required): Which platforms that your framework supports. You may use the wildcard
'*'
+to say supported for all platforms, specify multiple with a pipe character like 'android|ios|blackberry10'

+or just a single platform like 'android'.
+
 plugman aborts with a non-zero code for any plugin whose target
 project does not meet the engine's constraints.
 


Mime
View raw message