You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by fi...@apache.org on 2012/11/30 20:30:16 UTC
[7/10] tagging docs 2.3.0rc1
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/notification/notification.beep.md b/docs/en/2.3.0rc1/cordova/notification/notification.beep.md
new file mode 100644
index 0000000..2f8d51f
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/notification/notification.beep.md
@@ -0,0 +1,120 @@
+---
+license: 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.
+---
+
+notification.beep
+=================
+
+The device will play a beep sound.
+
+ navigator.notification.beep(times);
+
+- __times:__ The number of times to repeat the beep (`Number`)
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 7 ( Mango )
+- Bada 1.2 & 2.x
+- Tizen
+
+Quick Example
+-------------
+
+ // Beep twice!
+ navigator.notification.beep(2);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Notification Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // Show a custom alert
+ //
+ function showAlert() {
+ navigator.notification.alert(
+ 'You are the winner!', // message
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
+ }
+
+ // Beep three times
+ //
+ function playBeep() {
+ navigator.notification.beep(3);
+ }
+
+ // Vibrate for 2 seconds
+ //
+ function vibrate() {
+ navigator.notification.vibrate(2000);
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
+ <p><a href="#" onclick="playBeep(); return false;">Play Beep</a></p>
+ <p><a href="#" onclick="vibrate(); return false;">Vibrate</a></p>
+ </body>
+ </html>
+
+Android Quirks
+--------------
+
+- Android plays the default "Notification ringtone" specified under the "Settings/Sound & Display" panel.
+
+iPhone Quirks
+-------------
+
+- Ignores the beep count argument.
+- There is no native beep API for iPhone.
+ - Cordova implements beep by playing an audio file via the media API.
+ - The user must provide a file with the desired beep tone.
+ - This file must be less than 30 seconds long, located in the www/ root, and must be named `beep.wav`.
+
+Windows Phone 7 Quirks
+-------------
+
+- WP7 Cordova lib includes a generic beep file that is used.
+
+Tizen Quirks
+-------------
+
+ - Tizen implements beep by playing an audio file via the media API.
+ - This beep file must be short, named `beep.wav` and has to be located in a 'sounds' sub-directory of the application root disctory.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/notification/notification.confirm.md b/docs/en/2.3.0rc1/cordova/notification/notification.confirm.md
new file mode 100755
index 0000000..53b2ebd
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/notification/notification.confirm.md
@@ -0,0 +1,134 @@
+---
+license: 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.
+---
+
+notification.confirm
+====================
+
+Shows a customizable confirmation dialog box.
+
+ navigator.notification.confirm(message, confirmCallback, [title], [buttonLabels])
+
+- __message:__ Dialog message (`String`)
+- __confirmCallback:__ - Callback to invoke with index of button pressed (1, 2 or 3) or when the dialog is dismissed without a button press (0), (`Function`)
+- __title:__ Dialog title (`String`) (Optional, Default: "Confirm")
+- __buttonLabels:__ Comma separated string with button labels (`String`) (Optional, Default: "OK,Cancel")
+
+Description
+-----------
+
+Function `notification.confirm` displays a native dialog box that is more customizable than the browser's `confirm` function.
+
+confirmCallback
+---------------
+
+The `confirmCallback` is called when the user has pressed one of the buttons on the confirmation dialog box.
+
+The callback takes the argument `buttonIndex` (`Number`), which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 7 ( Mango )
+- Bada 1.2 & 2.x
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // process the confirmation dialog result
+ function onConfirm(buttonIndex) {
+ alert('You selected button ' + buttonIndex);
+ }
+
+ // Show a custom confirmation dialog
+ //
+ function showConfirm() {
+ navigator.notification.confirm(
+ 'You are the winner!', // message
+ onConfirm, // callback to invoke with index of button pressed
+ 'Game Over', // title
+ 'Restart,Exit' // buttonLabels
+ );
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Notification Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // process the confirmation dialog result
+ function onConfirm(buttonIndex) {
+ alert('You selected button ' + buttonIndex);
+ }
+
+ // Show a custom confirmation dialog
+ //
+ function showConfirm() {
+ navigator.notification.confirm(
+ 'You are the winner!', // message
+ onConfirm, // callback to invoke with index of button pressed
+ 'Game Over', // title
+ 'Restart,Exit' // buttonLabels
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showConfirm(); return false;">Show Confirm</a></p>
+ </body>
+ </html>
+
+Windows Phone 7 Quirks
+----------------------
+
+- Ignores button names, always `'OK|Cancel'`.
+- There is no built-in browser function for `window.confirm`
+ - You can bind `window.confirm` by assigning `window.confirm = navigator.notification.confirm;`.
+- Calls to `alert` and `confirm` are non-blocking and result is only available asyncronously.
+
+Bada 2.x Quirks
+---------------
+
+- `confirm` uses the browser's built-in `alert` function.
+
+Bada 1.2 Quirks
+---------------
+
+- Ignore button names, always `'OK|Cancel'`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/notification/notification.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/notification/notification.md b/docs/en/2.3.0rc1/cordova/notification/notification.md
new file mode 100644
index 0000000..ccbbe76
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/notification/notification.md
@@ -0,0 +1,84 @@
+---
+license: 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.
+---
+
+Notification
+============
+
+> Visual, audible, and tactile device notifications.
+
+Methods
+-------
+
+- notification.alert
+- notification.confirm
+- notification.beep
+- notification.vibrate
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Notification" value="org.apache.cordova.Notification"/>
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.VIBRATE" />
+
+### Bada
+
+#### manifest.xml
+
+ <Privilege>
+ <Name>SYSTEM_SERVICE</Name>
+ </Privilege>
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Notification" value="org.apache.cordova.notification.Notification" />
+
+#### www/config.xml
+
+ <feature id="blackberry.ui.dialog" />
+
+### iOS
+
+#### App/Supporting Files/Cordova.plist
+
+ <key>Plugins</key>
+ <dict>
+ <key>Notification</key>
+ <string>CDVNotification</string>
+ </dict>
+
+### webOS
+
+ No permissions are required.
+
+### Windows Phone
+
+ No permissions are required.
+
+### Tizen
+
+ No permissions are required.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/notification/notification.vibrate.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/notification/notification.vibrate.md b/docs/en/2.3.0rc1/cordova/notification/notification.vibrate.md
new file mode 100644
index 0000000..7f0f940
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/notification/notification.vibrate.md
@@ -0,0 +1,103 @@
+---
+license: 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.
+---
+
+notification.vibrate
+====================
+
+Vibrates the device for the specified amount of time.
+
+ navigator.notification.vibrate(milliseconds)
+
+- __time:__ Milliseconds to vibrate the device. 1000 milliseconds equals 1 second (`Number`)
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 7
+- Bada 1.2 & 2.x
+
+Quick Example
+-------------
+
+ // Vibrate for 2.5 seconds
+ //
+ navigator.notification.vibrate(2500);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Notification Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // Show a custom alert
+ //
+ function showAlert() {
+ navigator.notification.alert(
+ 'You are the winner!', // message
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
+ }
+
+ // Beep three times
+ //
+ function playBeep() {
+ navigator.notification.beep(3);
+ }
+
+ // Vibrate for 2 seconds
+ //
+ function vibrate() {
+ navigator.notification.vibrate(2000);
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
+ <p><a href="#" onclick="playBeep(); return false;">Play Beep</a></p>
+ <p><a href="#" onclick="vibrate(); return false;">Vibrate</a></p>
+ </body>
+ </html>
+
+iPhone Quirks
+-------------
+
+- __time:__ Ignores the time and vibrates for a pre-set amount of time.
+
+ navigator.notification.vibrate();
+ navigator.notification.vibrate(2500); // 2500 is ignored
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.hide.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.hide.md b/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.hide.md
new file mode 100644
index 0000000..f826b36
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.hide.md
@@ -0,0 +1,80 @@
+---
+license: 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.
+---
+
+hide
+===============
+
+Dismiss the splash screen.
+
+ navigator.splashscreen.hide();
+
+Description
+-----------
+
+navigator.splashscreen.hide() dismisses the applications splash screen.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ navigator.splashscreen.hide();
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Splashscreen Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ navigator.splashscreen.hide();
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ </body>
+ </html>
+
+iOS Quirk
+------------
+
+1. In your Cordova.plist, you need to [modify the value](guide_project-settings_index.md.html#Project%20Settings) for **"AutoHideSplashScreen”** to false
+
+2. Then, if you want to delay hiding the splash screen for 2 seconds, you can do this in your **deviceready** event handler:
+
+ setTimeout(function() {
+ navigator.splashscreen.hide();
+ }, 2000);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.md b/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.md
new file mode 100644
index 0000000..45670fd
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.md
@@ -0,0 +1,87 @@
+---
+license: 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.
+---
+
+Splashscreen
+==========
+
+> Enables developers to show/hide the application's splash screen.
+
+
+Methods
+-------
+
+- show
+- hide
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="SplashScreen" value="org.apache.cordova.SplashScreen"/>
+
+### iOS
+
+#### Cordova.plist
+
+ Add an entry under the Plugins dictionary - with the key "SplashScreen" and value "CDVSplashScreen".
+ New projects should already have this key.
+
+
+Setup
+-----
+
+### Android
+
+1. Copy your splash screen image into the res/drawable directories of your Android project. The sizes of each image should be:
+
+ - xlarge (xhdpi): at least 960 x 720
+ - large (hdpi): at least 640 x 480
+ - medium (mdpi): at least 470 x 320
+ - small (ldpi): at least 426 x 320
+
+ It is highly recommended that you use a [9-patch image](https://developer.android.com/tools/help/draw9patch.html) for your splash screen.
+
+2. In the onCreate method of the class that extends DroidGap add the following two lines:
+
+ super.setIntegerProperty("splashscreen", R.drawable.splash);
+ super.loadUrl("file:///android_asset/www/index.html", 10000);
+
+ The first line 'super.setIntegerProperty' sets the image to be displayed as the splashscreen. If you have named your image anything other than splash.png you will have to modify this line.
+ The second line is the normal 'super.loadUrl' line but it has a second parameter which is the timeout value for the splash screen. In this example the splash screen will display for 10 seconds. If you want to dismiss the splash screen once you get the "deviceready" event you should call the navigator.splashscreen.hide() method.
+
+### iOS
+
+1. Copy your splash screen images into the **Resources/splash** directory of your iOS project. Only add the images for the devices you want to support (iPad screen size or iPhone screen size). The sizes of each image should be:
+
+ - Default-568h@2x~iphone.png (640x1136 pixels)
+ - Default-Landscape@2x~ipad.png (2048x1496 pixels)
+ - Default-Landscape~ipad.png (1024x768 pixels)
+ - Default-Portrait@2x~ipad.png (1536x2008 pixels)
+ - Default-Portrait~ipad.png (768x1024 pixels)
+ - Default@2x~iphone.png (640x960 pixels)
+ - Default~iphone.png (320x240 pixels)
+
+
+
+
+
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.show.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.show.md b/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.show.md
new file mode 100644
index 0000000..135f192
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/splashscreen/splashscreen.show.md
@@ -0,0 +1,69 @@
+---
+license: 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.
+---
+
+show
+===============
+
+Displays the splash screen.
+
+ navigator.splashscreen.show();
+
+Description
+-----------
+
+navigator.splashscreen.show() displays the applications splash screen.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ navigator.splashscreen.show();
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Splashscreen Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ navigator.splashscreen.show();
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/database/database.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/database/database.md b/docs/en/2.3.0rc1/cordova/storage/database/database.md
new file mode 100644
index 0000000..3a31929
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/database/database.md
@@ -0,0 +1,121 @@
+---
+license: 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.
+---
+
+Database
+=======
+
+Contains methods that allow the user to manipulate the Database
+
+Methods
+-------
+
+- __transaction__: Runs a database transaction.
+- __changeVersion__: method allows scripts to atomically verify the version number and change it at the same time as doing a schema update.
+
+Details
+-------
+
+A Database object is returned from a call to `window.openDatabase()`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iPhone
+- webOS
+- Tizen
+
+Transaction Quick Example
+------------------
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ function errorCB(err) {
+ alert("Error processing SQL: "+err.code);
+ }
+
+ function successCB() {
+ alert("success!");
+ }
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+
+Change Version Quick Example
+-------------------
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.changeVersion("1.0", "1.1");
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(tx, err) {
+ alert("Error processing SQL: "+err);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ alert("success!");
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Database</p>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/localstorage/localstorage.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/localstorage/localstorage.md b/docs/en/2.3.0rc1/cordova/storage/localstorage/localstorage.md
new file mode 100644
index 0000000..1fd2e46
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/localstorage/localstorage.md
@@ -0,0 +1,121 @@
+---
+license: 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.
+---
+
+localStorage
+===============
+
+Provides access to a W3C Storage interface (http://dev.w3.org/html5/webstorage/#the-localstorage-attribute)
+
+ var storage = window.localStorage;
+
+Methods
+-------
+
+- __key__: Returns the name of the key at the position specified.
+- __getItem__: Returns the item identified by it's key.
+- __setItem__: Saves and item at the key provided.
+- __removeItem__: Removes the item identified by it's key.
+- __clear__: Removes all of the key value pairs.
+
+Details
+-----------
+
+localStorage provides an interface to a W3C Storage interface. It allows one to save data as key-value pairs.
+
+Note: window.sessionStorage provides the same interface, but is cleared between app launches.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iPhone
+- Windows Phone 7
+- webOS
+- Tizen
+
+Key Quick Example
+-------------
+
+ var keyName = window.localStorage.key(0);
+
+Set Item Quick Example
+-------------
+
+ window.localStorage.setItem("key", "value");
+
+Get Item Quick Example
+-------------
+
+ var value = window.localStorage.getItem("key");
+ // value is now equal to "value"
+
+Remove Item Quick Example
+-------------
+
+ window.localStorage.removeItem("key");
+
+Clear Quick Example
+-------------
+
+ window.localStorage.clear();
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ window.localStorage.setItem("key", "value");
+ var keyname = window.localStorage.key(i);
+ // keyname is now equal to "key"
+ var value = window.localStorage.getItem("key");
+ // value is now equal to "value"
+ window.localStorage.removeItem("key");
+ window.localStorage.setItem("key2", "value2");
+ window.localStorage.clear();
+ // localStorage is now empty
+ }
+
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>localStorage</p>
+ </body>
+ </html>
+
+
+Windows Phone 7 Quirks
+-------------
+
+- dot notation is NOT available on Windows Phone. Be sure to use : window.localStorage.setItem/getItem, and not the w3 spec defined calls to window.localStorage.someKey = 'someValue';
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/parameters/display_name.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/parameters/display_name.md b/docs/en/2.3.0rc1/cordova/storage/parameters/display_name.md
new file mode 100644
index 0000000..69af089
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/parameters/display_name.md
@@ -0,0 +1,23 @@
+---
+license: 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.
+---
+
+database_displayname
+==================
+
+The display name of the database.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/parameters/name.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/parameters/name.md b/docs/en/2.3.0rc1/cordova/storage/parameters/name.md
new file mode 100644
index 0000000..c39dcbf
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/parameters/name.md
@@ -0,0 +1,23 @@
+---
+license: 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.
+---
+
+database_name
+============
+
+The name of the database.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/parameters/size.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/parameters/size.md b/docs/en/2.3.0rc1/cordova/storage/parameters/size.md
new file mode 100644
index 0000000..9b46993
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/parameters/size.md
@@ -0,0 +1,23 @@
+---
+license: 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.
+---
+
+database_size
+==============
+
+The size of the database in bytes.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/parameters/version.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/parameters/version.md b/docs/en/2.3.0rc1/cordova/storage/parameters/version.md
new file mode 100644
index 0000000..2e72923
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/parameters/version.md
@@ -0,0 +1,23 @@
+---
+license: 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.
+---
+
+database_version
+=============
+
+The version of the database.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/sqlerror/sqlerror.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/sqlerror/sqlerror.md b/docs/en/2.3.0rc1/cordova/storage/sqlerror/sqlerror.md
new file mode 100644
index 0000000..b700222
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/sqlerror/sqlerror.md
@@ -0,0 +1,47 @@
+---
+license: 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.
+---
+
+SQLError
+========
+
+A `SQLError` object is thrown when an error occurs.
+
+Properties
+----------
+
+- __code:__ One of the predefined error codes listed below.
+- __message:__ A description of the error.
+
+Constants
+---------
+
+- `SQLError.UNKNOWN_ERR`
+- `SQLError.DATABASE_ERR`
+- `SQLError.VERSION_ERR`
+- `SQLError.TOO_LARGE_ERR`
+- `SQLError.QUOTA_ERR`
+- `SQLError.SYNTAX_ERR`
+- `SQLError.CONSTRAINT_ERR`
+- `SQLError.TIMEOUT_ERR`
+
+Description
+-----------
+
+The `SQLError` object is thrown when an error occurs when manipulating a database.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/2.3.0rc1/cordova/storage/sqlresultset/sqlresultset.md
new file mode 100644
index 0000000..e24a8d4
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/sqlresultset/sqlresultset.md
@@ -0,0 +1,140 @@
+---
+license: 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.
+---
+
+SQLResultSet
+=======
+
+When the executeSql method of a SQLTransaction is called it will invoke it's callback with a SQLResultSet.
+
+Properties
+-------
+
+- __insertId__: the row ID of the row that the SQLResultSet object's SQL statement inserted into the database
+- __rowsAffected__: the number of rows that were changed by the SQL statement. If the statement did not affect any rows then it is set to 0.
+- __rows__: a SQLResultSetRowList representing the rows returned. If no rows are returned the object will be empty.
+
+Details
+-------
+
+When you call the SQLTransaction executeSql method its callback methods will be called with a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowsAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iPhone
+- webOS
+- Tizen
+
+Execute SQL Quick Example
+------------------
+
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ function querySuccess(tx, results) {
+ console.log("Returned rows = " + results.rows.length);
+ // this will be true since it was a select statement and so rowsAffected was 0
+ if (!resultSet.rowsAffected) {
+ console.log('No rows affected!');
+ return false;
+ }
+ // for an insert statement, this property will return the ID of the last inserted row
+ console.log("Last inserted row ID = " + results.insertId);
+ }
+
+ function errorCB(err) {
+ alert("Error processing SQL: "+err.code);
+ }
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Query the database
+ //
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ // Query the success callback
+ //
+ function querySuccess(tx, results) {
+ console.log("Returned rows = " + results.rows.length);
+ // this will be true since it was a select statement and so rowsAffected was 0
+ if (!results.rowsAffected) {
+ console.log('No rows affected!');
+ return false;
+ }
+ // for an insert statement, this property will return the ID of the last inserted row
+ console.log("Last inserted row ID = " + results.insertId);
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(err) {
+ console.log("Error processing SQL: "+err.code);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
+ }
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Database</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md b/docs/en/2.3.0rc1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md
new file mode 100644
index 0000000..1286f20
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md
@@ -0,0 +1,137 @@
+---
+license: 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.
+---
+
+SQLResultSetList
+=======
+
+One of the properties of the SQLResultSet containing the rows returned from a SQL query.
+
+Properties
+-------
+
+- __length__: the number of rows returned by the SQL query
+
+Methods
+-------
+
+- __item__: returns the row at the specified index represented by a JavaScript object.
+
+Details
+-------
+
+The SQLResultSetList contains the data returned from a SQL select statement. The object contains a length property letting you know how many rows the select statement has been returned. To get a row of data you would call the `item` method specifing an index. The item method returns a JavaScript Object who's properties are the columns of the database the select statement was executed against.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iPhone
+- webOS
+- Tizen
+
+Execute SQL Quick Example
+------------------
+
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ function querySuccess(tx, results) {
+ var len = results.rows.length;
+ console.log("DEMO table: " + len + " rows found.");
+ for (var i=0; i<len; i++){
+ console.log("Row = " + i + " ID = " + results.rows.item(i).id + " Data = " + results.rows.item(i).data);
+ }
+ }
+
+ function errorCB(err) {
+ alert("Error processing SQL: "+err.code);
+ }
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Query the database
+ //
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ // Query the success callback
+ //
+ function querySuccess(tx, results) {
+ var len = results.rows.length;
+ console.log("DEMO table: " + len + " rows found.");
+ for (var i=0; i<len; i++){
+ console.log("Row = " + i + " ID = " + results.rows.item(i).id + " Data = " + results.rows.item(i).data);
+ }
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(err) {
+ console.log("Error processing SQL: "+err.code);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
+ }
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Database</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/2.3.0rc1/cordova/storage/sqltransaction/sqltransaction.md
new file mode 100644
index 0000000..d50bf1a
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/sqltransaction/sqltransaction.md
@@ -0,0 +1,114 @@
+---
+license: 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.
+---
+
+SQLTransaction
+=======
+
+Contains methods that allow the user to execute SQL statements against the Database.
+
+Methods
+-------
+
+- __executeSql__: executes a SQL statement
+
+Details
+-------
+
+When you call a Database objects transaction method it's callback methods will be called with a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iPhone
+- webOS
+- Tizen
+
+Execute SQL Quick Example
+------------------
+
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ function errorCB(err) {
+ alert("Error processing SQL: "+err);
+ }
+
+ function successCB() {
+ alert("success!");
+ }
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(err) {
+ alert("Error processing SQL: "+err);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ alert("success!");
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>SQLTransaction</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/storage.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/storage.md b/docs/en/2.3.0rc1/cordova/storage/storage.md
new file mode 100644
index 0000000..8a82e75
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/storage.md
@@ -0,0 +1,83 @@
+---
+license: 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.
+---
+
+Storage
+==========
+
+> Provides access to the devices storage options.
+
+This API is based on the [W3C Web SQL Database Specification](http://dev.w3.org/html5/webdatabase/) and [W3C Web Storage API Specification](http://dev.w3.org/html5/webstorage/). Some devices already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with Cordova's implementation. For devices that don't have storage support, Cordova's implementation should be compatible with the W3C specification.
+
+Methods
+-------
+
+- openDatabase
+
+Arguments
+---------
+
+- database_name
+- database_version
+- database_displayname
+- database_size
+
+Objects
+-------
+
+- Database
+- SQLTransaction
+- SQLResultSet
+- SQLResultSetList
+- SQLError
+- localStorage
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Storage" value="org.apache.cordova.Storage" />
+
+### Bada
+
+ No permissions are required.
+
+### BlackBerry WebWorks
+
+#### www/config.xml
+
+ <feature id="blackberry.widgetcache" required="true" version="1.0.0.0" />
+
+### iOS
+
+ No permissions are required.
+
+### webOS
+
+ No permissions are required.
+
+### Windows Phone
+
+ No permissions are required.
+
+### Tizen
+
+ No permissions are required.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/cordova/storage/storage.opendatabase.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/cordova/storage/storage.opendatabase.md b/docs/en/2.3.0rc1/cordova/storage/storage.opendatabase.md
new file mode 100644
index 0000000..926051f
--- /dev/null
+++ b/docs/en/2.3.0rc1/cordova/storage/storage.opendatabase.md
@@ -0,0 +1,75 @@
+---
+license: 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.
+---
+
+openDatabase
+===============
+
+Returns a new Database object.
+
+ var dbShell = window.openDatabase(database_name, database_version, database_displayname, database_size);
+
+Description
+-----------
+
+window.openDatabase returns a new Database object.
+
+This method will create a new SQL Lite Database and return a Database object. Use the Database Object to manipulate the data.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iPhone
+- webOS
+- Tizen
+
+Quick Example
+-------------
+
+ var db = window.openDatabase("test", "1.0", "Test DB", 1000000);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var db = window.openDatabase("test", "1.0", "Test DB", 1000000);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Open Database</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/guide/command-line/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/guide/command-line/index.md b/docs/en/2.3.0rc1/guide/command-line/index.md
new file mode 100644
index 0000000..fd745a9
--- /dev/null
+++ b/docs/en/2.3.0rc1/guide/command-line/index.md
@@ -0,0 +1,192 @@
+---
+license: 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.
+---
+
+# Command-Line Usage
+
+Cordova now ships with a set of command-line tools that make it easier
+for you to develop cross-platform applications. You can build, clean,
+and launch an emulator with a single command. You can consider these
+instructions as an alternative to the Getting Started guides. Whereas
+the Getting Started guides help you get setup with the default IDEs and
+tooling surrounding the platforms you are working with, the command-line
+tools aim to provide a shell-based approach to creating and working with
+Cordova projects.
+
+## Supported Platforms
+
+* [iOS](#Command-Line%20Usage_ios)
+* [Android](#Command-Line%20Usage_android)
+* [BlackBerry](#Command-Line%20Usage_blackberry)
+
+## iOS
+
+The iOS command-line tools are built upon shell scripts and rely on
+Xcode command-line tools such as `xcode-select` and `xcodebuild`.
+
+### Create a project
+
+Run the `create` command with the following parameters:
+
+* Path to your new Cordova iOS project
+* Package name, following reverse-domain style convention
+* Project name
+
+<!-- -->
+
+ $ ./path/to/cordova-ios/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
+
+### Build a project
+
+ $ /path/to/my_new_cordova_project/cordova/build
+
+### Run app on emulator
+
+ $ /path/to/my_new_cordova_project/cordova/run
+
+### Releasing
+
+ $ /path/to/my_new_cordova_project/cordova/release
+
+### Logging
+
+ $ /path/to/my_new_cordova_project/cordova/log
+
+
+## Android
+
+The Android command-line tools are built upon shell scripts. You _must_
+have the Android SDK's `tools` and `platform-tools` folders in your
+PATH!
+
+### Create a project
+
+Run the `create` command with the following parameters:
+
+* Path to your new Cordova Android project
+* Package name, following reverse-domain style convention
+* Main Activity name
+
+<!-- -->
+
+ $ /path/to/cordova-android/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
+
+or, on **Windows**
+
+ $ /path/to/cordova-android/bin/create.bat /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
+
+### Build a project
+
+ $ /path/to/my_new_cordova_project/cordova/build
+
+or, on **Windows**
+
+ $ /path/to/my_new_cordova_project/cordova/build.bat
+
+### Run app on emulator/device
+
+ $ /path/to/my_new_cordova_project/cordova/run
+
+or, on **Windows**
+
+ $ /path/to/my_new_cordova_project/cordova/run.bat
+
+Make sure you have created at least one Android Virtual Device. If you did not it will ask you to create one with the `android` command.
+If you have multiple AVDs, it will prompt you to select an AVD.
+
+### Logging
+
+ $ /path/to/my_new_cordova_project/cordova/log
+
+or, on **Windows**
+
+ $ /path/to/my_new_cordova_project/cordova/log.bat
+
+### Cleaning
+
+ $ /path/to/my_new_cordova_project/cordova/clean
+
+or, on **Windows**
+
+ $ /path/to/my_new_cordova_project/cordova/clean.bat
+
+### Releasing
+
+ $ /path/to/my_new_cordova_project/cordova/release
+
+or, on **Windows**
+
+ $ /path/to/my_new_cordova_project/cordova/release.bat
+
+
+## BlackBerry
+
+The BlackBerry command-line tools are built upon shell scripts.
+
+### Create a project
+
+Run the `create` command with the following parameters:
+
+* Path to your new Cordova BlackBerry project
+* Application name
+
+<!-- -->
+
+ $ /path/to/cordova-blackberry-webworks/bin/create /path/to/my_new_cordova_project CordovaProjectName
+
+or, on **Windows**
+
+ $ /path/to/cordova-blackberry-webworks/bin/create.bat /path/to/my_new_cordova_project CordovaProjectName
+
+### Build a project
+
+For BlackBerry projects, please make sure you customize the
+`project.properties` file in the root of your Cordova project folder.
+This is necessary for things like supplying your BlackBerry signing key
+password, location of the BlackBerry WebWorks SDK, and location of
+BlackBerry simulator executables.
+
+ $ /path/to/my_new_cordova_project/cordova/debug
+
+or, on **Windows**
+
+ $ /path/to/my_new_cordova_project/cordova/debug.bat
+
+### Launch emulator
+
+For BlackBerry projects, please make sure you customize the
+`project.properties` file in the root of your Cordova project folder.
+This is necessary for things like supplying your BlackBerry signing key
+password, location of the BlackBerry WebWorks SDK, and location of
+BlackBerry simulator executables.
+
+ $ /path/to/my_new_cordova_project/cordova/emulate
+
+or, on **Windows**
+
+ $ /path/to/my_new_cordova_project/cordova/emulate.bat
+
+### Logging
+
+Unfortunately streaming logs directly from the device is not
+supported at this time. However, BlackBerry offers built-in Web
+Inspector support for Playbook and BlackBerry smartphone devices running
+BlackBerry OS 7.0 and above. Additionally, you can access your
+application's logs (including any calls to `console.log`) on your device
+by holding down the ALT key from the home screen and hitting "lglg"
+keys.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/guide/cordova-webview/android.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/guide/cordova-webview/android.md b/docs/en/2.3.0rc1/guide/cordova-webview/android.md
new file mode 100644
index 0000000..747a130
--- /dev/null
+++ b/docs/en/2.3.0rc1/guide/cordova-webview/android.md
@@ -0,0 +1,119 @@
+---
+license: 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.
+---
+
+Embedding Cordova WebView on Android
+====================================
+
+Beginning in Cordova 1.9, with the assistance of the `CordovaActivity`, you can use Cordova as a component in a larger native Android application. This component is known in Android
+as the `CordovaWebView`. New Cordova-based applications from 1.9 onwards will be using the `CordovaWebView` as its main view, whether the legacy `DroidGap` approach is
+used or not.
+
+The prerequisites are the same as the prerequisites for Android application development. It is assumed that you are familiar with Android development. If not, please
+look at the Getting Started guide to developing a Cordova Application and start there before continuing with this approach. This is not the main approach used
+to author Android Cordova applications. Thus the instructions are currently manual. In the future, we may try to further automate project generation via this method.
+
+Prerequisites
+-------------
+
+1. **Cordova 1.9** or greater
+2. Android SDK updated with 15
+
+Guide to using CordovaWebView in an Android Project
+---------------------------------------------------
+
+1. Use `bin/create` to fetch the commons-codec-1.6.jar
+2. `cd` into `/framework` and run `ant jar` to build the cordova jar (it
+ will create the .jar file in the form `cordova-x.x.x.jar` in the
+ `/framework` folder)
+3. Copy the cordova jar into your Android project's `/libs` directory
+4. Edit your application's `main.xml` file (under `/res/xml`) to look similar the following. The `layout_height`, `layout_width` and `id` can be modified to suit your application
+
+ <org.apache.cordova.CordovaWebView
+ android:id="@+id/tutorialView"
+ android:layout_width="match_parent"
+ android:layout_height="match_parent" />
+
+5. Modify your activity so that it implements the `CordovaInterface`. It is recommended that you implement the methods that are included. You may wish to copy the methods from `/framework/src/org/apache/cordova/DroidGap.java`, or you may wish to implement your own methods. Below is a fragment of code from a basic application that uses the interface (note how the view id referenced matches the `id` attribute specified in the above XML fragment from step 4):
+
+ public class CordovaViewTestActivity extends Activity implements CordovaInterface {
+ CordovaWebView cwv;
+ /* Called when the activity is first created. */
+ @Override
+ public void onCreate(Bundle savedInstanceState) {
+ super.onCreate(savedInstanceState);
+ setContentView(R.layout.main);
+ cwv = (CordovaWebView) findViewById(R.id.tutorialView);
+ cwv.loadUrl("file:///android_asset/www/index.html");
+ }
+
+In addition to this, if you are using camera, you will want to implement this as well:
+
+ @Override
+ public void setActivityResultCallback(CordovaPlugin plugin) {
+ this.activityResultCallback = plugin;
+ }
+ /**
+ * Launch an activity for which you would like a result when it finished. When this activity exits,
+ * your onActivityResult() method will be called.
+ *
+ * @param command The command object
+ * @param intent The intent to start
+ * @param requestCode The request code that is passed to callback to identify the activity
+ */
+ public void startActivityForResult(CordovaPlugin command, Intent intent, int requestCode) {
+ this.activityResultCallback = command;
+ this.activityResultKeepRunning = this.keepRunning;
+
+ // If multitasking turned on, then disable it for activities that return results
+ if (command != null) {
+ this.keepRunning = false;
+ }
+
+ // Start activity
+ super.startActivityForResult(intent, requestCode);
+ }
+
+ @Override
+ /**
+ * Called when an activity you launched exits, giving you the requestCode you started it with,
+ * the resultCode it returned, and any additional data from it.
+ *
+ * @param requestCode The request code originally supplied to startActivityForResult(),
+ * allowing you to identify who this result came from.
+ * @param resultCode The integer result code returned by the child activity through its setResult().
+ * @param data An Intent, which can return result data to the caller (various data can be attached to Intent "extras").
+ */
+ protected void onActivityResult(int requestCode, int resultCode, Intent intent) {
+ super.onActivityResult(requestCode, resultCode, intent);
+ CordovaPlugin callback = this.activityResultCallback;
+ if (callback != null) {
+ callback.onActivityResult(requestCode, resultCode, intent);
+ }
+ }
+
+Finally, remember to add the thread pool, otherwise the plugins will have no threads to run on.
+
+
+ @Override
+ public ExecutorService getThreadPool() {
+ return threadPool;
+ }
+
+6. Copy your application's HTML and JavaScript used to the `/assets/www` directory of your Android project
+7. Copy `cordova.xml` and `plugins.xml` from `/framework/res/xml` to the `/res/xml` folder in your project
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/guide/cordova-webview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/guide/cordova-webview/index.md b/docs/en/2.3.0rc1/guide/cordova-webview/index.md
new file mode 100644
index 0000000..d3e2e72
--- /dev/null
+++ b/docs/en/2.3.0rc1/guide/cordova-webview/index.md
@@ -0,0 +1,27 @@
+---
+license: 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.
+---
+
+Embedding WebView
+=================
+
+> Implement the Cordova WebView in your own project.
+
+- Embedding Cordova WebView on Android
+- Embedding Cordova WebView on iOS
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/guide/cordova-webview/ios.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/guide/cordova-webview/ios.md b/docs/en/2.3.0rc1/guide/cordova-webview/ios.md
new file mode 100644
index 0000000..8272b51
--- /dev/null
+++ b/docs/en/2.3.0rc1/guide/cordova-webview/ios.md
@@ -0,0 +1,131 @@
+---
+license: 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.
+---
+
+Embedding Cordova WebView on iOS
+================================
+
+Beginning with Cordova 1.4, you can use Cordova as a component in your iOS applications. This component is code-named "Cleaver".
+
+New Cordova-based applications created using the Xcode template provided in Cordova 1.4 or greater use Cleaver, and this template is considered the reference implementation for Cleaver.
+
+Beginning with Cordova 2.0.0 and greater, we only support the sub-project based Cleaver implementation from now on.
+
+Prerequisites
+-------------
+
+1. **Cordova 2.1.0** or greater
+2. **Xcode 4.5** or greater
+3. `Cordova.plist` file (from a [newly created](guide_command-line_index.md.html#Command-Line%20Usage_ios) Cordova project)
+
+
+Adding Cleaver to your Xcode project (CordovaLib sub-project)
+-------------------------------------------------------------
+
+1. **Download and extract the Cordova source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+4. **Copy** the `Cordova.plist` file into your project folder on disk (see **Prerequisites** above)
+5. **Drag and drop** the `Cordova.plist` file into the Project Navigator of Xcode
+6. **Choose** the radio-button **"Create groups for any added folders"**, select the **Finish** button
+7. **Drag and drop** the `CordovaLib.xcodeproj` file into the Project Navigator of Xcode (from the permanent folder location above, and it should be in the CordovaLib sub-folder)
+8. Select `CordovaLib.xcodeproj` in the Project Navigator
+9. Press the key combination **Option-Command-1** to show the **File Inspector**
+10. Choose **"Relative to Group"** in the **File Inspector** for the drop-down menu for **Location**
+11. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
+12. Add `-all_load` and `-Obj-C` - for the **"Other Linker Flags"** value
+13. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Phases"** tab
+14. Expand **"Link Binaries with Libraries"**
+15. Select the **"+" button**, and add these **frameworks** (and optionally in the Project Navigator, **move** them under the Frameworks group):
+
+ AddressBook.framework
+ AddressBookUI.framework
+ AudioToolbox.framework
+ AVFoundation.framework
+ CoreLocation.framework
+ MediaPlayer.framework
+ QuartzCore.framework
+ SystemConfiguration.framework
+ MobileCoreServices.framework
+ CoreMedia.framework
+
+16. Expand **"Target Dependencies"** - the top box labeled like this if you have multiple boxes!
+17. Select the **"+" button**, and add the `CordovaLib` build product
+18. Expand **"Link Binaries with Libraries"** - the top box labeled like
+ this if you have multiple boxes!
+19. Select the **"+" button**, and add `libCordova.a`
+20. Set the Xcode preference **"Xcode Preferences -> Locations -> Derived Data -> Advanced…"** to **"Unique"**
+21. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
+22. Search for **"Header Search Paths"**. For that setting, add these three values below (with quotes):
+
+ "$(TARGET_BUILD_DIR)/usr/local/lib/include"
+
+ "$(OBJROOT)/UninstalledProducts/include"
+
+ "$(BUILT_PRODUCTS_DIR)"
+
+ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit -> Refactor -> Convert to Objective-C ARC…**, **de-select libCordova.a**, then run the wizard to completion.
+
+Using CDVViewController in your code
+------------------------------------
+
+1. Add this **header**:
+
+ #import <Cordova/CDVViewController.h>
+
+2. Instantiate a **new** `CDVViewController`, and retain it somewhere:
+
+ CDVViewController* viewController = [CDVViewController new];
+
+3. (_OPTIONAL_) Set the `wwwFolderName` property (defaults to `"www"`):
+
+ viewController.wwwFolderName = @"myfolder";
+
+4. (_OPTIONAL_) Set the `startPage` property (defaults to `"index.html"`):
+
+ viewController.startPage = @"mystartpage.html";
+
+5. (_OPTIONAL_) Set the `useSplashScreen` property (defaults to `NO`):
+
+ viewController.useSplashScreen = YES;
+
+6. Set the **view frame** (always set this as the last property):
+
+ viewController.view.frame = CGRectMake(0, 0, 320, 480);
+
+7. **Add** Cleaver to your view:
+
+ [myView addSubview:viewController.view];
+
+Adding your HTML, CSS and JavaScript assets
+-------------------------------------------
+
+1. Create a **new folder** in your project **on disk**, for example, name it `www`
+2. Put your **HTML, CSS and JavaScript assets** into this folder
+3. **Drag and drop** the folder into the Project Navigator of Xcode
+4. **Choose** the radio-button **"Create folder references for any added folders"**
+5. **Set the appropriate `wwwFolderName` and `startPage` properties** for the folder you created in **(1)** or use the defaults (see previous section) when you instantiate the `CDVViewController`.
+
+ /*
+ if you created a folder called 'myfolder' and
+ you want the file 'mypage.html' in it to be
+ the startPage
+ */
+ viewController.wwwFolderName = @"myfolder";
+ viewController.startPage = @"mypage.html"
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/82efba85/docs/en/2.3.0rc1/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0rc1/guide/getting-started/android/index.md b/docs/en/2.3.0rc1/guide/getting-started/android/index.md
new file mode 100644
index 0000000..76e708f
--- /dev/null
+++ b/docs/en/2.3.0rc1/guide/getting-started/android/index.md
@@ -0,0 +1,130 @@
+---
+license: 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.
+---
+
+Getting Started with Android
+============================
+
+This guide describes how to set up your development environment for Cordova and run a sample application.
+
+1. Minimum Requirements for Development
+---------------
+- Identical to [Android Minimum Requirements](http://developer.android.com/sdk/index.html)
+
+1.1 Supported Android Devices
+-------------------------------
+- Android 2.1 (Deprecated May 2013)
+- Android 2.2
+- Android 2.3
+- Android 3.x (Deprecated May 2013)
+- Android 4.x
+
+We currently do not support Android 1.x, and we plan to deprecate platforms in the future as they are updated and dip below 5% on the [distribution dashboard](http://developer.android.com/about/dashboards/index.html) provided by Google.
+
+2. Install SDK + Cordova
+------------------------
+
+- Download and install [Eclipse Classic](http://www.eclipse.org/downloads/)
+- Download and install [Android SDK](http://developer.android.com/sdk/index.html)
+- Download and install [ADT Plugin](http://developer.android.com/sdk/eclipse-adt.html#installing)
+- Download the latest copy of [Cordova](http://incubator.apache.org/cordova/#download) and extract its contents. We will be working with the Android directory.
+
+
+3A. Setup your PATH environment variable on Mac OS
+---------------------------------------
+
+- Open the Terminal program (this is in your Applications/Utilites folder by default).
+- Run the following command
+
+`touch ~/.bash_profile; open ~/.bash_profile`
+
+- This will open the file in the your default text editor.
+- You need to add the path to your Android SDK platform-tools and tools directory. In my example I will use "/Development/android-sdk-macosx" as the directory the SDK is installed in. Add the following line:
+
+`export PATH=${PATH}:/Development/android-sdk-macosx/platform-tools:/Development/android-sdk-macosx/tools`
+
+- Save the file and quit the text editor.
+- Execute your .bash_profile to update your PATH.
+
+`source ~/.bash_profile`
+
+- Now everytime you open the Terminal program you PATH will included the Android SDK.
+
+3B. Setup your PATH environment variable on Windows
+---------------------------------------
+
+- From the Desktop, right-click My Computer and click Properties.
+- Click Advanced System Settings link in the left column.
+- In the System Properties window click the Environment Variables button.
+- Select the PATH variable from the System variables section.
+- Select the Edit button.
+- You need to add the path to your Android SDK platform-tools and tools directory. In my example I will use "C:\Development\android-sdk-windows" as the directory the SDK is installed in. Append the following text into the text box:
+
+`;C:\Development\android-sdk-windows\platform-tools;C:\Development\android-sdk-windows\tools`
+
+- Save your edit. Close the Environment Variables dialog.
+- Additionally, you may need to include `%JAVA_HOME%\bin` to your PATH as well. To check to see if this is required, run a command prompt and type `java`. If the program can not be found add `%JAVA_HOME%\bin` to the PATH. You may need to specify the full path instead of using the `%JAVA_HOME%` environment variable.
+- Finally, you may need to include `%ANT_HOME%\bin` to your PATH as well. To check to see if this is required, run a command prompt and type `ant`. If the program can not be found add `%ANT_HOME%\bin` to the PATH. You may need to specify the full path instead of using the `%ANT_HOME%` environment variable.
+
+
+4. Setup New Project
+--------------------
+
+- In a terminal window, navigate to the `bin` directory within the `android` subfolder of the Cordova distribution.
+- Type in `./create <project_folder_path> <package_name> <project_name>` then press **"Enter"**
+
+ <project_folder_path> is the path to your new Cordova Android project
+ <package_name> is the package name, e.g. com.YourCompany.YourAppName
+ <project_name> is the project name, e.g. YourApp (Must not contain spaces)
+
+- Launch Eclipse, and select menu item **New Project**
+ 
+- Select the directory you used for `<project_folder_path>`
+- Click Finish.
+
+If your project has a red X indicating there is a problem follow these additional steps:
+
+- Right click on the project folder.
+- In the Properties dialog that is displayed select Android from the navigation pane.
+- For the project build target select the highest Android API level you have installed.
+- Click OK
+- Then from the Project menu bar item select Clean.
+- This should correct all the errors in the project.
+
+5A. Deploy to Emulator
+----------------------
+
+- Right click the project and go to **Run As > Android Application**
+- Eclipse will ask you to select an appropriate AVD. If there isn't one, then you'll need to create it.
+
+**Note: For a faster experience, use an Intel-based emulator image:**
+
+- Open the Android SDK Manager
+ 
+- Install one or more `Intel x86 Atom` System Images as well as the `Intel Hardware Accelerated Execution Manager` (under Extras).
+- Run the Intel installer, which has been downloaded to: `extras/intel/Hardware_Accelerated_Execution_Manager` within your Android SDK
+- Create a new AVD with the Target set to an Intel image.
+- When starting the emulator, ensure there are no error messages about the HAX module failing to load.
+
+
+5B. Deploy to Device
+--------------------
+
+- Make sure USB debugging is enabled on your device and plug it into your system. (**Settings > Applications > Development**)
+- Right click the project and go to **Run As > Android Application**
+