You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/12/17 21:31:37 UTC
svn commit: r1551686 [19/19] - in /cordova/site/public/docs/en: 3.3.0/ edge/
Modified: cordova/site/public/docs/en/edge/plugin_ref_spec.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/plugin_ref_spec.md.html?rev=1551686&r1=1551685&r2=1551686&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/plugin_ref_spec.md.html (original)
+++ cordova/site/public/docs/en/edge/plugin_ref_spec.md.html Tue Dec 17 20:31:35 2013
@@ -17,16 +17,18 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
-<meta name="generator" content="joDoc">
-<title>Apache Cordova API Documentation</title>
-<link rel="stylesheet" type="text/css" href="index.css">
-<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
-<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
-</head>
-<body>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+ <meta name="generator" content="joDoc">
+
+ <title>Apache Cordova API Documentation</title>
+
+ <link rel="stylesheet" type="text/css" href="index.css">
+ <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+ <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+ </head>
+ <body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -92,7 +94,8 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select></small>
+</optgroup></select>
+ </small>
</div>
<div id="subheader">
<h1>Plugin Specification</h1>
@@ -193,10 +196,8 @@ structure of the plugin.</p>
version="1.0.2">
</code></pre>
-<h2>
-<a name="Plugin%20Specification_plugin_element">
-plugin Element</a>
-</h2>
+<h2><a name="Plugin%20Specification_plugin_element">
+plugin Element</a></h2>
<p>The <code>plugin</code> element is the plugin manifest's top-level element. It
features the following attributes:</p>
@@ -219,10 +220,9 @@ major-minor-patch style regular expressi
</code></pre>
</li>
</ul>
-<h2>
-<a name="Plugin%20Specification_engines_and_engine_elements">
-engines and engine Elements</a>
-</h2>
+
+<h2><a name="Plugin%20Specification_engines_and_engine_elements">
+engines and engine Elements</a></h2>
<p>The child elements of the <code><engines></code> element specify versions of
Apache Cordova-based frameworks that this plugin supports. An example:</p>
@@ -301,16 +301,15 @@ Ideally, this file should be within the
to say supported for all platforms, specify multiple with a pipe character like <code>android|ios|blackberry10</code>
or just a single platform like <code>android</code>.</p></li>
</ul>
+
<p>plugman aborts with a non-zero code for any plugin whose target
project does not meet the engine's constraints.</p>
<p>If no <code><engine></code> tags are specified, plugman attempts to install into
the specified cordova project directory blindly.</p>
-<h2>
-<a name="Plugin%20Specification_name_element">
-name Element</a>
-</h2>
+<h2><a name="Plugin%20Specification_name_element">
+name Element</a></h2>
<p>A human-readable name for the plugin, whose text content contains the
name of the plugin. For example:</p>
@@ -320,10 +319,8 @@ name of the plugin. For example:</p>
<p>This element does not (yet) handle localization.</p>
-<h2>
-<a name="Plugin%20Specification_description_element">
-description Element</a>
-</h2>
+<h2><a name="Plugin%20Specification_description_element">
+description Element</a></h2>
<p>A human-readable description for the plugin. The text content of the element contains
the description of the plugin. An example:</p>
@@ -333,10 +330,8 @@ the description of the plugin. An exampl
<p>This element does not (yet) handle localization.</p>
-<h2>
-<a name="Plugin%20Specification_author_element">
-author Element</a>
-</h2>
+<h2><a name="Plugin%20Specification_author_element">
+author Element</a></h2>
<p>Plugin author name. The text content of the element contains
the name of the plugin author. An example:</p>
@@ -344,30 +339,24 @@ the name of the plugin author. An exampl
<pre class="prettyprint"><code><author>Foo plugin description</author>
</code></pre>
-<h2>
-<a name="Plugin%20Specification_keywords_element">
-keywords Element</a>
-</h2>
+<h2><a name="Plugin%20Specification_keywords_element">
+keywords Element</a></h2>
<p>Plugin keywords. The text content of the element contains comma separated keywords to describe the plugin. An example:</p>
<pre class="prettyprint"><code><keywords>foo,bar</keywords>
</code></pre>
-<h2>
-<a name="Plugin%20Specification_license_element">
-license Element</a>
-</h2>
+<h2><a name="Plugin%20Specification_license_element">
+license Element</a></h2>
<p>Plugin license. The text content of the element contains the plugin license. An example:</p>
<pre class="prettyprint"><code><license>Apache 2.0 License</license>
</code></pre>
-<h2>
-<a name="Plugin%20Specification_asset_element">
-asset Element</a>
-</h2>
+<h2><a name="Plugin%20Specification_asset_element">
+asset Element</a></h2>
<p>One or more elements listing the files or directories to be copied
into a Cordova app's <code>www</code> directory. Examples:</p>
@@ -407,10 +396,9 @@ issues a notification about the conflict
code.</p>
</li>
</ul>
-<h2>
-<a name="Plugin%20Specification_js_module_element">
-js-module Element</a>
-</h2>
+
+<h2><a name="Plugin%20Specification_js_module_element">
+js-module Element</a></h2>
<p>Most plugins include one or more JavaScript files. Each <code><js-module></code>
tag corresponds to a JavaScript file, and prevents the plugin's users
@@ -470,6 +458,7 @@ modules via <code>cordova.require</code>
</ul>
</li>
</ul>
+
<p>If <code>src</code> does not resolve to an existing file, plugman stops and
reverses the installation, issues a notification of the problem, and
exits with a non-zero code.</p>
@@ -477,10 +466,8 @@ exits with a non-zero code.</p>
<p>Nesting <code><js-module></code> elements within <code><platform></code> declares
platform-specific JavaScript module bindings.</p>
-<h2>
-<a name="Plugin%20Specification_dependency_element">
-dependency Element</a>
-</h2>
+<h2><a name="Plugin%20Specification_dependency_element">
+dependency Element</a></h2>
<p>The <code><dependency></code> tag allows you to specify other plugins on which the
current plugin depends. While future versions will access them from
@@ -504,6 +491,7 @@ subdirectory of the git repository. This
allows the repository to contain several related plugins, each
specified individually.</p></li>
</ul>
+
<p>In the future, version constraints will be introduced, and a plugin
repository will exist to support fetching by name instead of explicit
URLs.</p>
@@ -521,10 +509,8 @@ installed the plugin with a local path d
the root of the git repository and then finds the other plugin from
there.</p>
-<h2>
-<a name="Plugin%20Specification_platform_element">
-platform Element</a>
-</h2>
+<h2><a name="Plugin%20Specification_platform_element">
+platform Element</a></h2>
<p>The <code><platform></code> tag identifies platforms that have associated native
code or require modifications to their configuration files. Tools
@@ -558,10 +544,9 @@ chosen, are listed:</p>
<li>wp7</li>
<li>wp8</li>
</ul>
-<h2>
-<a name="Plugin%20Specification_source_file_element">
-source-file Element</a>
-</h2>
+
+<h2><a name="Plugin%20Specification_source_file_element">
+source-file Element</a></h2>
<p>The <code><source-file></code> element identifies executable source code that
should be installed into a project. Examples:</p>
@@ -603,10 +588,9 @@ project.</p></li>
If set, assigns the specified compiler flags for the particular
source file.</p></li>
</ul>
-<h2>
-<a name="Plugin%20Specification_config_file_element">
-config-file Element</a>
-</h2>
+
+<h2><a name="Plugin%20Specification_config_file_element">
+config-file Element</a></h2>
<p>Identifies an XML-based configuration file to be modified, where in
that document the modification should take place, and what should be
@@ -675,10 +659,9 @@ document, the tool stops and reverses th
issues a warning, and exits with a non-zero code.</p>
</li>
</ul>
-<h2>
-<a name="Plugin%20Specification_plugins_plist_element">
-plugins-plist Element</a>
-</h2>
+
+<h2><a name="Plugin%20Specification_plugins_plist_element">
+plugins-plist Element</a></h2>
<p>This is <em>outdated</em> as it only applies to cordova-ios 2.2.0 and
below. Use the <code><config-file></code> tag for newer versions of Cordova.</p>
@@ -698,10 +681,8 @@ file in an iOS Cordova project. For exam
<pre class="prettyprint"><code><plugins-plist key="Foo" string="CDVFoo" />
</code></pre>
-<h2>
-<a name="Plugin%20Specification_resource_file_and_header_file_elements">
-resource-file and header-file Elements</a>
-</h2>
+<h2><a name="Plugin%20Specification_resource_file_and_header_file_elements">
+resource-file and header-file Elements</a></h2>
<p>Like source files, but specifically for platforms such as iOS that
distinguish between source files, headers, and resources. Examples:</p>
@@ -711,10 +692,8 @@ distinguish between source files, header
<header-file src="CDVFoo.h" />
</code></pre>
-<h2>
-<a name="Plugin%20Specification_lib_file_element">
-lib-file Element</a>
-</h2>
+<h2><a name="Plugin%20Specification_lib_file_element">
+lib-file Element</a></h2>
<p>Like source, resource, and header files, but specifically for
platforms such as BlackBerry 10 that use user-generated libraries.
@@ -735,10 +714,9 @@ non-zero code.</p></li>
<li><p><code>arch</code>: The architecture for which the <code>.so</code> file has been built,
either <code>device</code> or <code>simulator</code>.</p></li>
</ul>
-<h2>
-<a name="Plugin%20Specification_framework_element">
-framework Element</a>
-</h2>
+
+<h2><a name="Plugin%20Specification_framework_element">
+framework Element</a></h2>
<p>Identifies a framework (usually part of the OS/platform) on which the plugin depends.</p>
@@ -755,10 +733,8 @@ platform.</p>
<p>The optional <code>weak</code> attribute is a boolean indicating whether the
framework should be weakly linked. The default is <code>false</code>.</p>
-<h2>
-<a name="Plugin%20Specification_info_element">
-info Element</a>
-</h2>
+<h2><a name="Plugin%20Specification_info_element">
+info Element</a></h2>
<p>Additional information provided to users. This is useful when you
require extra steps that can't be easily automated or are beyond
@@ -773,9 +749,7 @@ android.library.reference.1=PATH_TO_ANDR
</info>
</code></pre>
-<h2>
-<a name="Plugin%20Specification_variables">Variables</a>
-</h2>
+<h2><a name="Plugin%20Specification_variables">Variables</a></h2>
<p>In certain cases, a plugin may need to make configuration changes
dependent on the target application. For example, to register for C2DM
@@ -820,9 +794,7 @@ non-zero code.</p>
<p>Certain variable names should be reserved, as listed below.</p>
-<h2>
-<a name="Plugin%20Specification_package_name">$PACKAGE_NAME</a>
-</h2>
+<h2><a name="Plugin%20Specification_package_name">$PACKAGE_NAME</a></h2>
<p>The reverse-domain style unique identifier for the package,
corresponding to the <code>CFBundleIdentifier</code> on iOS or the <code>package</code>
@@ -833,6 +805,7 @@ attribute of the top-level <code>manifes
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
-</body>
+ <script type="text/javascript" src="index.js"></script>
+ <script type="text/javascript" src="prettify/prettify.js"></script>
+ </body>
</html>