You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ma...@apache.org on 2013/10/01 05:56:01 UTC
svn commit: r1527865 [15/25] - in /cordova/site/public/docs/en/3.1.0: ./
img/ img/guide/ img/guide/cli/ img/guide/platforms/
img/guide/platforms/android/ img/guide/platforms/bada/
img/guide/platforms/blackberry10/ img/guide/platforms/ios/ img/guide/pla...
Added: cordova/site/public/docs/en/3.1.0/guide_cli_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.1.0/guide_cli_index.md.html?rev=1527865&view=auto
==============================================================================
--- cordova/site/public/docs/en/3.1.0/guide_cli_index.md.html (added)
+++ cordova/site/public/docs/en/3.1.0/guide_cli_index.md.html Tue Oct 1 03:55:57 2013
@@ -0,0 +1,551 @@
+<!DOCTYPE html>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+--><html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="Chinese" value="zh"><option value="edge">edge</option></optgroup>
+<optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="3.1.0">3.1.0</option>
+<option value="3.0.0">3.0.0</option>
+<option value="2.9.0">2.9.0</option>
+<option value="2.8.0">2.8.0</option>
+<option value="2.7.0">2.7.0</option>
+<option value="2.6.0">2.6.0</option>
+<option value="2.5.0">2.5.0</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="French" value="fr"><option value="edge">edge</option></optgroup>
+<optgroup label="German" value="de"><option value="edge">edge</option></optgroup>
+<optgroup label="Italian" value="it"><option value="edge">edge</option></optgroup>
+<optgroup label="Japanese" value="ja">
+<option value="edge">edge</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="ko">
+<option value="edge">edge</option>
+<option value="2.0.0">2.0.0</option>
+</optgroup>
+<optgroup label="Russian" value="ru"><option value="edge">edge</option></optgroup>
+<optgroup label="Spanish" value="es"><option value="edge">edge</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>The Command-line Interface</h1>
+ <small><select><option value="The%2520Command-line%2520Interface">The Command-line Interface</option>
+<option value="The%20Command-line%20Interface_prerequisites">Â Â Â Â Â Â - Prerequisites</option>
+<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_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_customize_each_platform">Â Â Â Â Â Â - Customize Each Platform</option>
+<option value="The%20Command-line%20Interface_updating_cordova">Â Â Â Â Â Â - Updating Cordova</option></select></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>Guides</h1>
+<ul>
+<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="config_ref_index.md.html#The%20config.xml%20File">The config.xml File</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>
+<li><a href="guide_appdev_privacy_index.md.html#Privacy%20Guide">Privacy Guide</a></li>
+<li><a href="guide_appdev_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+<h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="The%20Command-line%20Interface">The Command-line Interface</a></h1>
+
+<p>This guide shows you how to create applications and deploy them to
+various native mobile platforms using the <code>cordova</code> command-line
+interface (CLI). This tool allows you to create new projects, build
+them on different platforms, and run them within an emulator. You can
+also use the CLI to initialize project code, after which you use
+various platforms' SDKs to develop them further.</p>
+
+<h2>
+<a name="The%20Command-line%20Interface_prerequisites">Prerequisites</a>
+</h2>
+
+<p>Before running any command-line tools, you need to install SDKs for
+each platform you wish to target.
+(See the <a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a> for more details.)</p>
+
+<p>To add support or rebuild a project for any platform, you need to run
+the command-line interface from the same machine that supports the
+platform's SDK. The CLI supports the following combinations:</p>
+
+<ul>
+<li>iOS (Mac)</li>
+<li>Android (Mac, Linux)</li>
+<li>BlackBerry 10 (Mac, Linux, Windows)</li>
+<li>Windows Phone 7 (Windows)</li>
+<li>Windows Phone 8 (Windows)</li>
+<li>Windows 8 (Windows)</li>
+<li>Firefox OS (Mac, Linux, Windows)</li>
+</ul>
+<p>On the Mac, the command-line is available via the <em>Terminal</em>
+application. On the PC, it's available as <em>Command Prompt</em> under
+<em>Accessories</em>.</p>
+
+<p>The more likely it is that you run the CLI from different machines,
+the more it makes sense to maintain a remote source code repository,
+whose assets you pull down to local working directories.</p>
+
+<p>To install the <code>cordova</code> command-line tool, follow these steps:</p>
+
+<ol>
+<li><p>Download and install <a class="external" href="http://nodejs.org/">Node.js</a>. Following
+installation, you should be able to invoke <code>node</code> or <code>npm</code> on your
+command line.</p></li>
+<li>
+<p>Install the <code>cordova</code> utility. In Unix, prefixing the additional
+<code>sudo</code> command may be necessary to install development utilities in
+otherwise restricted directories:</p>
+
+<pre class="prettyprint"><code>$ sudo npm install -g cordova
+</code></pre>
+
+<p>The installation log may produce errors for any uninstalled
+platform SDKs. Following installation, you should be able to run
+<code>cordova</code> on the command line.</p>
+</li>
+</ol>
+<h2>
+<a name="The%20Command-line%20Interface_create_the_app">Create the App</a>
+</h2>
+
+<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 hello com.example.hello HelloWorld
+</code></pre>
+
+<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
+<code>config.xml</code> file contains important metadata needed to generate and
+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>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>
+<a name="The%20Command-line%20Interface_add_platforms">Add Platforms</a>
+</h2>
+
+<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 hello
+</code></pre>
+
+<p>Before you can build the project, you need to specify a set of target
+platforms. Your ability to run these commands depends on whether your
+machine supports each SDK, and whether you have already installed each
+SDK. Run any of these from a Mac:</p>
+
+<pre class="prettyprint"><code> $ cordova platform add ios
+ $ cordova platform add android
+ $ cordova platform add blackberry10
+ $ cordova platform add firefoxos
+</code></pre>
+
+<p>Run any of these from a Windows machine, where <em>wp</em> refers to
+different versions of the Windows Phone operating system:</p>
+
+<pre class="prettyprint"><code> $ cordova platform add wp7
+ $ cordova platform add wp8
+ $ cordova platform add windows8
+ $ cordova platform add android
+ $ cordova platform add blackberry10
+ $ cordova platform add firefoxos
+</code></pre>
+
+<p>Run this to check your current set of platforms:</p>
+
+<pre class="prettyprint"><code> $ cordova platforms ls
+</code></pre>
+
+<p>(Note the <code>platform</code> and <code>platforms</code> commands are synonymous.)</p>
+
+<p>Run either of the following synonymous commands to remove a platform:</p>
+
+<pre class="prettyprint"><code> $ cordova platform remove blackberry10
+ $ cordova platform rm android
+</code></pre>
+
+<p>Running commands to add or remove platforms affects the contents of
+the project's <em>platforms</em> directory, where each specified platform
+appears as a subdirectory. The <em>www</em> source directory is reproduced
+within each platform's subdirectory, appearing for example in
+<code>platforms/ios/www</code> or <code>platforms/android/assets/www</code>. By default,
+each platform's configuration file is set up to be able to access all
+of Cordova's APIs.</p>
+
+<p>If you wish, you can use an SDK at this point to open the project you
+created. However, any edits you make to the project within an SDK
+affect the derivative set of assets, not the original cross-platform
+source files. Use this approach if you simply want to initialize a
+project.
+(See the <a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a> for information on how to develop applications within each SDK.)
+Read on if you wish to use command-line tools for the entire
+development cycle.</p>
+
+<h2>
+<a name="The%20Command-line%20Interface_build_the_app">Build the App</a>
+</h2>
+
+<p>By default, the <code>cordova create</code> script generates a skeletal web-based
+application whose home page is the project's <code>www/index.html</code> file.
+Edit this application however you want, but any initialization should
+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 the Application Development Guide for details.)
+XREF --></p>
+
+<p>Run the following command to iteratively build the project:</p>
+
+<pre class="prettyprint"><code> $ cordova build
+</code></pre>
+
+<p>This generates platform-specific code within the project's <code>platforms</code>
+subdirectory. You can optionally limit the scope of each build to
+specific platforms:</p>
+
+<pre class="prettyprint"><code> $ cordova build ios
+</code></pre>
+
+<p>The <code>cordova build</code> command is a shorthand for the following, which in
+this example is also targeted to a single platform:</p>
+
+<pre class="prettyprint"><code> $ cordova prepare ios
+ $ cordova compile ios
+</code></pre>
+
+<p>In this case, once you run <code>prepare</code>, you can use Apple's Xcode SDK as
+an alternative to modify and compile the platform-specific code that
+Cordova generates within <code>platforms/ios</code>. You can use the same
+approach with other platforms' SDKs.</p>
+
+<h2>
+<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
+execute a device image, so that you can launch the app from the home
+screen and see how it interacts with many platform features. Run a
+command such as the following to rebuild the app and view it within a
+specific platform's emulator:</p>
+
+<pre class="prettyprint"><code> $ cordova emulate android
+</code></pre>
+
+<p>Some mobile platforms emulate a particular device by default, such as
+the iPhone for iOS projects. For other platforms, you may need to
+first associate a device with an emulator.
+(See the <a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a> for details.)
+For example, you may first run the <code>android</code> command to launch the
+Android SDK, then run a particular device image, which launches it
+according to its default behavior:</p>
+
+<p><img src="img/guide/cli/android_emulate_init.png" alt="" title=""></p>
+
+<p>Following up with the <code>cordova emulate</code> command refreshes the emulator
+image to display the latest application, which is now available for
+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>
+
+<p>When you build and view a new project, the default application that
+appears doesn't do very much. You can modify the app in many ways to
+take advantage of standard web technologies, but for the app to
+communicate closely with various device-level features, you need to
+add plugins that provide access to core Cordova APIs.</p>
+
+<p>A <em>plugin</em> is a bit of add-on code that provides an interface to
+native components. You can design your own plugin interface, for
+example when designing a hybrid app that mixes a Cordova WebView with
+native components. (See <a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a> and <a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a> for details.) More commonly, you would add a plugin to enable
+one of Cordova's basic device-level features
+<!-- XREF
+discussed in the Application Development Guide and
+XREF -->
+detailed in the <a href="index.md.html#API%20Reference">API Reference</a>.</p>
+
+<p>The <code>cordova plugin add</code> command requires you to specify the
+repository for the plugin code. Here are examples of features you
+might add:</p>
+
+<ul>
+<li>
+<p>Basic device information (<a href="cordova_device_device.md.html#Device">Device</a> API):</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add org.apache.cordova.device
+</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 org.apache.cordova.network-information
+$ cordova plugin add org.apache.cordova.battery-status
+</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 org.apache.cordova.device-motion
+$ cordova plugin add org.apache.cordova.device-orientation
+$ cordova plugin add org.apache.cordova.geolocation
+</code></pre>
+</li>
+<li>
+<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 org.apache.cordova.camera
+$ cordova plugin add org.apache.cordova.media-capture
+$ cordova plugin add org.apache.cordova.media
+</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 org.apache.cordova.file
+$ cordova plugin add org.apache.cordova.file-transfer
+</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 org.apache.cordova.dialogs
+$ cordova plugin add org.apache.cordova.vibration
+</code></pre>
+</li>
+<li>
+<p><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a>:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add org.apache.cordova.contacts
+</code></pre>
+</li>
+<li>
+<p><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a>:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add org.apache.cordova.globalization
+</code></pre>
+</li>
+<li>
+<p><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a>:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add org.apache.cordova.splashscreen
+</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 org.apache.cordova.inappbrowser
+</code></pre>
+</li>
+<li>
+<p>Debug console:</p>
+
+<pre class="prettyprint"><code>$ cordova plugin add org.apache.cordova.console
+</code></pre>
+</li>
+</ul>
+<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.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.console
+ $ cordova plugin remove org.apache.cordova.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>
+
+<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_updating_cordova">Updating Cordova</a>
+</h2>
+
+<p>After installing the <code>cordova</code> utility, you can always
+update it to the latest version by running the following command:</p>
+
+<pre class="prettyprint"><code> $ sudo npm update -g cordova
+</code></pre>
+
+<p>Use this syntax to install a specific version:</p>
+
+<pre class="prettyprint"><code> $ sudo npm install -g cordova@3.1.0
+</code></pre>
+
+<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>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>
Added: cordova/site/public/docs/en/3.1.0/guide_hybrid_plugins_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.1.0/guide_hybrid_plugins_index.md.html?rev=1527865&view=auto
==============================================================================
--- cordova/site/public/docs/en/3.1.0/guide_hybrid_plugins_index.md.html (added)
+++ cordova/site/public/docs/en/3.1.0/guide_hybrid_plugins_index.md.html Tue Oct 1 03:55:57 2013
@@ -0,0 +1,257 @@
+<!DOCTYPE html>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+--><html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="Chinese" value="zh"><option value="edge">edge</option></optgroup>
+<optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="3.1.0">3.1.0</option>
+<option value="3.0.0">3.0.0</option>
+<option value="2.9.0">2.9.0</option>
+<option value="2.8.0">2.8.0</option>
+<option value="2.7.0">2.7.0</option>
+<option value="2.6.0">2.6.0</option>
+<option value="2.5.0">2.5.0</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="French" value="fr"><option value="edge">edge</option></optgroup>
+<optgroup label="German" value="de"><option value="edge">edge</option></optgroup>
+<optgroup label="Italian" value="it"><option value="edge">edge</option></optgroup>
+<optgroup label="Japanese" value="ja">
+<option value="edge">edge</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="ko">
+<option value="edge">edge</option>
+<option value="2.0.0">2.0.0</option>
+</optgroup>
+<optgroup label="Russian" value="ru"><option value="edge">edge</option></optgroup>
+<optgroup label="Spanish" value="es"><option value="edge">edge</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Plugin Development Guide</h1>
+ <small><select><option value="Plugin%2520Development%2520Guide">Plugin Development Guide</option>
+<option value="Plugin%20Development%20Guide_javascript">Â Â Â Â Â Â - JavaScript</option>
+<option value="Plugin%20Development%20Guide_plugin_specification">Â Â Â Â Â Â - Plugin Specification</option>
+<option value="Plugin%20Development%20Guide_native">Â Â Â Â Â Â - Native</option>
+<option value="Plugin%20Development%20Guide_publishing_plugins">Â Â Â Â Â Â - Publishing plugins</option></select></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>Guides</h1>
+<ul>
+<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="config_ref_index.md.html#The%20config.xml%20File">The config.xml File</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>
+<li><a href="guide_appdev_privacy_index.md.html#Privacy%20Guide">Privacy Guide</a></li>
+<li><a href="guide_appdev_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+<h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Plugin%20Development%20Guide">Plugin Development Guide</a></h1>
+
+<p>A Cordova plugin bridges a bit of functionality between the WebView
+powering a Cordova application and the native platform the Cordova
+application is running on. Plugins are composed of a single JavaScript
+interface used across all platforms, and native implementations
+following platform-specific Plugin interfaces that the JavaScript
+calls into. All of the core Cordova APIs are implemented using this
+architecture.</p>
+
+<p>This guide steps the process of writing a simple Echo Plugin that
+passes a string from JavaScript and sends it into the native
+environment for the supported platforms. The native code then returns
+the same string back to the callbacks inside the plugin's JavaScript.</p>
+
+<p>This guide provides enough overview on which you can build to write
+more complex plugins.</p>
+
+<h2>
+<a name="Plugin%20Development%20Guide_javascript">JavaScript</a>
+</h2>
+
+<p>The entry point for any plugin is JavaScript. The reason developers use
+Cordova is so they can use and write JavaScript, not Objective-C,
+not Java, not C#. The JavaScript interface for your plugin is the
+front-facing and arguably most important part of your Cordova plugin.</p>
+
+<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>
+
+<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>
+
+<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).</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.</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.</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]);
+ };
+</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.
+ });
+</code></pre>
+
+<p>First, let's take a look at the last three arguments to the <code>exec</code>
+function. We will be calling the <code>Echo</code> "service", requesting the <code>echo</code>
+"action", and passing an array of arguments containing the echo string,
+which is the first parameter into the <code>window.echo</code> function.</p>
+
+<p>The success callback passed into <code>exec</code> is simply a reference to the
+callback function that <code>window.echo</code> takes. We do a bit more for the
+error callback: if the native side fires off the error callback, we
+simply invoke the success callback and pass into it a "default"
+string.</p>
+
+<h2>
+<a name="Plugin%20Development%20Guide_plugin_specification">Plugin Specification</a>
+</h2>
+
+<p>Cordova has a plugin specification available to enable automated
+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>
+
+<ul>
+<li><a href="plugin_ref_spec.md.html#Plugin%20Specification">Plugin Specification</a></li>
+</ul>
+<h2>
+<a name="Plugin%20Development%20Guide_native">Native</a>
+</h2>
+
+<p>Once you define JavaScript for your plugin, you need to complement it
+with at least one native implementation. Details to do so for each
+platform are listed below. These guides continue to build on the
+simple Echo Plugin example discussed above.</p>
+
+<ul>
+<li><a href="guide_platforms_android_plugin.md.html#Android%20Plugins">Android Plugins</a></li>
+<li><a href="guide_platforms_blackberry_plugin.md.html#BlackBerry%20Plugins">BlackBerry Plugins</a></li>
+<li><a href="guide_platforms_blackberry10_plugin.md.html#BlackBerry%2010%20Plugins">BlackBerry 10 Plugins</a></li>
+<li><a href="guide_platforms_ios_plugin.md.html#iOS%20Plugins">iOS Plugins</a></li>
+<li><a href="guide_platforms_wp8_plugin.md.html#Windows%20Phone%20Plugins">Windows Phone Plugins</a></li>
+</ul>
+<p>The Tizen platform currently does not support plugins.</p>
+
+<h2>
+<a name="Plugin%20Development%20Guide_publishing_plugins">Publishing plugins</a>
+</h2>
+
+<p>Once you developed your plugin, you might want to publish it and share it with the community. You can publish your plugin to the cordova registry (based on <a class="external" href="https://github.com/isaacs/npmjs.org">npmjs</a>) or to any other npmjs based registry. Users will be able to install it automatically using either plugman or cordova-cli.</p>
+
+<p>To publish a plugin you need to use the plugman tool and go through the following steps:</p>
+
+<pre class="prettyprint"><code>$ plugman adduser # that is if you don't have an account yet
+$ plugman publish /path/to/your/plugin
+</code></pre>
+
+<p>That is it!</p>
+
+<p>Other registry-based commands are available and <code>plugman --help</code> will give you a list of what commands are available and how to use them. </p>
+
+ </div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>
Added: cordova/site/public/docs/en/3.1.0/guide_hybrid_webviews_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.1.0/guide_hybrid_webviews_index.md.html?rev=1527865&view=auto
==============================================================================
--- cordova/site/public/docs/en/3.1.0/guide_hybrid_webviews_index.md.html (added)
+++ cordova/site/public/docs/en/3.1.0/guide_hybrid_webviews_index.md.html Tue Oct 1 03:55:57 2013
@@ -0,0 +1,133 @@
+<!DOCTYPE html>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+--><html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="Chinese" value="zh"><option value="edge">edge</option></optgroup>
+<optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="3.1.0">3.1.0</option>
+<option value="3.0.0">3.0.0</option>
+<option value="2.9.0">2.9.0</option>
+<option value="2.8.0">2.8.0</option>
+<option value="2.7.0">2.7.0</option>
+<option value="2.6.0">2.6.0</option>
+<option value="2.5.0">2.5.0</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="French" value="fr"><option value="edge">edge</option></optgroup>
+<optgroup label="German" value="de"><option value="edge">edge</option></optgroup>
+<optgroup label="Italian" value="it"><option value="edge">edge</option></optgroup>
+<optgroup label="Japanese" value="ja">
+<option value="edge">edge</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="ko">
+<option value="edge">edge</option>
+<option value="2.0.0">2.0.0</option>
+</optgroup>
+<optgroup label="Russian" value="ru"><option value="edge">edge</option></optgroup>
+<optgroup label="Spanish" value="es"><option value="edge">edge</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Embedding WebViews</h1>
+ <small></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>Guides</h1>
+<ul>
+<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="config_ref_index.md.html#The%20config.xml%20File">The config.xml File</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>
+<li><a href="guide_appdev_privacy_index.md.html#Privacy%20Guide">Privacy Guide</a></li>
+<li><a href="guide_appdev_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+<h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Embedding%20WebViews">Embedding WebViews</a></h1>
+
+<blockquote>
+ <p>Implement the Cordova WebView in your own project.</p>
+</blockquote>
+
+<ul>
+<li><a href="guide_platforms_android_webview.md.html#Android%20WebViews">Android WebViews</a></li>
+<li><a href="guide_platforms_ios_webview.md.html#iOS%20WebViews">iOS WebViews</a></li>
+</ul>
+</div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>
Added: cordova/site/public/docs/en/3.1.0/guide_overview_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.1.0/guide_overview_index.md.html?rev=1527865&view=auto
==============================================================================
--- cordova/site/public/docs/en/3.1.0/guide_overview_index.md.html (added)
+++ cordova/site/public/docs/en/3.1.0/guide_overview_index.md.html Tue Oct 1 03:55:57 2013
@@ -0,0 +1,476 @@
+<!DOCTYPE html>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+--><html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="Chinese" value="zh"><option value="edge">edge</option></optgroup>
+<optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="3.1.0">3.1.0</option>
+<option value="3.0.0">3.0.0</option>
+<option value="2.9.0">2.9.0</option>
+<option value="2.8.0">2.8.0</option>
+<option value="2.7.0">2.7.0</option>
+<option value="2.6.0">2.6.0</option>
+<option value="2.5.0">2.5.0</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="French" value="fr"><option value="edge">edge</option></optgroup>
+<optgroup label="German" value="de"><option value="edge">edge</option></optgroup>
+<optgroup label="Italian" value="it"><option value="edge">edge</option></optgroup>
+<optgroup label="Japanese" value="ja">
+<option value="edge">edge</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="ko">
+<option value="edge">edge</option>
+<option value="2.0.0">2.0.0</option>
+</optgroup>
+<optgroup label="Russian" value="ru"><option value="edge">edge</option></optgroup>
+<optgroup label="Spanish" value="es"><option value="edge">edge</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Overview</h1>
+ <small><select><option value="Overview">Overview</option>
+<option value="Overview_basic_components">Â Â Â Â Â Â - Basic Components</option>
+<option value="Overview_development_paths">Â Â Â Â Â Â - Development Paths</option>
+<option value="Overview_platform_support">Â Â Â Â Â Â - Platform Support</option></select></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>Guides</h1>
+<ul>
+<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="config_ref_index.md.html#The%20config.xml%20File">The config.xml File</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>
+<li><a href="guide_appdev_privacy_index.md.html#Privacy%20Guide">Privacy Guide</a></li>
+<li><a href="guide_appdev_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+<h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Overview">Overview</a></h1>
+
+<p>Cordova is an open-source mobile development framework. It allows you
+to use standard web technologies such as HTML5, CSS3, and JavaScript
+for cross-platform development, avoiding each mobile platforms' native
+development language. Applications execute within wrappers targeted
+to each platform, and rely on standards-compliant API bindings to
+access each device's sensors, data, and network status.</p>
+
+<p>Use Cordova if you are:</p>
+
+<ul>
+<li><p>a mobile developer and want to extend an application across more
+than one platform, without having to re-implement it with each
+platform's language and tool set.</p></li>
+<li><p>a web developer and want to deploy a web app that's packaged for
+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 plugin interface
+between native and WebView components.</p></li>
+</ul>
+<h2>
+<a name="Overview_basic_components">Basic Components</a>
+</h2>
+
+<p>Cordova applications rely on a common <code>config.xml</code> file that provides
+information about the app and specifies parameters affecting how it
+works, such as whether it responds to orientation shifts. This file
+adheres to the W3C's
+<a class="external" href="http://www.w3.org/TR/widgets/">Packaged Web App</a>,
+or <em>widget</em>, specification.</p>
+
+<p>The application itself is implemented as a web page, named
+<em>index.html</em> by default, that references whatever CSS, JavaScript,
+images, media files, or other resources are necessary for it to run.
+The app executes as a <em>WebView</em> within the native application wrapper,
+which you distribute to app stores. For the web app to interact with
+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 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>plugin</em> interface for these
+components to communicate with each other.</p>
+
+<h2>
+<a name="Overview_development_paths">Development Paths</a>
+</h2>
+
+<p>The easiest way to set up an application is to run the <code>cordova</code>
+command-line utility, also known as the <em>command-line interface</em>
+(CLI). (To install the CLI, see <a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a>.)
+Depending on the set of platforms you wish to target, you can rely on
+the CLI for progressively greater shares of the development cycle:</p>
+
+<ul>
+<li><p>In the most basic scenario, you can use the CLI simply to create a
+new project that is populated with default configuration for you to
+modify.</p></li>
+<li><p>For many mobile platforms, you can also use the CLI to set up
+additional project files required to compile within each SDK. For
+this to work, you must install each targeted platform's SDK.
+(See the <a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a> for instructions.)
+As indicated in the Platform Support table below, you may need to
+run the CLI on different operating systems depending on the targeted
+platform.</p></li>
+<li><p>For supporting platforms, the CLI can compile executible
+applications and run them in an SDK-based device emulator.
+<!-- XREF
+(See Application Development Guide for details.)
+XREF -->
+For comprehensive testing, you can also generate application files
+and install them directly on a device.</p></li>
+</ul>
+<p>At any point in the development cycle, you can also rely on
+platform-specific SDK tools, which may provide a richer set of
+options.
+(See the <a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a> for details about each platform's SDK tool set.)
+An SDK environment is more appropriate if you want implement a hybrid
+app that mixes web-based and native application components.
+<!-- XREF
+(See Hybrid Application Guide for more information.)
+XREF -->
+You may use the command-line utility to initially generate the app, or
+iteratively thereafter to feed updated code to SDK tools. You may
+also build the app's configuration file yourself.
+<!-- XREF
+(See <a href="config_ref_index.md.html#The config.xml File">The config.xml File</a> for details.)
+XREF --></p>
+
+<!-- XREF
+To build projects on some platforms, you may need to apply digital signatures.
+See Distributing Applications for information on how to upload your app to various store portals.
+XREF -->
+
+<h2>
+<a name="Overview_platform_support">Platform Support</a>
+</h2>
+
+<p>The following shows the set of development tools and device APIs
+available for each mobile platform. (Column headers display the
+CLI's shorthand stubs.)</p>
+
+<!-- START HTML -->
+
+<table class="compat" width="100%">
+<thead><tr>
+<th>
+ </th>
+<th><tt>android</tt></th>
+ <th>
+<tt>blackberry</tt> (6)</th>
+ <th><tt>blackberry10</tt></th>
+ <th><tt>ios</tt></th>
+ <th>
+<tt>wp7</tt> (Windows<br>Phone 7)</th>
+ <th>
+<tt>wp8</tt> (Windows<br>Phone 8)</th>
+ <th>
+<tt>win8</tt><br>(Windows 8)</th>
+ <th><tt>firefoxos</tt></th>
+ <th><tt>tizen</tt></th>
+ </tr></thead>
+<tbody>
+<tr>
+<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="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="n"></td>
+ <td data-col="tizen" class="n"></td>
+ </tr>
+<tr>
+<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">(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_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>
+ <th colspan="20">Platform APIs</th>
+ </tr>
+<tr>
+<th><a href="cordova_accelerometer_accelerometer.md.html">Accelerometer</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="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>
+ <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="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>
+ <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="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="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>
+ <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="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>
+ <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="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>
+ <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="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>
+ <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="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>
+ <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="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>
+ <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="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="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>
+ <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="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_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="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>
+ <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="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="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="n"></td>
+ </tr>
+<tr>
+<th><a href="cordova_storage_storage.md.html">Storage</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="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>
+<!-- END HTML -->
+</div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>
Added: cordova/site/public/docs/en/3.1.0/guide_platforms_android_config.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.1.0/guide_platforms_android_config.md.html?rev=1527865&view=auto
==============================================================================
--- cordova/site/public/docs/en/3.1.0/guide_platforms_android_config.md.html (added)
+++ cordova/site/public/docs/en/3.1.0/guide_platforms_android_config.md.html Tue Oct 1 03:55:57 2013
@@ -0,0 +1,186 @@
+<!DOCTYPE html>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+--><html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="Chinese" value="zh"><option value="edge">edge</option></optgroup>
+<optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="3.1.0">3.1.0</option>
+<option value="3.0.0">3.0.0</option>
+<option value="2.9.0">2.9.0</option>
+<option value="2.8.0">2.8.0</option>
+<option value="2.7.0">2.7.0</option>
+<option value="2.6.0">2.6.0</option>
+<option value="2.5.0">2.5.0</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="French" value="fr"><option value="edge">edge</option></optgroup>
+<optgroup label="German" value="de"><option value="edge">edge</option></optgroup>
+<optgroup label="Italian" value="it"><option value="edge">edge</option></optgroup>
+<optgroup label="Japanese" value="ja">
+<option value="edge">edge</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="ko">
+<option value="edge">edge</option>
+<option value="2.0.0">2.0.0</option>
+</optgroup>
+<optgroup label="Russian" value="ru"><option value="edge">edge</option></optgroup>
+<optgroup label="Spanish" value="es"><option value="edge">edge</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Android Configuration</h1>
+ <small></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>Guides</h1>
+<ul>
+<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="config_ref_index.md.html#The%20config.xml%20File">The config.xml File</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>
+<li><a href="guide_appdev_privacy_index.md.html#Privacy%20Guide">Privacy Guide</a></li>
+<li><a href="guide_appdev_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+<h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Android%20Configuration">Android Configuration</a></h1>
+
+<p>The <code>config.xml</code> file controls an app's basic settings that apply
+across each application and CordovaWebView instance. This section
+details preferences that only apply to Android builds. See <a href="#The%0Aconfig.xml%20File">The
+config.xml File</a> for information on global configuration options.</p>
+
+<ul>
+<li>
+<p><code>KeepRunning</code> (boolean, defaults to <code>true</code>): Determines whether the
+application stays running in the background even after a <code><a href="cordova_events_events.md.html#pause">pause</a></code>
+event fires.</p>
+
+<pre class="prettyprint"><code><preference name="KeepRunning" value="false"/>
+</code></pre>
+</li>
+<li>
+<p><code>ErrorUrl</code>: Specifies an error page that displays in response to
+standard HTTP errors in the 400-500 range. Place the specified file
+in the top-level directory containing the home page and other web
+assets.</p>
+
+<pre class="prettyprint"><code><preference name="ErrorUrl" value="error.html"/>
+</code></pre>
+</li>
+<li>
+<p><code>LoadingDialog</code>: Display a native dialog when loading the app. The
+value's format is <em>Title, Message</em></p>
+
+<pre class="prettyprint"><code><preference name="LoadingDialog" value="Please wait, the app is loading"/>
+</code></pre>
+</li>
+<li>
+<p><code>LoadingPageDialog</code>: Display a native dialog when loading sub-pages
+within an app. The value's format is <em>Title, Message</em></p>
+
+<pre class="prettyprint"><code><preference name="LoadingPageDialog" value="Please wait, the data is loading"/>
+</code></pre>
+</li>
+<li>
+<p><code>LoadUrlTimeoutValue</code> (number, default is <code>20000</code>): When loading a
+page, the amount of time to wait before throwing a timeout error.
+This example specifies 10 seconds rather than 20:</p>
+
+<pre class="prettyprint"><code><preference name="LoadUrlTimeoutValue" value="10000"/>
+</code></pre>
+</li>
+<li>
+<p><code>SplashScreen</code>: The name of the file minus its extension in the
+<code>res/drawable</code> directory. Various assets must share this common
+name in various subdirectories.</p>
+
+<pre class="prettyprint"><code><preference name="SplashScreen" value="splash"/>
+</code></pre>
+</li>
+<li>
+<p><code>SplashScreenDelay</code> (number, defaults to <code>5000</code>): The amount of
+time the splash screen image displays.</p>
+
+<pre class="prettyprint"><code><preference name="SplashScreenDelay" value="10000"/>
+</code></pre>
+</li>
+</ul>
+</div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>