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 [15/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/edge/cordova_splashscreen_splashscreen.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_splashscreen_splashscreen.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_splashscreen_splashscreen.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_splashscreen_splashscreen.md.html Thu Aug 1 22:17:43 2013
@@ -83,7 +83,7 @@
<h1>Splashscreen</h1>
<small><select><option value="Splashscreen">Splashscreen</option>
<option value="Splashscreen_methods">Â Â Â Â Â Â - Methods</option>
-<option value="Splashscreen_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Splashscreen_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="Splashscreen_setup">Â Â Â Â Â Â - Setup</option>
<option value="splashscreen.show">splashscreen.show</option>
<option value="splashscreen.show_description">Â Â Â Â Â Â - Description</option>
@@ -105,7 +105,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>
@@ -151,22 +150,40 @@
<li><a href="cordova_splashscreen_splashscreen.md.html#splashscreen.hide">splashscreen.hide</a></li>
</ul>
<h2>
-<a name="Splashscreen_permissions">Permissions</a>
+<a name="Splashscreen_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
-
-<h4>app/res/xml/config.xml</h4>
+<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>
-<pre class="prettyprint"><code><plugin name="SplashScreen" value="org.apache.cordova.SplashScreen"/>
+<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git
+ $ cordova plugin rm org.apache.cordova.core.splashscreen
</code></pre>
-<h3>iOS</h3>
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
-<h4>config.xml</h4>
+<ul>
+<li>
+<p>Android (in <code>app/res/xml/config.xml</code>)</p>
-<pre class="prettyprint"><code><plugin name="SplashScreen" value="CDVSplashScreen" />
+<pre class="prettyprint"><code><feature name="SplashScreen">
+ <param name="android-package" value="org.apache.cordova.SplashScreen" />
+</feature>
</code></pre>
+</li>
+<li>
+<p>iOS (in <code>config.xml</code>)</p>
+
+<pre class="prettyprint"><code><feature name="SplashScreen">
+ <param name="ios-package" value="CDVSplashScreen" />
+</feature>
+</code></pre>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<h2>
<a name="Splashscreen_setup">Setup</a>
@@ -233,7 +250,9 @@ should be:</p>
<ul>
<li>Android</li>
+<li>BlackBerry 10</li>
<li>iOS</li>
+<li>Windows Phone 7 and 8</li>
</ul>
<h2>
<a name="splashscreen.show_quick_example">Quick Example</a>
@@ -251,7 +270,7 @@ should be:</p>
<head>
<title><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</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
@@ -292,7 +311,9 @@ should be:</p>
<ul>
<li>Android</li>
+<li>BlackBerry 10</li>
<li>iOS</li>
+<li>Windows Phone 7 and 8</li>
</ul>
<h2>
<a name="splashscreen.hide_quick_example">Quick Example</a>
@@ -310,7 +331,7 @@ should be:</p>
<head>
<title><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</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_storage_storage.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_storage_storage.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_storage_storage.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_storage_storage.md.html Thu Aug 1 22:17:43 2013
@@ -85,7 +85,7 @@
<option value="Storage_methods">Â Â Â Â Â Â - Methods</option>
<option value="Storage_arguments">Â Â Â Â Â Â - Arguments</option>
<option value="Storage_objects">Â Â Â Â Â Â - Objects</option>
-<option value="Storage_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Storage_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="openDatabase">openDatabase</option>
<option value="openDatabase_description">Â Â Â Â Â Â - Description</option>
<option value="openDatabase_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
@@ -145,7 +145,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>
@@ -182,12 +181,22 @@
<p>Provides access to the device's storage options.</p>
</blockquote>
-<p>This API is based on the <a class="external" href="http://dev.w3.org/html5/webdatabase/">W3C Web SQL </a><a href="cordova_storage_storage.md.html#Database">Database</a>
-Specification and <a class="external" href="http://dev.w3.org/html5/webstorage/">W3C Web
-</a><a href="cordova_storage_storage.md.html#Storage">Storage</a> API Specification. Some
-devices already provide an implementation of these specifications, in
-which case the built-in support applies. Cordova's implementation
-offers compatible support for those that don't.</p>
+<p>This API offers storage options based on two different W3C
+specifications:</p>
+
+<ul>
+<li><p>The
+<a class="external" href="http://dev.w3.org/html5/webstorage/">Web </a><a href="cordova_storage_storage.md.html#Storage">Storage</a> API Specification
+allows you to access data via simple key/value pairs. See the
+section on <a href="cordova_storage_storage.md.html#localStorage">localStorage</a> for complete details on this interface.</p></li>
+<li><p>The
+<a class="external" href="http://dev.w3.org/html5/webdatabase/">Web SQL </a><a href="cordova_storage_storage.md.html#Database">Database</a> Specification
+offers more full-featured database tables accessed via SQL queries.
+A summary of this interface appears immediately below.</p></li>
+</ul>
+<p>Cordova provides access to both interfaces for the minority of devices
+that don't already support them. Otherwise the built-in
+implementations apply.</p>
<h2>
<a name="Storage_methods">Methods</a>
@@ -216,40 +225,37 @@ offers compatible support for those that
<li><a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a></li>
<li><a href="cordova_storage_storage.md.html#SQLResultSetRowList">SQLResultSetRowList</a></li>
<li><a href="cordova_storage_storage.md.html#SQLError">SQLError</a></li>
-<li><a href="cordova_storage_storage.md.html#localStorage">localStorage</a></li>
</ul>
<h2>
-<a name="Storage_permissions">Permissions</a>
+<a name="Storage_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
-
-<h4>app/res/xml/config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_storage_storage.md.html#Storage">Storage</a>" value="org.apache.cordova.<a href="cordova_storage_storage.md.html#Storage">Storage</a>" />
-</code></pre>
-
-<h3>BlackBerry WebWorks</h3>
+<p>As of version 3.0, access to <a href="cordova_storage_storage.md.html#Storage">Storage</a> APIs is built into Cordova, and
+does not require using the CLI to add plugins as described in <a href="#The%0ACommand-line%20Interface">The
+Command-line Interface</a>.</p>
-<h4>www/config.xml</h4>
+<p>If you are using the older set of Cordova tools that precede the CLI,
+the following platform-specific configuration settings are still
+required:</p>
-<pre class="prettyprint"><code><feature id="blackberry.widgetcache" required="true" version="1.0.0.0" />
-</code></pre>
-
-<h3>iOS</h3>
-
-<pre class="prettyprint"><code>No permissions are required.
-</code></pre>
-
-<h3>Windows Phone</h3>
+<ul>
+<li>
+<p>Android (in <code>app/res/xml/config.xml</code>)</p>
-<pre class="prettyprint"><code>No permissions are required.
+<pre class="prettyprint"><code><feature name="<a href="cordova_storage_storage.md.html#Storage">Storage</a>">
+ <param name="android-package" value="org.apache.cordova.<a href="cordova_storage_storage.md.html#Storage">Storage</a>" />
+</feature>
</code></pre>
+</li>
+<li>
+<p>BlackBerry WebWorks (in <code>www/config.xml</code>)</p>
-<h3>Tizen</h3>
-
-<pre class="prettyprint"><code>No permissions are required.
+<pre class="prettyprint"><code><feature id="blackberry.widgetcache" required="true" version="1.0.0.0" />
</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="openDatabase">openDatabase</a></h1>
@@ -292,7 +298,7 @@ object that allows manipulation of the d
<head>
<title><a href="cordova_storage_storage.md.html#Storage">Storage</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
@@ -344,10 +350,8 @@ object that allows manipulation of the d
</h2>
<ul>
-<li>
-<strong>transaction</strong>: Runs a database transaction.</li>
-<li>
-<strong>changeVersion</strong>: Allows scripts to automatically verify the version number and change it when updating a schema.</li>
+<li><p><strong>transaction</strong>: Runs a database transaction.</p></li>
+<li><p><strong>changeVersion</strong>: Allows scripts to automatically verify the version number and change it when updating a schema.</p></li>
</ul>
<h2>
<a name="Database_details">Details</a>
@@ -405,7 +409,7 @@ db.changeVersion("1.0", "1.1");
<head>
<title><a href="cordova_storage_storage.md.html#Storage">Storage</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
@@ -511,7 +515,7 @@ db.transaction(populateDB, errorCB, succ
<head>
<title><a href="cordova_storage_storage.md.html#Storage">Storage</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
@@ -566,12 +570,9 @@ specified callback executes with a <code
</h2>
<ul>
-<li>
-<strong>insertId</strong>: The row ID of the row that the <code><a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a></code> object's SQL statement inserted into the database.</li>
-<li>
-<strong>rowsAffected</strong>: The number of rows changed by the SQL statement, zero if the statement did not affect any rows.</li>
-<li>
-<strong>rows</strong>: a <code><a href="cordova_storage_storage.md.html#SQLResultSetRowList">SQLResultSetRowList</a></code> representing the rows returned, empty if no rows are returned.</li>
+<li><p><strong>insertId</strong>: The row ID of the row that the <code><a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a></code> object's SQL statement inserted into the database.</p></li>
+<li><p><strong>rowsAffected</strong>: The number of rows changed by the SQL statement, zero if the statement did not affect any rows.</p></li>
+<li><p><strong>rows</strong>: a <code><a href="cordova_storage_storage.md.html#SQLResultSetRowList">SQLResultSetRowList</a></code> representing the rows returned, empty if no rows are returned.</p></li>
</ul>
<h2>
<a name="SQLResultSet_details">Details</a>
@@ -637,7 +638,7 @@ db.transaction(queryDB, errorCB);
<head>
<title><a href="cordova_storage_storage.md.html#Storage">Storage</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
@@ -777,7 +778,7 @@ function querySuccess(tx, results) {
<head>
<title><a href="cordova_storage_storage.md.html#Storage">Storage</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
@@ -848,10 +849,8 @@ function querySuccess(tx, results) {
</h2>
<ul>
-<li>
-<strong>code</strong>: One of the predefined error codes listed below.</li>
-<li>
-<strong>message</strong>: A description of the error.</li>
+<li><p><strong>code</strong>: One of the predefined error codes listed below.</p></li>
+<li><p><strong>message</strong>: A description of the error.</p></li>
</ul>
<h2>
<a name="SQLError_constants">Constants</a>
@@ -876,9 +875,11 @@ function querySuccess(tx, results) {
<hr>
<h1><a name="localStorage">localStorage</a></h1>
-<p>Provides access to a <a class="external" href="http://dev.w3.org/html5/webstorage/#the-localstorage-attribute">W3C </a><a href="cordova_storage_storage.md.html#Storage">Storage</a> interface</p>
+<p>Provides access to the W3C's
+<a class="external" href="http://dev.w3.org/html5/webstorage/#the-localstorage-attribute">Web </a><a href="cordova_storage_storage.md.html#Storage">Storage</a> interface</p>
-<pre class="prettyprint"><code>var storage = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>;
+<pre class="prettyprint"><code>var permanentStorage = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>;
+var tempStorage = window.sessionStorage;
</code></pre>
<h2>
@@ -886,25 +887,22 @@ function querySuccess(tx, results) {
</h2>
<ul>
-<li>
-<strong>key</strong>: Returns the name of the key at the specified position.</li>
-<li>
-<strong>getItem</strong>: Returns the item identified by the specified key.</li>
-<li>
-<strong>setItem</strong>: Assigns a keyed item's value.</li>
-<li>
-<strong>removeItem</strong>: Removes the item identified by the specified key.</li>
-<li>
-<strong>clear</strong>: Removes all of the key/value pairs.</li>
+<li><p><strong>key</strong>: Returns the name of the key at the specified position.</p></li>
+<li><p><strong>getItem</strong>: Returns the item identified by the specified key.</p></li>
+<li><p><strong>setItem</strong>: Assigns a keyed item's value.</p></li>
+<li><p><strong>removeItem</strong>: Removes the item identified by the specified key.</p></li>
+<li><p><strong>clear</strong>: Removes all of the key/value pairs.</p></li>
</ul>
<h2>
<a name="localStorage_details">Details</a>
</h2>
-<p>The <code>window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a></code> interface is based on the W3C Web <a href="cordova_storage_storage.md.html#Storage">Storage</a>
-interface. An app can use it to save persistent data using key-value
-pairs. The <code>window.sessionStorage</code> interface works the same way, but
-all data is cleared each time the app closes.</p>
+<p>The <code>window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a></code> interface implements the W3C's <a class="external" href="http://dev.w3.org/html5/webstorage/">Web </a><a href="cordova_storage_storage.md.html#Storage">Storage</a>
+interface. An app can use it to
+save persistent data using key-value pairs. The
+<code>window.sessionStorage</code> interface works the same way in every respect,
+except that all data is cleared each time the app closes. Each
+database provides a separate namespace.</p>
<h2>
<a name="localStorage_supported_platforms">Supported Platforms</a>
@@ -962,7 +960,7 @@ all data is cleared each time the app cl
<head>
<title><a href="cordova_storage_storage.md.html#Storage">Storage</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/guide_appdev_privacy_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/guide_appdev_privacy_index.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/guide_appdev_privacy_index.md.html (original)
+++ cordova/site/public/docs/en/edge/guide_appdev_privacy_index.md.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/guide_appdev_whitelist_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/guide_appdev_whitelist_index.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/guide_appdev_whitelist_index.md.html (original)
+++ cordova/site/public/docs/en/edge/guide_appdev_whitelist_index.md.html Thu Aug 1 22:17:43 2013
@@ -99,7 +99,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/guide_cli_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/guide_cli_index.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/guide_cli_index.md.html (original)
+++ cordova/site/public/docs/en/edge/guide_cli_index.md.html Thu Aug 1 22:17:43 2013
@@ -86,9 +86,11 @@
<option value="The%20Command-line%20Interface_create_the_app">Â Â Â Â Â Â - Create the App</option>
<option value="The%20Command-line%20Interface_add_platforms">Â Â Â Â Â Â - Add Platforms</option>
<option value="The%20Command-line%20Interface_build_the_app">Â Â Â Â Â Â - Build the App</option>
-<option value="The%20Command-line%20Interface_view_the_app_in_an_emulator">Â Â Â Â Â Â - View the App in an Emulator</option>
+<option value="The%20Command-line%20Interface_test_the_app_on_an_emulator_or_device">Â Â Â Â Â Â - Test the App on an Emulator or Device
+</option>
<option value="The%20Command-line%20Interface_add_features">Â Â Â Â Â Â - Add Features</option>
-<option value="The%20Command-line%20Interface_update_the_app">Â Â Â Â Â Â - Update the App</option></select></small>
+<option value="The%20Command-line%20Interface_customize_each_platform">Â Â Â Â Â Â - Customize Each Platform</option>
+<option value="The%20Command-line%20Interface_updating_cordova">Â Â Â Â Â Â - Updating Cordova</option></select></small>
</div>
<div id="sidebar">
@@ -98,7 +100,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>
@@ -153,7 +154,7 @@ platform's SDK. The CLI supports the fol
<ul>
<li>iOS (Mac)</li>
<li>Android (Mac, Linux)</li>
-<li>BlackBerry (Mac, Windows)</li>
+<li>BlackBerry 10 (Mac, Linux, Windows)</li>
<li>Windows Phone 7 (Windows)</li>
<li>Windows Phone 8 (Windows)</li>
</ul>
@@ -191,10 +192,13 @@ platform SDKs. Following installation,
<p>Go to the directory where you maintain your source code, and run a
command such as the following:</p>
-<pre class="prettyprint"><code> $ cordova create HelloWorld com.example.hello "Hello World"
+<pre class="prettyprint"><code> $ cordova create hello com.example.hello HelloWorld
</code></pre>
-<p>The first argument specifies a <em>HelloWorld</em> directory to be generated
+<p>It may take some time for the command to complete, so be patient. Run
+the <code>cordova -d</code> to see information about progress.</p>
+
+<p>The first argument specifies a <em>hello</em> directory to be generated
for your project. Its <code>www</code> subdirectory houses your application's
home page, along with various resources under <code>css</code>, <code>js</code>, and <code>img</code>,
which follow common web development file-naming conventions. The
@@ -203,7 +207,7 @@ distribute the application.</p>
<p>The other two arguments are optional: the <code>com.example.hello</code> argument
provides your project with a reverse domain-style identifier, and the
-<code>"Hello World!"</code> provides the application's display text. You can edit
+<code>HelloWorld</code> provides the application's display text. You can edit
both of these values later in the <code>config.xml</code> file.</p>
<h2>
@@ -213,7 +217,7 @@ both of these values later in the <code>
<p>All subsequent commands need to be run within the project's directory,
or any subdirectories within its scope:</p>
-<pre class="prettyprint"><code> $ cd HelloWorld
+<pre class="prettyprint"><code> $ cd hello
</code></pre>
<p>Before you can build the project, you need to specify a set of target
@@ -223,7 +227,7 @@ SDK. Run any of these from a Mac:</p>
<pre class="prettyprint"><code> $ cordova platform add ios
$ cordova platform add android
- $ cordova platform add blackberry
+ $ cordova platform add blackberry10
</code></pre>
<p>Run any of these from a Windows machine, where <em>wp</em> refers to
@@ -232,7 +236,7 @@ different versions of the Windows Phone
<pre class="prettyprint"><code> $ cordova platform add wp7
$ cordova platform add wp8
$ cordova platform add android
- $ cordova platform add blackberry
+ $ cordova platform add blackberry10
</code></pre>
<p>Run this to check your current set of platforms:</p>
@@ -244,7 +248,7 @@ different versions of the Windows Phone
<p>Run either of the following synonymous commands to remove a platform:</p>
-<pre class="prettyprint"><code> $ cordova platform remove blackberry
+<pre class="prettyprint"><code> $ cordova platform remove blackberry10
$ cordova platform rm android
</code></pre>
@@ -275,7 +279,7 @@ Edit this application however you want,
be specified as part of the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event handler, referenced by
default from <code>www/js/index.js</code>.
<!-- XREF
-(See Application Development Guide for details.)
+(See the Application Development Guide for details.)
XREF --></p>
<p>Run the following command to iteratively build the project:</p>
@@ -303,7 +307,8 @@ Cordova generates within <code>platforms
approach with other platforms' SDKs.</p>
<h2>
-<a name="The%20Command-line%20Interface_view_the_app_in_an_emulator">View the App in an Emulator</a>
+<a name="The%20Command-line%20Interface_test_the_app_on_an_emulator_or_device">Test the App on an Emulator or Device
+</a>
</h2>
<p>SDKs for mobile platforms often come bundled with emulators that
@@ -331,6 +336,19 @@ launch from the home screen:</p>
<p><img src="img/guide/cli/android_emulate_install.png" alt="" title=""></p>
+<p>Alternately, you can plug the handset into your computer and test the
+app directly:</p>
+
+<pre class="prettyprint"><code> $ cordova run android
+</code></pre>
+
+<p>Before running this command, you need to set up the device for
+testing, following procedures that vary for each platform. In
+Android's case, you would have to enable a <strong>USB debugging</strong> option on
+the device, and perhaps add a USB driver depending on your development
+environmnent.
+See <a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a> for details on each platform's requirements.</p>
+
<h2>
<a name="The%20Command-line%20Interface_add_features">Add Features</a>
</h2>
@@ -356,66 +374,147 @@ repository for the plugin code. Here ar
might add:</p>
<ul>
-<li>Basic device information:
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git</li>
-<li>Network and battery status:
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git</li>
<li>
-<a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a>, compass, and geolocation:
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git
+<p>Basic device information (<a href="cordova_device_device.md.html#Device">Device</a> API):</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git
+</code></pre>
+</li>
+<li>
+<p>Network <a href="cordova_connection_connection.md.html#Connection">Connection</a> and Battery <a href="cordova_events_events.md.html#Events">Events</a>:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git
+$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git
+</code></pre>
+</li>
+<li>
+<p><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a>, <a href="cordova_compass_compass.md.html#Compass">Compass</a>, and <a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a>:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git
$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git</li>
+$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
+</code></pre>
+</li>
<li>
-<a href="cordova_camera_camera.md.html#Camera">Camera</a>, media capture, and media playback:
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git
+<p><a href="cordova_camera_camera.md.html#Camera">Camera</a>, <a href="cordova_media_media.md.html#Media">Media</a> playback and <a href="cordova_media_capture_capture.md.html#Capture">Capture</a>:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git
$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git </li>
-<li>Access files on device or network:
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer.git</li>
-<li>Notifications via dialog box or vibration:
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git</li>
-<li>
-<a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a>:
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git</li>
-<li>
-<a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a>:
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git</li>
-<li>Splash Screen:
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git</li>
-<li>In-app browser:
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git</li>
-<li>Debug console:
-$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-console.git</li>
+$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git
+</code></pre>
+</li>
+<li>
+<p>Access files on device or network (<a href="cordova_file_file.md.html#File">File</a> API):</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
+$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer.git
+</code></pre>
+</li>
+<li>
+<p><a href="cordova_notification_notification.md.html#Notification">Notification</a> via dialog box or vibration:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git
+$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git
+</code></pre>
+</li>
+<li>
+<p><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a>:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git
+</code></pre>
+</li>
+<li>
+<p><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a>:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git
+</code></pre>
+</li>
+<li>
+<p><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a>:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git
+</code></pre>
+</li>
+<li>
+<p>Open new browser windows (<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>):</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git
+</code></pre>
+</li>
+<li>
+<p>Debug console:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-console.git
+</code></pre>
+</li>
</ul>
-<p>Use <code>plugin ls</code> (or <code>plugin list</code>) to view currently installed
-plugins. Each displays by its identifier:</p>
+<p>Use <code>plugin ls</code> (or <code>plugin list</code>, or <code>plugin</code> by itself) to view
+currently installed plugins. Each displays by its identifier:</p>
-<pre class="prettyprint"><code>$ cordova plugin ls # or 'plugin list'
-[ 'org.apache.cordova.core.console' ]
+<pre class="prettyprint"><code> $ cordova plugin ls # or 'plugin list'
+ [ 'org.apache.cordova.core.console' ]
</code></pre>
<p>To remove a plugin, refer to it by the same identifier that appears in
the listing. For example, here is how you would remove support for a
debug console from a release version:</p>
-<pre class="prettyprint"><code>$ cordova plugin rm org.apache.cordova.core.console
-$ cordova plugin remove org.apache.cordova.core.console # same
+<pre class="prettyprint"><code> $ cordova plugin rm org.apache.cordova.core.console
+ $ cordova plugin remove org.apache.cordova.core.console # same
</code></pre>
<p>You can batch-remove or add plugins by specifying more than one
argument for each command.</p>
-<!--
+<h2>
+<a name="The%20Command-line%20Interface_customize_each_platform">Customize Each Platform</a>
+</h2>
-## Run the App on the <a href="cordova_device_device.md.html#Device">Device</a>
+<p>While Cordova allows you to easily deploy an app for many different
+platforms, sometimes you need to add customizations. In that case,
+you don't want to modify the source files in various <code>www</code> directories
+within the top-level <code>platforms</code> directory, because they're regularly
+replaced with the top-level <code>www</code> directory's cross-platform source.</p>
+
+<p>Instead, the top-level <code>merges</code> directory offers a place to specify
+assets to deploy on specific platforms. Each platform-specific
+subdirectory within <code>merges</code> mirrors the directory structure of the
+<code>www</code> source tree, allowing you to override or add files as needed.
+For example, here is how you might uses <code>merges</code> to boost the default
+font size for Android devices:</p>
--->
+<ul>
+<li>
+<p>Edit the <code>www/index.html</code> file, adding a link to an additional CSS
+file, <code>overrides.css</code> in this case:</p>
+
+<pre class="prettyprint"><code><link rel="stylesheet" type="text/css" href="css/overrides.css" />
+</code></pre>
+</li>
+<li><p>Optionally create an empty <code>www/css/overrides.css</code> file, which would
+apply for all non-Android builds, preventing a missing-file error.</p></li>
+<li>
+<p>Create a <code>css</code> subdirectory within <code>merges/android</code>, then add a
+corresponding <code>overrides.css</code> file. Specify CSS that overrides the
+12-point default font size specified within <code>www/css/index.css</code>, for
+example:</p>
+
+<pre class="prettyprint"><code>body { font-size:14px; }
+</code></pre>
+</li>
+</ul>
+<p>When you rebuild the project, the Android version features the custom
+font size, while others remain unchanged.</p>
+
+<p>You can also use <code>merges</code> to add files not present in the original
+<code>www</code> directory. For example, an app can incorporate a <em>back button</em>
+graphic into the iOS interface, stored in
+<code>merges/ios/img/back_button.png</code>, while the Android version can
+instead capture <code><a href="cordova_events_events.md.html#backbutton">backbutton</a></code> events from the corresponding hardware
+button.</p>
<h2>
-<a name="The%20Command-line%20Interface_update_the_app">Update the App</a>
+<a name="The%20Command-line%20Interface_updating_cordova">Updating Cordova</a>
</h2>
<p>After installing installing the <code>cordova</code> utility, you can always
@@ -426,15 +525,25 @@ update it to the latest version by runni
<p>Use this syntax to install a specific version:</p>
-<pre class="prettyprint"><code> $ sudo npm install -g cordova@2.8.0
+<pre class="prettyprint"><code> $ sudo npm install -g cordova@3.0.0
</code></pre>
-<p>Run the <code>info</code> command for a listing that includes the current version
+<p>Run <code>cordova -v</code> to see the currently running version. Run the <code>npm
+info</code> command for a longer listing that includes the current version
along with other available version numbers:</p>
<pre class="prettyprint"><code> $ npm info cordova
</code></pre>
+<p>Cordova 3.0 is the first version to support the command-line interface
+described in this section. If you are updating from a version prior to
+3.0, you need to create a new project as described above, then copy
+the older application's assets into the top-level <code>www</code> directory.
+Where applicable, further details about upgrading to 3.0 are available
+in the <a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a>. Once you upgrade to the <code>cordova</code>
+command-line interface and use <code>npm update</code> to stay current, the more
+time-consuming procedures described there are no longer relevant.</p>
+
</div>
</div>
Modified: cordova/site/public/docs/en/edge/guide_hybrid_plugins_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/guide_hybrid_plugins_index.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/guide_hybrid_plugins_index.md.html (original)
+++ cordova/site/public/docs/en/edge/guide_hybrid_plugins_index.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>
@@ -154,52 +153,47 @@ front-facing and arguably most important
<p>You can structure your plugin's JavaScript however you like. The one
thing you <em>must</em> use to communicate between the Cordova JavaScript
- and native environments is the <code>cordova.exec</code> function. Here is an example:</p>
+and native environments is the <code>cordova.exec</code> function. Here is an example:</p>
-<pre class="prettyprint"><code>cordova.exec(function(winParam) {}, function(error) {}, "service",
- "action", ["firstArgument", "secondArgument", 42,
- false]);
+<pre class="prettyprint"><code> cordova.exec(function(winParam) {}, function(error) {}, "service",
+ "action", ["firstArgument", "secondArgument", 42,
+ false]);
</code></pre>
<p>The parameters are detailed below:</p>
-<ol>
-<li>
-<code>function(winParam) {}</code> - Success function callback. Assuming your
+<ul>
+<li><p><code>function(winParam) {}</code>: Success function callback. Assuming your
<code>exec</code> call completes successfully, this function is invoked
-(optionally with any parameters you pass back to it).</li>
-<li>
-<code>function(error) {}</code> - Error function callback. If the operation does
-not complete successfully, this function is invoked (optionally
-with an error parameter).</li>
-<li>
-<code>"service"</code> - The service name to call into on the native side. This
+(optionally with any parameters you pass back to it).</p></li>
+<li><p><code>function(error) {}</code>: Error function callback. If the operation does
+not complete successfully, this function is invoked (optionally with
+an error parameter).</p></li>
+<li><p><code>"service"</code>: The service name to call into on the native side. This
is mapped to a native class, about which more information is
-available in the native guides listed below.</li>
-<li>
-<code>"action"</code> - The action name to call into. This is picked up by the
+available in the native guides listed below.</p></li>
+<li><p><code>"action"</code>: The action name to call into. This is picked up by the
native class receiving the <code>exec</code> call, and, depending on the
-platform, essentially maps to a class's method.
-The native guides listed below provide details.</li>
-<li>
-<code>[/* arguments */]</code> - Arguments to pass into the native environment.</li>
-</ol>
+platform, essentially maps to a class's method. The native guides
+listed below provide details.</p></li>
+<li><p><code>[/* arguments */]</code>: Arguments to pass into the native environment.</p></li>
+</ul>
<h3>Echo Plugin JavaScript Example</h3>
-<pre class="prettyprint"><code>window.echo = function(str, callback) {
- cordova.exec(callback, function(err) {
- callback('Nothing to echo.');
- }, "Echo", "echo", [str]);
-};
+<pre class="prettyprint"><code> window.echo = function(str, callback) {
+ cordova.exec(callback, function(err) {
+ callback('Nothing to echo.');
+ }, "Echo", "echo", [str]);
+ };
</code></pre>
<p>Let's dive into this. The plugin attaches itself to <code>window</code>,
specifically to the <code>echo</code> function. Plugin users would then use it as
follows:</p>
-<pre class="prettyprint"><code>window.echo("echome", function(echoValue) {
- alert(echoValue == "echome"); // should alert true.
-});
+<pre class="prettyprint"><code> window.echo("echome", function(echoValue) {
+ alert(echoValue == "echome"); // should alert true.
+ });
</code></pre>
<p>First, let's take a look at the last three arguments to the <code>exec</code>
@@ -221,7 +215,7 @@ string.</p>
installation of the plugin for Android, iOS, BlackBerry 10 and Windows
Phone platforms. By structuring your plugin in a particular way and
adding a <code>plugin.xml</code> manifest file, you can enable users to install
-your plugin via the command line tooling.</p>
+your plugin via the command-line tooling.</p>
<ul>
<li><a href="plugin_ref_spec.md.html#Plugin%20Specification">Plugin Specification</a></li>
Modified: cordova/site/public/docs/en/edge/guide_hybrid_webviews_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/guide_hybrid_webviews_index.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/guide_hybrid_webviews_index.md.html (original)
+++ cordova/site/public/docs/en/edge/guide_hybrid_webviews_index.md.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/guide_overview_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/guide_overview_index.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/guide_overview_index.md.html (original)
+++ cordova/site/public/docs/en/edge/guide_overview_index.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>
@@ -144,7 +143,7 @@ platform's language and tool set.</p></l
distribution in various app store portals.</p></li>
<li><p>a mobile developer interested in mixing native application
components with a <em>WebView</em> (browser window) that can access
-device-level APIs, or if you want to develop a plug-in interface
+device-level APIs, or if you want to develop a plugin interface
between native and WebView components.</p></li>
</ul>
<h2>
@@ -166,14 +165,14 @@ which you distribute to app stores. For
various device features the way native apps do, it must also reference
a <code>cordova.js</code> file, which provides API bindings.
<!-- XREF
-(See the <a href="index.md.html#API Reference">API Reference</a> for an overview, and the API and Configuration
-Guide for examples of how to use them.)
+(See the <a href="index.md.html#API Reference">API Reference</a> for an overview, and the Application
+Development Guide for examples of how to use them.)
XREF --></p>
<p>The Cordova-enabled WebView may provide the application with its
entire user interface. It can also be a component within a larger,
hybrid application that mixes the WebView with native application
-components. Cordova provides a <em>plug-in</em> interface for these
+components. Cordova provides a <em>plugin</em> interface for these
components to communicate with each other.</p>
<h2>
@@ -246,57 +245,41 @@ available for each mobile platform:</p>
<th>Windows<br>Phone 7</th>
<th>Windows<br>Phone 8</th>
<th>Windows<br>8</th>
+ <th>Tizen</th>
</tr></thead>
<tbody>
<tr>
-<th><a href="#">cordova<br>CLI</a></th>
+<th><a href="guide_cli_index.md.html">cordova<br>CLI</a></th>
<td data-col="android" class="y">Mac, Windows, Linux</td>
- <td data-col="blackberry" class="y">Mac, Windows</td>
+ <td data-col="blackberry" class="n">Mac, Windows</td>
<td data-col="blackberry10" class="y">Mac, Windows</td>
<td data-col="ios" class="y">Mac</td>
<td data-col="winphone7" class="y">Windows</td>
<td data-col="winphone8" class="y">Windows</td>
- <td data-col="win8" class="u"></td>
- </tr>
-<tr>
-<th><a href="#">PhoneGap<br>Build</a></th>
- <td data-col="android" class="y"></td>
- <td data-col="blackberry" class="y"></td>
- <td data-col="blackberry10" class="y"></td>
- <td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="u"></td>
- <td data-col="winphone8" class="y"></td>
- <td data-col="win8" class="u"></td>
- </tr>
-<tr>
-<th><a href="guide_platforms_index.md.html">SDK platform support</a></th>
- <td data-col="android" class="y"><a href="guide_platforms_android_index.md.html"> </a></td>
- <td data-col="blackberry" class="y"><a href="guide_platforms_blackberry_index.md.html"> </a></td>
- <td data-col="blackberry10" class="y"><a href="guide_platforms_blackberry10_index.md.html"> </a></td>
- <td data-col="ios" class="y"><a href="guide_platforms_ios_index.md.html"> </a></td>
- <td data-col="winphone7" class="y"><a href="guide_platforms_wp7_index.md.html"> </a></td>
- <td data-col="winphone8" class="y"><a href="guide_platforms_windows-phone-8_index.md.html"> </a></td>
- <td data-col="win8" class="y"><a href="guide_platforms_windows-8_index.md.html"> </a></td>
+ <td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
-<th><a href="#">Embedded<br>WebView</a></th>
- <td data-col="android" class="y"><a href="guide_platforms_android_webview.md.html"></a></td>
+<th><a href="guide_hybrid_webviews_index.md.html">Embedded<br>WebView</a></th>
+ <td data-col="android" class="y"><a href="guide_platforms_android_webview.md.html">(see details)</a></td>
<td data-col="blackberry" class="n"></td>
<td data-col="blackberry10" class="n"></td>
- <td data-col="ios" class="y"><a href="guide_platforms_ios_webview.md.html"></a></td>
+ <td data-col="ios" class="y"><a href="guide_platforms_ios_webview.md.html">(see details)</a></td>
<td data-col="winphone7" class="n"></td>
<td data-col="winphone8" class="n"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
-<th><a href="guide_plugin-development_index.md.html">Plug-in<br>Interface</a></th>
- <td data-col="android" class="y"><a href="guide_guide_platforms_android_plugin.md.html"></a></td>
- <td data-col="blackberry" class="y"><a href="guide_guide_platforms_blackberry_plugin.md.html"></a></td>
- <td data-col="blackberry10" class="y"><a href="guide_guide_platforms_blackberry10_plugin.md.html"></a></td>
- <td data-col="ios" class="y"><a href="guide_guide_platforms_ios_plugin.md.html"></a></td>
- <td data-col="winphone7" class="y"><a href="guide_guide_platforms_wp8_plugin.md.html"></a></td>
- <td data-col="winphone8" class="n"></td>
+<th><a href="guide_hybrid_plugins_index.md.html">Plug-in<br>Interface</a></th>
+ <td data-col="android" class="y"><a href="guide_guide_platforms_android_plugin.md.html">(see details)</a></td>
+ <td data-col="blackberry" class="y"><a href="guide_guide_platforms_blackberry_plugin.md.html">(see details)</a></td>
+ <td data-col="blackberry10" class="y"><a href="guide_guide_platforms_blackberry10_plugin.md.html">(see details)</a></td>
+ <td data-col="ios" class="y"><a href="guide_guide_platforms_ios_plugin.md.html">(see details)</a></td>
+ <td data-col="winphone7" class="y"><a href="guide_guide_platforms_wp8_plugin.md.html">(see details)</a></td>
+ <td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
<th></th>
@@ -311,6 +294,7 @@ available for each mobile platform:</p>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_camera_camera.md.html">Camera</a></th>
@@ -321,6 +305,7 @@ available for each mobile platform:</p>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_media_capture_capture.md.html">Capture</a></th>
@@ -331,16 +316,18 @@ available for each mobile platform:</p>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
<th><a href="cordova_compass_compass.md.html">Compass</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="n"></td>
- <td data-col="blackberry10" class="n"></td>
+ <td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y">(3GS+)</td>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_connection_connection.md.html">Connection</a></th>
@@ -351,6 +338,7 @@ available for each mobile platform:</p>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_contacts_contacts.md.html">Contacts</a></th>
@@ -361,6 +349,7 @@ available for each mobile platform:</p>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
<th><a href="cordova_device_device.md.html">Device</a></th>
@@ -371,6 +360,7 @@ available for each mobile platform:</p>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_events_events.md.html">Events</a></th>
@@ -381,6 +371,7 @@ available for each mobile platform:</p>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_file_file.md.html">File</a></th>
@@ -388,9 +379,10 @@ available for each mobile platform:</p>
<td data-col="blackberry" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="y"></td>
- <td data-col="winphone8" class="y"></td>
+ <td data-col="winphone7" class="p">(no <a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>)</td>
+ <td data-col="winphone8" class="p">(no <a href="cordova_file_file.md.html#FileTransfer">FileTransfer</a>)</td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
<th><a href="cordova_geolocation_geolocation.md.html">Geolocation</a></th>
@@ -401,16 +393,18 @@ available for each mobile platform:</p>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_globalization_globalization.md.html">Globalization</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="y"></td>
- <td data-col="blackberry10" class="y"></td>
+ <td data-col="blackberry10" class="n"></td>
<td data-col="ios" class="y"></td>
<td data-col="winphone7" class="n"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
<th><a href="cordova_inappbrowser_inappbrowser.md.html">InAppBrowser</a></th>
@@ -420,17 +414,19 @@ available for each mobile platform:</p>
<td data-col="ios" class="y"></td>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
- <td data-col="win8" class="y"></td>
+ <td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
<th><a href="cordova_media_media.md.html">Media</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="n"></td>
- <td data-col="blackberry10" class="n"></td>
+ <td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_notification_notification.md.html">Notification</a></th>
@@ -441,16 +437,18 @@ available for each mobile platform:</p>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_splashscreen_splashscreen.md.html">Splashscreen</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="n"></td>
- <td data-col="blackberry10" class="n"></td>
+ <td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="n"></td>
- <td data-col="winphone8" class="n"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
<th><a href="cordova_storage_storage.md.html">Storage</a></th>
@@ -458,9 +456,12 @@ available for each mobile platform:</p>
<td data-col="blackberry" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="y"></td>
- <td data-col="winphone8" class="y"></td>
+ <td data-col="winphone7" class="p">
+<a href="cordova_storage_storage.md.html#localStorage">localStorage</a> only</td>
+ <td data-col="winphone8" class="p">
+<a href="cordova_storage_storage.md.html#localStorage">localStorage</a> only</td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
</tbody>
</table>
Modified: cordova/site/public/docs/en/edge/guide_platforms_android_config.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/guide_platforms_android_config.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/guide_platforms_android_config.md.html (original)
+++ cordova/site/public/docs/en/edge/guide_platforms_android_config.md.html Thu Aug 1 22:17:43 2013
@@ -93,7 +93,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,41 +125,46 @@
<div id="content">
<h1><a name="Android%20Configuration">Android Configuration</a></h1>
-<p>The <code>config.xml</code> settings file controls various settings of Cordova. This is application wide, and not set per CordovaWebView Instance.</p>
+<p>The <code>config.xml</code> file controls various Cordova settings. These apply
+across the application, and per CordovaWebView instance.</p>
<h2>
<a name="Android%20Configuration_preference"><preference></a>
</h2>
-<p>Various <strong>other</strong> preferences (as <strong><preference></strong> tags) default on not breaking existing apps. The available preferences are:</p>
+<p>Various other preferences (as <code><preference></code> tags) default on not
+breaking existing apps. The available preferences are:</p>
-<ol>
-<li>
-<strong>useBrowserHistory (boolean, defaults to true)</strong> - set to false if you want to use the history shim that was used to work around the hashtag error present in Android 3.x prior to the history fix. (Note: This setting will be deprecated in April 2013)</li>
-<li>
-<strong>loadingDialog</strong> - Display a native loading dialog when loading the app. The value's format is <em>Title, Message</em>
-</li>
-<li>
-<strong>loadingPageDialog</strong> - Display a native loading dialog when loading sub-pages. The value's format is <em>Title, Message</em>
-</li>
-<li>
-<strong>errorUrl</strong> - Set the error page for your application. Should be located in your Android project in file://android_asset/www/</li>
-<li>
-<strong>backgroundColor</strong> - Set the background color for your application. Supports a four-byte hex value, with the first byte representing alpha value, and the following three bytes with standard RGB values. (i.e. 0x00000000 = Black)</li>
-<li>
-<strong>loadUrlTimeoutValue</strong> - How much time Cordova should wait before throwing a timeout error on the application.</li>
-<li>
-<strong>keepRunning (boolean, defaults to true)</strong> - Determines whether Cordova will keep running in the background or not</li>
-<li>
-<strong>splashscreen</strong> - The name of the file minus its extension in the <code>res/drawable</code> directory. If you have multiple assets, they all must share this common name in their respective directories.</li>
-<li>
-<strong>disallowOverscroll (boolean, defaults to false)</strong> - set to true if you want to disable the glow when a user scrolls beyond the edge of the webview.</li>
-</ol>
+<ul>
+<li><p><code>useBrowserHistory</code> (boolean, defaults to <code>true</code>): set to false if you
+want to use the history shim that was used to work around the
+hashtag error present in Android 3.x prior to the history fix.
+(Note: This setting will be deprecated in April 2013)</p></li>
+<li><p><code>loadingDialog</code>: Display a native loading dialog when loading the
+app. The value's format is <em>Title, Message</em></p></li>
+<li><p><code>loadingPageDialog</code>: Display a native loading dialog when loading
+sub-pages. The value's format is <em>Title, Message</em></p></li>
+<li><p><code>errorUrl</code>: Set the error page for your application. Should be
+located in your Android project in file://android_asset/www/</p></li>
+<li><p><code>backgroundColor</code>: Set the background color for your application.
+Supports a four-byte hex value, with the first byte representing
+alpha value, and the following three bytes with standard RGB
+values. (i.e. 0x00000000 = Black)</p></li>
+<li><p><code>loadUrlTimeoutValue</code>: How much time Cordova should wait before
+throwing a timeout error on the application.</p></li>
+<li><p><code>keepRunning</code> (boolean, defaults to <code>true</code>): Determines whether
+Cordova stays running in the background.</p></li>
+<li><p><code>splashscreen</code>: The name of the file minus its extension in the
+<code>res/drawable</code> directory. If you have multiple assets, they all
+must share this common name in their respective directories.</p></li>
+<li><p><code>disallowOverscroll</code> (boolean, defaults to <code>false</code>): set to <code>true</code> to
+disable the glow when a user scrolls beyond the edge of the webview.</p></li>
+</ul>
<h2>
<a name="Android%20Configuration_plugin"><plugin></a>
</h2>
-<p>Android supports using <feature> as analogues to <plugin> elements.</p>
+<p>Android supports using <code><feature></code> as analogues to <code><plugin></code> elements.</p>
</div>
</div>
Modified: cordova/site/public/docs/en/edge/guide_platforms_android_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/guide_platforms_android_index.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/guide_platforms_android_index.md.html (original)
+++ cordova/site/public/docs/en/edge/guide_platforms_android_index.md.html Thu Aug 1 22:17:43 2013
@@ -97,7 +97,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>
@@ -142,7 +141,7 @@ detailed platform-specific information:<
<li><a href="guide_platforms_android_tools.md.html#Android%20Command-line%20Tools">Android Command-line Tools</a></li>
</ul>
<p>The command-line tools above refer to versions prior to Cordova 3.0.
-See The Cordova Command-line Interface for information about the
+See <a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a> for information about the
current interface.</p>
<h2>
@@ -223,7 +222,7 @@ run:</p>
<p>Use the <code>cordova</code> utility to set up a new project, as described in The
Cordova <a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a>. For example, in a source-code directory:</p>
-<pre class="prettyprint"><code> $ cordova create hello com.example.hello "Hello World"
+<pre class="prettyprint"><code> $ cordova create hello com.example.hello "HelloWorld"
$ cd hello
$ cordova platform add android
$ cordova build
@@ -232,23 +231,22 @@ Cordova <a href="guide_cli_index.md.html
<p>Once created, here's how to use the SDK to modify it:</p>
<ul>
-<li>Launch the <strong>Eclipse</strong> application.</li>
-<li>Select the <strong>New Project</strong> menu item.</li>
-<li>Choose <strong>Android Project from Existing Code</strong> from the resulting dialog box, and press <strong>Next</strong>:
-<img src="img/guide/platforms/android/eclipse_new_project.png" alt="" title="">
-</li>
-<li>Navigate to <code>hello</code>, or whichever directory you created for the project, then to the <code>platforms/android</code> subdirectory.</li>
-<li>Press <strong>Finish</strong>.</li>
+<li><p>Launch the <strong>Eclipse</strong> application.</p></li>
+<li><p>Select the <strong>New Project</strong> menu item.</p></li>
+<li><p>Choose <strong>Android Project from Existing Code</strong> from the resulting dialog box, and press <strong>Next</strong>:
+<img src="img/guide/platforms/android/eclipse_new_project.png" alt="" title=""></p></li>
+<li><p>Navigate to <code>hello</code>, or whichever directory you created for the project, then to the <code>platforms/android</code> subdirectory.</p></li>
+<li><p>Press <strong>Finish</strong>.</p></li>
</ul>
<p>Once the Eclipse window opens, a red <strong>X</strong> may appear to indicate
unresolved problems. If so, follow these additional steps:</p>
<ul>
-<li>Right-click on the project folder.</li>
-<li>In the resulting <strong>Properties</strong> dialog, select <strong>Android</strong> from the navigation pane.</li>
-<li>For the project build target, select the highest Android API level you have installed.</li>
-<li>Click <strong>OK</strong>.</li>
-<li>Select <strong>Clean</strong> from the <strong>Project</strong> menu. This should correct all the errors in the project.</li>
+<li><p>Right-click on the project directory.</p></li>
+<li><p>In the resulting <strong>Properties</strong> dialog, select <strong>Android</strong> from the navigation pane.</p></li>
+<li><p>For the project build target, select the highest Android API level you have installed.</p></li>
+<li><p>Click <strong>OK</strong>.</p></li>
+<li><p>Select <strong>Clean</strong> from the <strong>Project</strong> menu. This should correct all the errors in the project.</p></li>
</ul>
<h2>
<a name="Android%20Platform%20Guide_deploy_to_emulator">Deploy to Emulator</a>
@@ -306,14 +304,14 @@ specify an AVD if none are already open.
<p>For a faster experience, use an Intel-based emulator image:</p>
<ul>
-<li>Install one or more <code>Intel x86 Atom</code> System Images as well as the
+<li><p>Install one or more <code>Intel x86 Atom</code> System Images as well as the
<code>Intel Hardware Accelerated Execution Manager</code>, available under
-<strong>Extras</strong>.</li>
-<li>Run the Intel installer, which is available within your Android SDK
-at <code>extras/intel/Hardware_Accelerated_Execution_Manager</code>.</li>
-<li>Create a new AVD with the target set to an Intel image.</li>
-<li>When starting the emulator, ensure there are no error messages
-indicating a failure to load HAX modules.</li>
+<strong>Extras</strong>.</p></li>
+<li><p>Run the Intel installer, which is available within your Android SDK
+at <code>extras/intel/Hardware_Accelerated_Execution_Manager</code>.</p></li>
+<li><p>Create a new AVD with the target set to an Intel image.</p></li>
+<li><p>When starting the emulator, ensure there are no error messages
+indicating a failure to load HAX modules.</p></li>
</ul>
<h2>
<a name="Android%20Platform%20Guide_deploy_to_device">Deploy to Device
Modified: cordova/site/public/docs/en/edge/guide_platforms_android_plugin.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/guide_platforms_android_plugin.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/guide_platforms_android_plugin.md.html (original)
+++ cordova/site/public/docs/en/edge/guide_platforms_android_plugin.md.html Thu Aug 1 22:17:43 2013
@@ -96,7 +96,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>
@@ -129,14 +128,19 @@
<div id="content">
<h1><a name="Android%20Plugins">Android Plugins</a></h1>
-<p>Writing a plugin requires an understanding of the architecture of Cordova-Android. Cordova-Android consists
-of an Android WebView with hooks attached to it. These plugins are represented as class mappings in the config.xml
-file.</p>
-
-<p>A plugin consists of at least one Java class that extends the <code>CordovaPlugin</code> class. A plugin must override one
-of the <code>execute</code> methods from <code>CordovaPlugin</code>.
-As best practice, the plugin should handle <code><a href="cordova_events_events.md.html#pause">pause</a></code> and <code><a href="cordova_events_events.md.html#resume">resume</a></code> events, and any message passing between plugins.
-Plugins with long-running requests, background activity such as media payback, listeners, or internal state should implement the <code>onReset()</code> method as well. This method is run when the <code>WebView</code> navigates to a new page or refreshes, which reloads the JavaScript.</p>
+<p>Writing a plugin requires an understanding of the architecture of
+Cordova-Android. Cordova-Android consists of an Android WebView with
+hooks attached to it. These plugins are represented as class mappings
+in the <code>config.xml</code> file.</p>
+
+<p>A plugin consists of at least one Java class that extends the
+<code>CordovaPlugin</code> class. A plugin must override one of the <code>execute</code>
+methods from <code>CordovaPlugin</code>. As best practice, the plugin should
+handle <code><a href="cordova_events_events.md.html#pause">pause</a></code> and <code><a href="cordova_events_events.md.html#resume">resume</a></code> events, and any message passing between
+plugins. Plugins with long-running requests, background activity such
+as media playback, listeners, or internal state should implement the
+<code>onReset()</code> method as well. It executeswhen the <code>WebView</code> navigates to
+a new page or refreshes, which reloads the JavaScript.</p>
<h2>
<a name="Android%20Plugins_plugin_class_mapping">Plugin Class Mapping</a>
@@ -151,9 +155,13 @@ Plugins with long-running requests, back
more or less boiling down to calling the <code>action</code> method on the
<code>service</code> class, with the arguments passed in the <code>args</code> Array.</p>
-<p>Whether you distribute your plugin as Java file or as a JAR of its own, the plugin must be added to the <code>config.xml</code> file in your Cordova-Android application's <code>res/xml/</code> folder.</p>
-
-<pre class="prettyprint"><code><plugin name="<service_name>" value="<full_name_including_namespace>"/>
+<p>Whether you distribute your plugin as Java file or as a JAR of its
+own, the plugin must be added to the <code>config.xml</code> file in your
+Cordova-Android application's <code>res/xml/</code> directory.</p>
+
+<pre class="prettyprint"><code><feature name="<service_name>">
+ <param name="android-package" value="<full_name_including_namespace>" />
+</feature>
</code></pre>
<p>The service name should match the one used in the JavaScript <code>exec</code>
@@ -237,7 +245,9 @@ public boolean execute(String action, JS
<p>Add the following to our <code>config.xml</code> file:</p>
-<pre class="prettyprint"><code><plugin name="Echo" value="org.apache.cordova.plugin.Echo" />
+<pre class="prettyprint"><code><feature name="Echo">
+ <param name="android-package" value="org.apache.cordova.plugin.Echo" />
+</feature>
</code></pre>
<p>Then add the following file to
@@ -246,8 +256,9 @@ application:</p>
<pre class="prettyprint"><code>package org.apache.cordova.plugin;
-import org.apache.cordova.api.CordovaPlugin;
-import org.apache.cordova.api.PluginResult;
+import org.apache.cordova.CordovaPlugin;
+import org.apache.cordova.CallbackContext;
+
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
@@ -256,6 +267,7 @@ import org.json.JSONObject;
* This class echoes a string called from JavaScript.
*/
public class Echo extends CordovaPlugin {
+
@Override
public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
if (action.equals("echo")) {
@@ -305,10 +317,10 @@ JavaScript success callback function.</p
</h2>
<ul>
-<li>Plugins have access to a <code>CordovaInterface</code> object. This object has access to the Android <code>Activity</code> that is running the application. This is the <code>Context</code> required to launch
+<li><p>Plugins have access to a <code>CordovaInterface</code> object. This object has access to the Android <code>Activity</code> that is running the application. This is the <code>Context</code> required to launch
a new Android <code>Intent</code>. The <code>CordovaInterface</code> allows plugins to start an <code>Activity</code> for a result, and to set the callback plugin for when the <code>Intent</code> comes back to the application. This is important, since the
-<code>Intent</code>s system is how Android communicates between processes.</li>
-<li>Plugins do not have direct access to the <code>Context</code> as they have in the past. The legacy <code>ctx</code> member is deprecated, and will be removed six months after 2.0 is released. All of <code>ctx</code> methods exist on the <code>Context</code>, so both <code>getContext()</code> and <code>getActivity()</code> are capable of returning the proper object required.</li>
+<code>Intent</code>s system is how Android communicates between processes.</p></li>
+<li><p>Plugins do not have direct access to the <code>Context</code> as they have in the past. The legacy <code>ctx</code> member is deprecated, and will be removed six months after 2.0 is released. All of <code>ctx</code> methods exist on the <code>Context</code>, so both <code>getContext()</code> and <code>getActivity()</code> are capable of returning the proper object required.</p></li>
</ul>
<h2>
<a name="Android%20Plugins_use_the_source">Use the Source</a>
@@ -317,7 +329,7 @@ a new Android <code>Intent</code>. The <
<p>One of the best ways to prepare yourself to write your own plugin is to
<a class="external" href="https://github.com/apache/cordova-android/tree/master/framework/src/org/apache/cordova">look over existing plugins</a>.</p>
-<p>You should also read through the comments in <a class="external" href="https://github.com/apache/cordova-android/blob/master/framework/src/org/apache/cordova/api/CordovaPlugin.java">CordovaPlugin.java</a>.</p>
+<p>You should also read through the comments in <a class="external" href="https://github.com/apache/cordova-android/blob/master/framework/src/org/apache/cordova/CordovaPlugin.java">CordovaPlugin.java</a>.</p>
</div>
</div>
Modified: cordova/site/public/docs/en/edge/guide_platforms_android_tools.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/guide_platforms_android_tools.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/guide_platforms_android_tools.md.html (original)
+++ cordova/site/public/docs/en/edge/guide_platforms_android_tools.md.html Thu Aug 1 22:17:43 2013
@@ -95,7 +95,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>
@@ -176,7 +175,7 @@ $ C:\path\to\project\cordova\build.bat -
<p>The <code>run</code> command accepts the following <em>optional</em> parameters:</p>
<ul>
-<li>Target specification. This includes <code>--emulator</code>, <code>--device</code>, or <code>--target=<targetID></code>.</li>
+<li><p>Target specification. This includes <code>--emulator</code>, <code>--device</code>, or <code>--target=<targetID></code>.</p></li>
<li>
<p>Build specification. This includes <code>--debug</code>, <code>--release</code>, or <code>--nobuild</code>.</p>