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/08/02 00:17:47 UTC
svn commit: r1509456 [11/21] - in /cordova/site/public/docs: en/1.5.0/
en/1.5.0rc1/ en/1.6.0/ en/1.6.0rc1/ en/1.6.1/ en/1.7.0/ en/1.7.0rc1/
en/1.8.0/ en/1.8.0rc1/ en/1.8.1/ en/1.9.0/ en/1.9.0rc1/ en/2.0.0/
en/2.0.0rc1/ en/2.1.0/ en/2.1.0rc1/ en/2.1.0rc...
Modified: cordova/site/public/docs/en/3.0.0/plugin_ref_spec.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.0.0/plugin_ref_spec.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.0.0/plugin_ref_spec.md.html (original)
+++ cordova/site/public/docs/en/3.0.0/plugin_ref_spec.md.html Thu Aug 1 22:17:43 2013
@@ -82,17 +82,32 @@
<div id="subheader">
<h1>Plugin Specification</h1>
<small><select><option value="Plugin%2520Specification">Plugin Specification</option>
-<option value="Plugin%20Specification_plugin_element">Â Â Â Â Â Â - <plugin> element</option>
-<option value="Plugin%20Specification_engines_and_engine_elements">Â Â Â Â Â Â - <engines> and <engine> elements</option>
-<option value="Plugin%20Specification_name_element">Â Â Â Â Â Â - <name> element</option>
-<option value="Plugin%20Specification_asset_element">Â Â Â Â Â Â - <asset> element</option>
-<option value="Plugin%20Specification_js_module_element">Â Â Â Â Â Â - <js-module> element</option>
+<option value="Plugin%20Specification_plugin_element">Â Â Â Â Â Â -
+<plugin> element</option>
+<option value="Plugin%20Specification_engines_and_engine_elements">Â Â Â Â Â Â -
+<engines> and <engine> elements</option>
+<option value="Plugin%20Specification_name_element">Â Â Â Â Â Â -
+<name> element</option>
+<option value="Plugin%20Specification_description_element">Â Â Â Â Â Â -
+<description> element</option>
+<option value="Plugin%20Specification_author_element">Â Â Â Â Â Â -
+<author> element</option>
+<option value="Plugin%20Specification_keywords_element">Â Â Â Â Â Â -
+<keywords> element</option>
+<option value="Plugin%20Specification_license_element">Â Â Â Â Â Â -
+<license> element</option>
+<option value="Plugin%20Specification_asset_element">Â Â Â Â Â Â -
+<asset> element</option>
+<option value="Plugin%20Specification_js_module_element">Â Â Â Â Â Â -
+<js-module> element</option>
<option value="Plugin%20Specification_dependency">Â Â Â Â Â Â - <dependency></option>
<option value="Plugin%20Specification_platform">Â Â Â Â Â Â - <platform></option>
<option value="Plugin%20Specification_source_file">Â Â Â Â Â Â - <source-file></option>
<option value="Plugin%20Specification_config_file">Â Â Â Â Â Â - <config-file></option>
<option value="Plugin%20Specification_plugins_plist">Â Â Â Â Â Â - <plugins-plist></option>
-<option value="Plugin%20Specification_resource_file_and_header_file">Â Â Â Â Â Â - <resource-file> and <header-file></option>
+<option value="Plugin%20Specification_resource_file_and_header_file">Â Â Â Â Â Â -
+<resource-file> and <header-file>
+</option>
<option value="Plugin%20Specification_lib_file">Â Â Â Â Â Â - <lib-file></option>
<option value="Plugin%20Specification_framework">Â Â Â Â Â Â - <framework></option>
<option value="Plugin%20Specification_info">Â Â Â Â Â Â - <info></option>
@@ -107,7 +122,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -155,7 +169,8 @@ structure of the plugin.</p>
</code></pre>
<h2>
-<a name="Plugin%20Specification_plugin_element"><plugin> element</a>
+<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
@@ -175,11 +190,13 @@ A reverse-domain style identifier for th
A version number for the plugin, that matches the following
major-minor-patch style regular expression:</p>
-<p>^\d+[.]\d+[.]\d+$</p>
+<pre class="prettyprint"><code>^\d+[.]\d+[.]\d+$
+</code></pre>
</li>
</ul>
<h2>
-<a name="Plugin%20Specification_engines_and_engine_elements"><engines> and <engine> elements</a>
+<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
@@ -196,7 +213,7 @@ Apache Cordova-based frameworks that thi
version string should match a major-minor-patch string conforming to
the regular expression:</p>
-<pre class="prettyprint"><code>^\d+[.]\d+[.]\d+$
+<pre class="prettyprint"><code> ^\d+[.]\d+[.]\d+$
</code></pre>
<p>Engine elements may also specify fuzzy matches to avoid repetition,
@@ -217,7 +234,8 @@ project does not meet the engine's const
the specified cordova project directory blindly.</p>
<h2>
-<a name="Plugin%20Specification_name_element"><name> element</a>
+<a name="Plugin%20Specification_name_element">
+<name> element</a>
</h2>
<p>A human-readable name for the plugin, whose text content contains the
@@ -229,7 +247,52 @@ name of the plugin. For example:</p>
<p>This element does not (yet) handle localization.</p>
<h2>
-<a name="Plugin%20Specification_asset_element"><asset> element</a>
+<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>
+
+<pre class="prettyprint"><code><description>Foo plugin description</description>
+</code></pre>
+
+<p>This element does not (yet) handle localization.</p>
+
+<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>
+
+<pre class="prettyprint"><code><author>Foo plugin description</author>
+</code></pre>
+
+<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>
+
+<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>
<p>One or more elements listing the files or directories to be copied
@@ -271,7 +334,8 @@ code.</p>
</li>
</ul>
<h2>
-<a name="Plugin%20Specification_js_module_element"><js-module> element</a>
+<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>
@@ -311,16 +375,16 @@ above, with an <code>id</code> of <code>
<p>Three tags are allowed within <code><js-module></code>:</p>
<ul>
-<li><p><code><clobbers target="some.value" /></code> indicates that the
+<li><p><code><clobbers target="some.value"/></code> indicates that the
<code>module.exports</code> is inserted into the <code>window</code> object as
<code>window.some.value</code>. You can have as many <code><clobbers></code> as you
like. Any object not available on <code>window</code> is created.</p></li>
-<li><p><code><merges target="some.value" /></code> indicates that the module
+<li><p><code><merges target="some.value"/></code> indicates that the module
should be merged with any existing value at <code>window.some.value</code>.
If any key already exists, the module's version overrides the
original. You can have as many <code><merges></code> as you like. Any
object not available on <code>window</code> is created.</p></li>
-<li><p><code><runs /></code> means that your code should be specified with
+<li><p><code><runs/></code> means that your code should be specified with
<code>cordova.require</code>, but not installed on the <code>window</code>
object. This is useful when initializing the module, attaching
event handlers or otherwise. You can only have up to one
@@ -553,7 +617,9 @@ file in an iOS Cordova project. For exam
</code></pre>
<h2>
-<a name="Plugin%20Specification_resource_file_and_header_file"><resource-file> and <header-file></a>
+<a name="Plugin%20Specification_resource_file_and_header_file">
+<resource-file> and <header-file>
+</a>
</h2>
<p>Like source files, but specifically for platforms such as iOS that
Modified: cordova/site/public/docs/en/3.0.0rc1/index.css
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.0.0rc1/index.css?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.0.0rc1/index.css (original)
+++ cordova/site/public/docs/en/3.0.0rc1/index.css Thu Aug 1 22:17:43 2013
@@ -412,7 +412,6 @@ Assumes table is 2D grid, with single TH
.compat .n::before { content: "\2718"; margin-right: 6px; }
.compat .p { background-color: gold; }
-.compat .p::before { content: "(partial)"; }
.compat .u { background-color: #dddddd; }
Modified: cordova/site/public/docs/en/edge/_index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/_index.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/_index.html (original)
+++ cordova/site/public/docs/en/edge/_index.html Thu Aug 1 22:17:43 2013
@@ -91,7 +91,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
Modified: cordova/site/public/docs/en/edge/config_ref_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/config_ref_index.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/config_ref_index.md.html (original)
+++ cordova/site/public/docs/en/edge/config_ref_index.md.html Thu Aug 1 22:17:43 2013
@@ -82,7 +82,6 @@
<div id="subheader">
<h1>Configuration Reference</h1>
<small><select><option value="Configuration%2520Reference">Configuration Reference</option>
-<option value="Configuration%20Reference_platform_specific_properties">Â Â Â Â Â Â - Platform-Specific Properties</option>
<option value="Configuration%20Reference_config_xml_elements">Â Â Â Â Â Â - config.xml Elements</option></select></small>
</div>
@@ -93,7 +92,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -126,27 +124,27 @@
<div id="content">
<h1><a name="Configuration%20Reference">Configuration Reference</a></h1>
-<p>You can set various application configuration parameters using a platform-agnostic configuration file, <code>config.xml</code>.
-This file is based on the W3C <a class="external" href="http://www.w3.org/TR/widgets/">Packaged Web Apps (Widgets)</a> specification.</p>
-
-<p>The location of the <code>config.xml</code> file is different depending on the platform. The contents, in general, are not.</p>
-
-<h2>
-<a name="Configuration%20Reference_platform_specific_properties">Platform-Specific Properties</a>
-</h2>
-
-<p>As with any abstraction layer, Apache Cordova cannot be a perfect silver bullet. As such, some native and platform-specific
-properties, characteristics and behaviours are encapsulated as much as possible as <code><preference></code> elements inside the
-<code>config.xml</code> file. The following sub-sections linked to are guides which go into more details about these preferences.</p>
+<p>Many aspects of an application's behavior can be controlled with a
+platform-agnostic configuration file, <code>config.xml</code>, which is formatted
+based on the W3C's
+<a class="external" href="http://www.w3.org/TR/widgets/">Packaged Web Apps (Widgets)</a>
+specification.</p>
+
+<p>For projects created with the Cordova CLI (described in <a href="#The%0ACommand-line%20Interface">The
+Command-line Interface</a>), this file can be found in the top-level <code>www</code>
+directory. Using the CLI to build projects regenerates versions of
+this file in various subdirectories within <code>platforms</code>. For non-CLI
+projects, each platform-specific file serves as a source.</p>
+
+<p>While the location of the <code>config.xml</code> file may change depending on
+the platform, its contents generally do not. Some platform-specific
+features are also specified in the same configuration file. Details
+are listed below:</p>
<ul>
<li><a href="guide_platforms_ios_config.md.html#iOS%20Configuration">iOS Configuration</a></li>
<li><a href="guide_platforms_android_config.md.html#Android%20Configuration">Android Configuration</a></li>
<li><a href="guide_platforms_blackberry_config.md.html#BlackBerry%20Configuration">BlackBerry Configuration</a></li>
-<li>Windows Phone 7 Configuration</li>
-<li>Windows Phone 8 Configuration</li>
-<li>Windows 8 Configuration</li>
-<li><a href="guide_platforms_firefoxos_config.md.html#FirefoxOS%20Configuration">FirefoxOS Configuration</a></li>
</ul>
<h2>
<a name="Configuration%20Reference_config_xml_elements">config.xml Elements</a>
@@ -161,9 +159,7 @@ Apache Cordova project aims to abstract
<pre class="prettyprint"><code> <widget>
<preference name="MySetting" value="true" />
- <plugins>
- <plugin name="MyPlugin" value="MyPluginClass" />
- </plugins>
+ <feature name="MyPlugin" value="MyPluginClass" />
<access origin="*" />
<content src="index.html" />
</widget>
@@ -171,13 +167,12 @@ Apache Cordova project aims to abstract
<p>A list of supported elements across major platforms which are supported in Apache Cordova follow.</p>
-<h3><code><plugin></code></h3>
+<h3><code><feature></code></h3>
<p>These elements map to native APIs that the application accesses. At
-runtime, the Apache Cordova framework checks the <code><plugin></code> elements
-and maps them to native code to enable your Cordova application to
-access device APIs otherwise unavailable to typical web-based
-applications.</p>
+runtime, the Apache Cordova framework maps <code><feature></code> elements to
+native code to enable your Cordova application to access device APIs
+otherwise unavailable to typical web-based applications.</p>
<h3><code><access></code></h3>
@@ -187,7 +182,7 @@ applications.</p>
<h3><code><content></code></h3>
<p>This element defines your application's start page relative to the
-project's standard web assets root folder. This element is optional,
+project's standard web assets root directory. This element is optional,
the default is <code>index.html</code>.</p>
</div>
Modified: cordova/site/public/docs/en/edge/cordova_accelerometer_accelerometer.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_accelerometer_accelerometer.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_accelerometer_accelerometer.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_accelerometer_accelerometer.md.html Thu Aug 1 22:17:43 2013
@@ -85,7 +85,7 @@
<option value="Accelerometer_methods">Â Â Â Â Â Â - Methods</option>
<option value="Accelerometer_arguments">Â Â Â Â Â Â - Arguments</option>
<option value="Accelerometer_objects_read_only">Â Â Â Â Â Â - Objects (Read-Only)</option>
-<option value="Accelerometer_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Accelerometer_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</option>
<option value="accelerometer.getCurrentAcceleration_description">Â Â Â Â Â Â - Description</option>
<option value="accelerometer.getCurrentAcceleration_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
@@ -123,7 +123,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -186,39 +185,53 @@
<li><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></li>
</ul>
<h2>
-<a name="Accelerometer_permissions">Permissions</a>
+<a name="Accelerometer_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
+<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
+Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-line%0AInterface">The Command-line
+Interface</a>, to add or remove this feature for a project:</p>
-<h4>app/res/xml/config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a>" value="org.apache.cordova.AccelListener" />
+<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git
+ $ cordova plugin rm org.apache.cordova.core.device-motion
</code></pre>
-<h3>BlackBerry WebWorks</h3>
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
-<h4>www/plugins.xml</h4>
+<ul>
+<li>
+<p>Android (in <code>app/res/xml/config.xml</code>)</p>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a>" value="org.apache.cordova.accelerometer.<a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a>" />
+<pre class="prettyprint"><code><feature name="<a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a>">
+ <param name="android-package" value="org.apache.cordova.AccelListener" />
+</feature>
</code></pre>
+</li>
+<li>
+<p>BlackBerry WebWorks</p>
-<h4>www/config.xml</h4>
+<pre class="prettyprint"><code>(in www/plugins.xml)
+<feature name="<a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a>">
+ <param name="blackberry-package" value="org.apache.cordova.accelerometer.<a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a>" />
+</feature>
-<pre class="prettyprint"><code><feature id="blackberry.system" required="true" version="1.0.0.0" />
+
+(in www/config.xml)
+<feature id="blackberry.system" required="true" version="1.0.0.0" />
<feature id="org.apache.cordova" required="true" version="1.0.0" />
</code></pre>
+</li>
+<li>
+<p>iOS (in <code>config.xml</code>)</p>
-<h3>iOS</h3>
-
-<h4>config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a>" value="CDVAccelerometer" />
+<pre class="prettyprint"><code><feature name="<a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a>">
+ <param name="ios-package" value="CDVAccelerometer" />
+</feature>
</code></pre>
-
-<h3>Windows Phone</h3>
-
-<h4>Properties/WPAppManifest.xml</h4>
+</li>
+<li>
+<p>Windows Phone (in <code>Properties/WPAppManifest.xml</code>)</p>
<pre class="prettyprint"><code><Capabilities>
<Capability Name="ID_CAP_SENSORS" />
@@ -226,11 +239,10 @@
</code></pre>
<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
-
-<h3>Tizen</h3>
-
-<pre class="prettyprint"><code>No permissions are required.
-</code></pre>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<hr>
<h1><a name="accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a></h1>
@@ -290,7 +302,7 @@ navigator.<a href="cordova_accelerometer
<head>
<title><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -332,9 +344,9 @@ navigator.<a href="cordova_accelerometer
</h2>
<ul>
-<li>iOS doesn't recognize the concept of getting the current acceleration at any given point.</li>
-<li>You must watch the acceleration and capture the data at given time intervals.</li>
-<li>Thus, the <code>getCurrentAcceleration</code> function yields the last value reported from a <code>watchAccelerometer</code> call.</li>
+<li><p>iOS doesn't recognize the concept of getting the current acceleration at any given point.</p></li>
+<li><p>You must watch the acceleration and capture the data at given time intervals.</p></li>
+<li><p>Thus, the <code>getCurrentAcceleration</code> function yields the last value reported from a <code>watchAccelerometer</code> call.</p></li>
</ul>
<hr>
<h1><a name="accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></h1>
@@ -405,7 +417,7 @@ var watchID = navigator.<a href="cordova
<head>
<title><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// The watch id references the current `watchAcceleration`
@@ -518,7 +530,7 @@ navigator.<a href="cordova_accelerometer
<head>
<title><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// The watch id references the current `watchAcceleration`
@@ -650,7 +662,7 @@ navigator.<a href="cordova_accelerometer
<head>
<title><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
Modified: cordova/site/public/docs/en/edge/cordova_camera_camera.cleanup.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_camera_camera.cleanup.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_camera_camera.cleanup.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_camera_camera.cleanup.md.html Thu Aug 1 22:17:43 2013
@@ -94,7 +94,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
Modified: cordova/site/public/docs/en/edge/cordova_camera_camera.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_camera_camera.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_camera_camera.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_camera_camera.md.html Thu Aug 1 22:17:43 2013
@@ -83,7 +83,7 @@
<h1>Camera</h1>
<small><select><option value="Camera">Camera</option>
<option value="Camera_methods">Â Â Â Â Â Â - Methods</option>
-<option value="Camera_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Camera_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="camera.getPicture">camera.getPicture</option>
<option value="camera.getPicture_description">Â Â Â Â Â Â - Description</option>
<option value="camera.getPicture_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
@@ -123,7 +123,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -171,47 +170,62 @@
<li><a href="cordova_camera_camera.cleanup.md.html#camera.cleanup">camera.cleanup</a></li>
</ul>
<h2>
-<a name="Camera_permissions">Permissions</a>
+<a name="Camera_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
+<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
+Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-line%0AInterface">The Command-line
+Interface</a>, to add or remove this feature for a project:</p>
-<h4>app/res/xml/config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_camera_camera.md.html#Camera">Camera</a>" value="org.apache.cordova.CameraLauncher" />
+<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git
+ $ cordova plugin rm org.apache.cordova.core.camera
</code></pre>
-<h4>app/AndroidManifest</h4>
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
-<pre class="prettyprint"><code><uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-</code></pre>
+<ul>
+<li>
+<p>Android</p>
-<h3>BlackBerry WebWorks</h3>
+<pre class="prettyprint"><code>(in app/res/xml/config.xml)
+<feature name="<a href="cordova_camera_camera.md.html#Camera">Camera</a>">
+ <param name="android-package" value="org.apache.cordova.CameraLauncher" />
+</feature>
-<h4>www/plugins.xml</h4>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_camera_camera.md.html#Camera">Camera</a>" value="org.apache.cordova.camera.<a href="cordova_camera_camera.md.html#Camera">Camera</a>" />
+(in app/AndroidManifest)
+<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
</code></pre>
+</li>
+<li>
+<p>BlackBerry WebWorks</p>
+
+<pre class="prettyprint"><code>(in www/plugins.xml)
+<feature name="<a href="cordova_camera_camera.md.html#Camera">Camera</a>">
+ <param name="blackberry-package" value="org.apache.cordova.camera.<a href="cordova_camera_camera.md.html#Camera">Camera</a>" />
+</feature>
+
-<h4>www/config.xml</h4>
+(in www/config.xml)
+<feature id="blackberry.media.camera" />
-<pre class="prettyprint"><code><feature id="blackberry.media.camera" />
<rim:permissions>
<rim:permit>use_camera</rim:permit>
</rim:permissions>
</code></pre>
+</li>
+<li>
+<p>iOS (in <code>config.xml</code>)</p>
-<h3>iOS</h3>
-
-<h4>config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_camera_camera.md.html#Camera">Camera</a>" value="CDVCamera" />
+<pre class="prettyprint"><code><feature name="<a href="cordova_camera_camera.md.html#Camera">Camera</a>">
+ <param name="ios-package" value="CDVCamera" />
+</feature>
</code></pre>
-
-<h3>Windows Phone</h3>
-
-<h4>Properties/WPAppManifest.xml</h4>
+</li>
+<li>
+<p>Windows Phone (in <code>Properties/WPAppManifest.xml</code>)</p>
<pre class="prettyprint"><code><Capabilities>
<Capability Name="ID_CAP_ISV_CAMERA" />
@@ -220,16 +234,19 @@
</code></pre>
<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
-
-<h3>Tizen</h3>
-
-<h4>config.xml</h4>
+</li>
+<li>
+<p>Tizen (in <code>config.xml</code>)</p>
<pre class="prettyprint"><code><feature name="http://tizen.org/api/application" required="true"/>
<feature name="http://tizen.org/api/application.launch" required="true"/>
</code></pre>
<p>Reference: <a class="external" href="https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures">Application Manifest for Tizen Web Application</a></p>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<hr>
<h1><a name="camera.getPicture">camera.getPicture</a></h1>
@@ -265,16 +282,16 @@ one of the following formats, depending
<code><a href="cordova_camera_camera.md.html#cameraOptions">cameraOptions</a></code>:</p>
<ul>
-<li>A <code>String</code> containing the base64-encoded photo image.</li>
-<li>A <code>String</code> representing the image file location on local storage (default).</li>
+<li><p>A <code>String</code> containing the base64-encoded photo image.</p></li>
+<li><p>A <code>String</code> representing the image file location on local storage (default).</p></li>
</ul>
<p>You can do whatever you want with the encoded image or URI, for
example:</p>
<ul>
-<li>Render the image in an <code><img></code> tag, as in the example below</li>
-<li>Save the data locally (<code>LocalStorage</code>, <a class="external" href="http://brianleroux.github.com/lawnchair/">Lawnchair</a>, etc.)</li>
-<li>Post the data to a remote server</li>
+<li><p>Render the image in an <code><img></code> tag, as in the example below</p></li>
+<li><p>Save the data locally (<code>LocalStorage</code>, <a class="external" href="http://brianleroux.github.com/lawnchair/">Lawnchair</a>, etc.)</p></li>
+<li><p>Post the data to a remote server</p></li>
</ul>
<p><strong>NOTE:</strong> Photo resolution on newer devices is quite good. Photos
selected from the device's gallery are not downscaled to a lower
@@ -375,7 +392,7 @@ function onFail(message) {
<head>
<title><a href="cordova_media_capture_capture.md.html#Capture">Capture</a> Photo</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
var pictureSource; // picture source
@@ -592,11 +609,8 @@ function cameraCallback(imageData) {
<p>};</p>
</li>
<li><p><strong>correctOrientation</strong>: Rotate the image to correct for the orientation of the device during capture. <em>(Boolean)</em></p></li>
-<li>
-<strong>saveToPhotoAlbum</strong>: Save the image to the photo album on the device after capture. <em>(Boolean)</em>
-</li>
-<li>
-<strong>popoverOptions</strong>: iOS-only options that specify popover location in iPad. Defined in <code><a href="cordova_camera_camera.md.html#CameraPopoverOptions">CameraPopoverOptions</a></code>.</li>
+<li><p><strong>saveToPhotoAlbum</strong>: Save the image to the photo album on the device after capture. <em>(Boolean)</em></p></li>
+<li><p><strong>popoverOptions</strong>: iOS-only options that specify popover location in iPad. Defined in <code><a href="cordova_camera_camera.md.html#CameraPopoverOptions">CameraPopoverOptions</a></code>.</p></li>
<li>
<p><strong>cameraDirection</strong>: Choose the camera to use (front- or back-facing). Defined in <code>navigator.camera.Direction</code> <em>(Number)</em></p>
@@ -612,49 +626,47 @@ function cameraCallback(imageData) {
</h2>
<ul>
-<li>Ignores the <code>allowEdit</code> parameter.</li>
-<li>
-<code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY</code> and <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM</code> both display the same photo album.</li>
+<li><p>Ignores the <code>allowEdit</code> parameter.</p></li>
+<li><p><code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY</code> and <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM</code> both display the same photo album.</p></li>
</ul>
<h2>
<a name="cameraOptions_blackberry_quirks">BlackBerry Quirks</a>
</h2>
<ul>
-<li>Ignores the <code>quality</code> parameter.</li>
-<li>Ignores the <code>sourceType</code> parameter.</li>
-<li>Ignores the <code>allowEdit</code> parameter.</li>
-<li>Application must have key injection permissions to <a href="cordova_inappbrowser_inappbrowser.md.html#close">close</a> the native <a href="cordova_camera_camera.md.html#Camera">Camera</a> application after the user snaps the photo.</li>
-<li>Using large image sizes may result in the inability to encode images on later-model devices (e.g. Torch 9800) that feature high-resolution cameras.</li>
-<li>
-<code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.MediaType</code> is not supported.</li>
-<li>Ignores the <code>correctOrientation</code> parameter.</li>
-<li>Ignores the <code>cameraDirection</code> parameter.</li>
+<li><p>Ignores the <code>quality</code> parameter.</p></li>
+<li><p>Ignores the <code>sourceType</code> parameter.</p></li>
+<li><p>Ignores the <code>allowEdit</code> parameter.</p></li>
+<li><p>Application must have key injection permissions to <a href="cordova_inappbrowser_inappbrowser.md.html#close">close</a> the native <a href="cordova_camera_camera.md.html#Camera">Camera</a> application after the user snaps the photo.</p></li>
+<li><p>Using large image sizes may result in the inability to encode images on later-model devices (e.g. Torch 9800) that feature high-resolution cameras.</p></li>
+<li><p><code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.MediaType</code> is not supported.</p></li>
+<li><p>Ignores the <code>correctOrientation</code> parameter.</p></li>
+<li><p>Ignores the <code>cameraDirection</code> parameter.</p></li>
</ul>
<h2>
<a name="cameraOptions_ios_quirks">iOS Quirks</a>
</h2>
<ul>
-<li>Set <code>quality</code> below 50 to avoid memory errors on some devices.</li>
-<li>When using <code>destinationType.FILE_URI</code>, photos are saved in the application's temporary directory. You may delete the contents of this directory using the <code>navigator.fileMgr</code> APIs if storage space is a concern.</li>
+<li><p>Set <code>quality</code> below 50 to avoid memory errors on some devices.</p></li>
+<li><p>When using <code>destinationType.FILE_URI</code>, photos are saved in the application's temporary directory. You may delete the contents of this directory using the <code>navigator.fileMgr</code> APIs if storage space is a concern.</p></li>
</ul>
<h2>
<a name="cameraOptions_tizen_quirks">Tizen Quirks</a>
</h2>
<ul>
-<li>options not supported</li>
-<li>always returns a FILE URI</li>
+<li><p>options not supported</p></li>
+<li><p>always returns a FILE URI</p></li>
</ul>
<h2>
<a name="cameraOptions_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
</h2>
<ul>
-<li>Ignores the <code>allowEdit</code> parameter.</li>
-<li>Ignores the <code>correctOrientation</code> parameter.</li>
-<li>Ignores the <code>cameraDirection</code> parameter.</li>
+<li><p>Ignores the <code>allowEdit</code> parameter.</p></li>
+<li><p>Ignores the <code>correctOrientation</code> parameter.</p></li>
+<li><p>Ignores the <code>cameraDirection</code> parameter.</p></li>
</ul>
<hr>
<h1><a name="CameraPopoverOptions">CameraPopoverOptions</a></h1>
@@ -748,9 +760,12 @@ location.</p>
<p>Set the position of the popover.</p>
-<p><strong>Parameters:</strong>
-- <code>cameraPopoverOptions</code>: the <code><a href="cordova_camera_camera.md.html#CameraPopoverOptions">CameraPopoverOptions</a></code> that specify the new position</p>
+<p><strong>Parameters:</strong></p>
+<ul>
+<li>
+<code>cameraPopoverOptions</code>: the <code><a href="cordova_camera_camera.md.html#CameraPopoverOptions">CameraPopoverOptions</a></code> that specify the new position</li>
+</ul>
<h2>
<a name="CameraPopoverHandle_quick_example">Quick Example</a>
</h2>
Modified: cordova/site/public/docs/en/edge/cordova_compass_compass.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_compass_compass.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_compass_compass.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_compass_compass.md.html Thu Aug 1 22:17:43 2013
@@ -84,7 +84,7 @@
<small><select><option value="Compass">Compass</option>
<option value="Compass_methods">Â Â Â Â Â Â - Methods</option>
<option value="Compass_arguments">Â Â Â Â Â Â - Arguments</option>
-<option value="Compass_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Compass_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="compass.getCurrentHeading">compass.getCurrentHeading</option>
<option value="compass.getCurrentHeading_description">Â Â Â Â Â Â - Description</option>
<option value="compass.getCurrentHeading_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
@@ -129,7 +129,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -190,31 +189,39 @@
<li><a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a></li>
</ul>
<h2>
-<a name="Compass_permissions">Permissions</a>
+<a name="Compass_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
+<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
+Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-line%0AInterface">The Command-line
+Interface</a>, to add or remove this feature for a project:</p>
-<h4>app/res/xml/config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_compass_compass.md.html#Compass">Compass</a>" value="org.apache.cordova.CompassListener" />
+<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git
+ $ cordova plugin rm org.apache.cordova.core.device-orientation
</code></pre>
-<h3>BlackBerry WebWorks</h3>
-
-<pre class="prettyprint"><code>No permissions are required.
-</code></pre>
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
-<h3>iOS</h3>
-
-<h4>config.xml</h4>
+<ul>
+<li>
+<p>Android (in <code>app/res/xml/config.xml</code>)</p>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_compass_compass.md.html#Compass">Compass</a>" value="CDVLocation" />
+<pre class="prettyprint"><code><feature name="<a href="cordova_compass_compass.md.html#Compass">Compass</a>">
+ <param name="android-package" value="org.apache.cordova.CompassListener" />
+</feature>
</code></pre>
+</li>
+<li>
+<p>iOS (in <code>config.xml</code>)</p>
-<h3>Windows Phone</h3>
-
-<h4>Properties/WPAppManifest.xml</h4>
+<pre class="prettyprint"><code><feature name="<a href="cordova_compass_compass.md.html#Compass">Compass</a>">
+ <param name="ios-package" value="CDVLocation" />
+</feature>
+</code></pre>
+</li>
+<li>
+<p>Windows Phone (in <code>Properties/WPAppManifest.xml</code>)</p>
<pre class="prettyprint"><code><Capabilities>
<Capability Name="ID_CAP_SENSORS" />
@@ -222,11 +229,10 @@
</code></pre>
<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
-
-<h3>Tizen</h3>
-
-<pre class="prettyprint"><code>No permissions are required.
-</code></pre>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<hr>
<h1><a name="compass.getCurrentHeading">compass.getCurrentHeading</a></h1>
@@ -253,9 +259,10 @@ object using the <code><a href="cordova_
<ul>
<li>Android</li>
+<li>BlackBerry 10</li>
<li>iOS</li>
<li>Tizen</li>
-<li>Windows Phone 7 and 8 ( if available in hardware )</li>
+<li>Windows Phone 7 and 8 (if available in hardware)</li>
<li>Windows 8</li>
</ul>
<h2>
@@ -282,7 +289,7 @@ navigator.<a href="cordova_compass_compa
<head>
<title><a href="cordova_compass_compass.md.html#Compass">Compass</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -347,6 +354,7 @@ ID can be used with <code><a href="cordo
<ul>
<li>Android</li>
+<li>BlackBerry 10</li>
<li>iOS</li>
<li>Tizen</li>
<li>Windows Phone 7 and 8 (if available in hardware)</li>
@@ -381,7 +389,7 @@ var watchID = navigator.<a href="cordova
<head>
<title><a href="cordova_compass_compass.md.html#Compass">Compass</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// The watch id references the current `watchHeading`
@@ -477,9 +485,10 @@ with time intervals.</p>
<ul>
<li>Android</li>
+<li>BlackBerry 10</li>
<li>iOS</li>
<li>Tizen</li>
-<li>Windows Phone 7 and 8 ( if available in hardware )</li>
+<li>Windows Phone 7 and 8 (if available in hardware)</li>
<li>Windows 8</li>
</ul>
<h2>
@@ -502,7 +511,7 @@ navigator.<a href="cordova_compass_compa
<head>
<title><a href="cordova_compass_compass.md.html#Compass">Compass</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// The watch id references the current `watchHeading`
@@ -622,11 +631,8 @@ navigator.<a href="cordova_compass_compa
</h2>
<ul>
-<li>
-<strong>frequency</strong>: How often to retrieve the compass heading in milliseconds. <em>(Number)</em> (Default: 100)</li>
-<li>
-<strong>filter</strong>: The change in degrees required to initiate a watchHeading success callback. <em>(Number)</em>
-</li>
+<li><p><strong>frequency</strong>: How often to retrieve the compass heading in milliseconds. <em>(Number)</em> (Default: 100)</p></li>
+<li><p><strong>filter</strong>: The change in degrees required to initiate a watchHeading success callback. <em>(Number)</em></p></li>
</ul>
<p>Android Quirks</p>
@@ -661,18 +667,10 @@ navigator.<a href="cordova_compass_compa
</h2>
<ul>
-<li>
-<strong>magneticHeading</strong>: The heading in degrees from 0 - 359.99 at a single moment in time. <em>(Number)</em>
-</li>
-<li>
-<strong>trueHeading</strong>: The heading relative to the geographic North Pole in degrees 0 - 359.99 at a single moment in time. A negative value indicates that the true heading cannot be determined. <em>(Number)</em>
-</li>
-<li>
-<strong>headingAccuracy</strong>: The deviation in degrees between the reported heading and the true heading. <em>(Number)</em>
-</li>
-<li>
-<strong>timestamp</strong>: The time at which this heading was determined. <em>(milliseconds)</em>
-</li>
+<li><p><strong>magneticHeading</strong>: The heading in degrees from 0-359.99 at a single moment in time. <em>(Number)</em></p></li>
+<li><p><strong>trueHeading</strong>: The heading relative to the geographic North Pole in degrees 0-359.99 at a single moment in time. A negative value indicates that the true heading cannot be determined. <em>(Number)</em></p></li>
+<li><p><strong>headingAccuracy</strong>: The deviation in degrees between the reported heading and the true heading. <em>(Number)</em></p></li>
+<li><p><strong>timestamp</strong>: The time at which this heading was determined. <em>(milliseconds)</em></p></li>
</ul>
<h2>
<a name="compassHeading_description">Description</a>
@@ -685,21 +683,16 @@ navigator.<a href="cordova_compass_compa
</h2>
<ul>
-<li>
-<code>trueHeading</code> is not supported, but reports the same value as <code>magneticHeading</code>
-</li>
-<li>
-<code>headingAccuracy</code> is always 0 because there is no difference between the <code>magneticHeading</code> and <code>trueHeading</code>.</li>
+<li><p><code>trueHeading</code> is not supported, but reports the same value as <code>magneticHeading</code></p></li>
+<li><p><code>headingAccuracy</code> is always 0 because there is no difference between the <code>magneticHeading</code> and <code>trueHeading</code>.</p></li>
</ul>
<h2>
<a name="compassHeading_ios_quirks">iOS Quirks</a>
</h2>
<ul>
-<li>
-<code>trueHeading</code> is only returned when location services are enabled via <code>navigator.geolocation.watchLocation()</code>
-</li>
-<li>For iOS 4 devices and above, heading factors in the device's current orientation, not in reference to its absolute position, for apps that supports that orientation.</li>
+<li><p><code>trueHeading</code> is only returned when location services are enabled via <code>navigator.geolocation.watchLocation()</code></p></li>
+<li><p>For iOS 4 devices and above, heading factors in the device's current orientation, not in reference to its absolute position, for apps that supports that orientation.</p></li>
</ul>
<hr>
<h1><a name="CompassError">CompassError</a></h1>
Modified: cordova/site/public/docs/en/edge/cordova_connection_connection.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_connection_connection.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_connection_connection.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_connection_connection.md.html Thu Aug 1 22:17:43 2013
@@ -84,7 +84,7 @@
<small><select><option value="Connection">Connection</option>
<option value="Connection_properties">Â Â Â Â Â Â - Properties</option>
<option value="Connection_constants">Â Â Â Â Â Â - Constants</option>
-<option value="Connection_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Connection_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="connection.type">connection.type</option>
<option value="connection.type_description">Â Â Â Â Â Â - Description</option>
<option value="connection.type_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
@@ -103,7 +103,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -170,40 +169,55 @@
<a href="cordova_connection_connection.md.html#Connection">Connection</a>.NONE</li>
</ul>
<h2>
-<a name="Connection_permissions">Permissions</a>
+<a name="Connection_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
+<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
+Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-line%0AInterface">The Command-line
+Interface</a>, to add or remove this feature for a project:</p>
-<h4>app/res/xml/config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="NetworkStatus" value="org.apache.cordova.NetworkManager" />
+<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git
+ $ cordova plugin rm org.apache.cordova.core.network-information
</code></pre>
-<h4>app/AndroidManifest.xml</h4>
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
-<pre class="prettyprint"><code><uses-permission android:name="android.permission.INTERNET" />
-<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
-<uses-permission android:name="android.permission.READ_PHONE_STATE" />
-</code></pre>
+<ul>
+<li>
+<p>Android</p>
-<h3>BlackBerry WebWorks</h3>
+<pre class="prettyprint"><code>(in app/res/xml/config.xml)
+<feature name="NetworkStatus">
+ <param name="android-package" value="org.apache.cordova.NetworkManager" />
+</feature>
-<h4>www/plugins.xml</h4>
-<pre class="prettyprint"><code><plugin name="Network Status" value="org.apache.cordova.network.Network" />
+(in app/AndroidManifest.xml)
+<uses-permission android:name="android.permission.INTERNET" />
+<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+<uses-permission android:name="android.permission.READ_PHONE_STATE" />
</code></pre>
+</li>
+<li>
+<p>BlackBerry WebWorks</p>
-<h3>iOS</h3>
-
-<h4>config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="NetworkStatus" value="CDVConnection" />
+<pre class="prettyprint"><code>(in www/plugins.xml)
+<feature name="Network Status">
+ <param name="blackberry-package" value="org.apache.cordova.network.Network" />
+</feature>
</code></pre>
+</li>
+<li>
+<p>iOS (in <code>config.xml</code>)</p>
-<h3>Windows Phone</h3>
-
-<h4>Properties/WPAppManifest.xml</h4>
+<pre class="prettyprint"><code><feature name="NetworkStatus">
+ <param name="ios-package" value="CDVConnection" />
+</feature>
+</code></pre>
+</li>
+<li>
+<p>Windows Phone (in <code>Properties/WPAppManifest.xml</code>)</p>
<pre class="prettyprint"><code><Capabilities>
<Capability Name="ID_CAP_NETWORKING" />
@@ -211,15 +225,18 @@
</code></pre>
<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
-
-<h3>Tizen</h3>
-
-<h4>config.xml</h4>
+</li>
+<li>
+<p>Tizen (in <code>config.xml</code>)</p>
<pre class="prettyprint"><code><feature name="http://tizen.org/api/systeminfo" required="true"/>
</code></pre>
<p>Reference: <a class="external" href="https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures">Application Manifest for Tizen Web Application</a></p>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<hr>
<h1><a name="connection.type">connection.type</a></h1>
@@ -277,7 +294,7 @@ checkConnection();
<head>
<title>navigator.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -341,8 +358,10 @@ eventually be removed.</p>
</h2>
<ul>
-<li>When running in the emulator, always detects <code>navigator.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a></code> as <code><a href="cordova_connection_connection.md.html#Connection">Connection</a>.UNKNOWN</code>.</li>
-<li>Windows Phone cannot detect the type of cellular network connection.
+<li><p>When running in the emulator, always detects <code>navigator.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a></code> as <code><a href="cordova_connection_connection.md.html#Connection">Connection</a>.UNKNOWN</code>.</p></li>
+<li>
+<p>Windows Phone cannot detect the type of cellular network connection.</p>
+
<ul>
<li>
<code>navigator.<a href="cordova_connection_connection.md.html#connection.type">connection.type</a></code> is set to <code><a href="cordova_connection_connection.md.html#Connection">Connection</a>.CELL</code> for all cellular data.</li>