Return-Path: X-Original-To: apmail-cordova-dev-archive@www.apache.org Delivered-To: apmail-cordova-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 1824D18E10 for ; Mon, 1 Feb 2016 04:44:38 +0000 (UTC) Received: (qmail 94976 invoked by uid 500); 1 Feb 2016 04:44:34 -0000 Delivered-To: apmail-cordova-dev-archive@cordova.apache.org Received: (qmail 94925 invoked by uid 500); 1 Feb 2016 04:44:34 -0000 Mailing-List: contact dev-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cordova.apache.org Delivered-To: mailing list dev@cordova.apache.org Received: (qmail 94914 invoked by uid 99); 1 Feb 2016 04:44:34 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 01 Feb 2016 04:44:34 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id E0FD1DFF70; Mon, 1 Feb 2016 04:44:33 +0000 (UTC) From: rakatyal To: dev@cordova.apache.org Reply-To: dev@cordova.apache.org References: In-Reply-To: Subject: [GitHub] cordova-docs pull request: CB-10364: Making plugin.xml a reference Content-Type: text/plain Message-Id: <20160201044433.E0FD1DFF70@git1-us-west.apache.org> Date: Mon, 1 Feb 2016 04:44:33 +0000 (UTC) Github user rakatyal commented on a diff in the pull request: https://github.com/apache/cordova-docs/pull/474#discussion_r51379032 --- Diff: www/docs/en/dev/plugin_ref/spec.md --- @@ -17,700 +17,489 @@ license: > specific language governing permissions and limitations under the License. -title: Plugin Specification +title: Plugin.xml --- -# Plugin Specification - -The `plugin.xml` file is an XML document in the `plugins` namespace: -`http://apache.org/cordova/ns/plugins/1.0`. It contains a top-level -`plugin` element that defines the plugin, and children that define the -structure of the plugin. - -A sample plugin element: +# Plugin.xml - - +Plugin.xml file defines the structure and settings required for your plugin. It has several elements to provide details about your plugin. -## _plugin_ Element +## plugin -The `plugin` element is the plugin manifest's top-level element. It -features the following attributes: + The `plugin` element is the plugin manifest's top-level element. -* `xmlns` (required): - The plugin namespace, `http://apache.org/cordova/ns/plugins/1.0`. If - the document contains XML from other namespaces, such as tags to be - added to the `AndroidManifest.xml` file, those namespaces should - also be included in the top-level element. + Attributes(type) | Description + ---------------- | ------------ + xmlns(string) | *Required*
The plugin namespace, `http://apache.org/cordova/ns/plugins/1.0`. If the document contains XML from other namespaces, such as tags to be added to the `AndroidManifest.xml` file, those namespaces should also be included in the element. + id(string) | *Required*
A reverse-domain style identifier for the plugin. + version(string) | *Required*
A version number for the plugin, that matches the following major-minor-patch style regular expression: `^\d+[.]\d+[.]\d+$` -* `id` (required): - A reverse-domain style identifier for the plugin, such as - `com.alunny.foo` + Example: + ``` + + + ``` -* `version` (required): - A version number for the plugin, that matches the following - major-minor-patch style regular expression: +### engines and engine - ^\d+[.]\d+[.]\d+$ + The child elements of the `` element specify versions of Apache Cordova-based frameworks that this plugin supports. Plugman aborts with a non-zero code for any plugin whose target project does not meet the engine's constraints. If no tags are specified, plugman attempts to install into the specified cordova project directory blindly. -## _engines_ and _engine_ Elements + Attributes(type) | Description + ---------------- | ------------ + name(string) | *Required*
Name of the engine. Here are the default engines that are supported :

`cordova`
`cordova-plugman`
`cordova-android`
`cordova-ios`
`cordova-blackberry10`
`cordova-wp8`
`cordova-windows`
`android-sdk` // returns the highest Android api level installed
`apple-xcode` // returns the xcode version
`apple-ios` // returns the highest iOS version installed
`apple-osx` // returns the OSX version
`blackberry-ndk` // returns the native blackberry SDK version