incubator-callback-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwbro...@apache.org
Subject [9/64] Add generated HTML documentation.
Date Thu, 12 Jul 2012 22:09:52 GMT
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/62a5f4d2/www/cordova_storage_storage.md.html
----------------------------------------------------------------------
diff --git a/www/cordova_storage_storage.md.html b/www/cordova_storage_storage.md.html
new file mode 100644
index 0000000..5c58c79
--- /dev/null
+++ b/www/cordova_storage_storage.md.html
@@ -0,0 +1,944 @@
+<!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="English" value="en"><option selected value="edge">edge</option></optgroup></select></small>
+        </div>
+        <div id="subheader">
+            <h1>Storage</h1>
+            <small><select><option value="Storage">Storage</option>
+<option value="Storage_methods">      - Methods</option>
+<option value="Storage_arguments">      - Arguments</option>
+<option value="Storage_objects">      - Objects</option>
+<option value="Storage_permissions">      - Permissions</option>
+<option value="openDatabase">openDatabase</option>
+<option value="openDatabase_description">      - Description</option>
+<option value="openDatabase_supported_platforms">      - Supported Platforms</option>
+<option value="openDatabase_quick_example">      - Quick Example</option>
+<option value="openDatabase_full_example">      - Full Example</option>
+<option value="database_name">database_name</option>
+<option value="database_version">database_version</option>
+<option value="database_displayname">database_displayname</option>
+<option value="database_size">database_size</option>
+<option value="Database">Database</option>
+<option value="Database_methods">      - Methods</option>
+<option value="Database_details">      - Details</option>
+<option value="Database_supported_platforms">      - Supported Platforms</option>
+<option value="Database_transaction_quick_example">      - Transaction Quick Example</option>
+<option value="Database_change_version_quick_example">      - Change Version Quick Example</option>
+<option value="Database_full_example">      - Full Example</option>
+<option value="Database_android_1_x_quirks">      - Android 1.X Quirks</option>
+<option value="SQLTransaction">SQLTransaction</option>
+<option value="SQLTransaction_methods">      - Methods</option>
+<option value="SQLTransaction_details">      - Details</option>
+<option value="SQLTransaction_supported_platforms">      - Supported Platforms</option>
+<option value="SQLTransaction_execute_sql_quick_example">      - Execute SQL Quick Example</option>
+<option value="SQLTransaction_full_example">      - Full Example</option>
+<option value="SQLResultSet">SQLResultSet</option>
+<option value="SQLResultSet_properties">      - Properties</option>
+<option value="SQLResultSet_details">      - Details</option>
+<option value="SQLResultSet_supported_platforms">      - Supported Platforms</option>
+<option value="SQLResultSet_execute_sql_quick_example">      - Execute SQL Quick Example</option>
+<option value="SQLResultSet_full_example">      - Full Example</option>
+<option value="SQLResultSetList">SQLResultSetList</option>
+<option value="SQLResultSetList_properties">      - Properties</option>
+<option value="SQLResultSetList_methods">      - Methods</option>
+<option value="SQLResultSetList_details">      - Details</option>
+<option value="SQLResultSetList_supported_platforms">      - Supported Platforms</option>
+<option value="SQLResultSetList_execute_sql_quick_example">      - Execute SQL Quick Example</option>
+<option value="SQLResultSetList_full_example">      - Full Example</option>
+<option value="SQLError">SQLError</option>
+<option value="SQLError_properties">      - Properties</option>
+<option value="SQLError_constants">      - Constants</option>
+<option value="SQLError_description">      - Description</option>
+<option value="localStorage">localStorage</option>
+<option value="localStorage_methods">      - Methods</option>
+<option value="localStorage_details">      - Details</option>
+<option value="localStorage_supported_platforms">      - Supported Platforms</option>
+<option value="localStorage_key_quick_example">      - Key Quick Example</option>
+<option value="localStorage_set_item_quick_example">      - Set Item Quick Example</option>
+<option value="localStorage_get_item_quick_example">      - Get Item Quick Example</option>
+<option value="localStorage_remove_item_quick_example">      - Remove Item Quick Example</option>
+<option value="localStorage_clear_quick_example">      - Clear Quick Example</option>
+<option value="localStorage_full_example">      - Full Example</option>
+<option value="localStorage_windows_phone_7_quirks">      - Windows Phone 7 Quirks</option></select></small>
+        </div>
+
+        <div id="sidebar">
+            <div class="vertical_divider"></div>
+        <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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+        <div id="scrollable">
+            <div id="content">
+                <h1><a name="Storage">Storage</a></h1>
+
+<blockquote>
+  <p>Provides access to the devices storage options.</p>
+</blockquote>
+
+<p>This API is based on the <a class="external" href="http://dev.w3.org/html5/webdatabase/">W3C Web SQL </a><a href="cordova_storage_storage.md.html#Database">Database</a> Specification and <a class="external" href="http://dev.w3.org/html5/webstorage/">W3C Web </a><a href="cordova_storage_storage.md.html#Storage">Storage</a> API Specification. Some devices already provide an implementation of 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.</p>
+
+<h2>
+<a name="Storage_methods">Methods</a>
+</h2>
+
+<ul>
+<li><a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a></li>
+</ul>
+<h2>
+<a name="Storage_arguments">Arguments</a>
+</h2>
+
+<ul>
+<li><a href="cordova_storage_storage.md.html#database_name">database_name</a></li>
+<li><a href="cordova_storage_storage.md.html#database_version">database_version</a></li>
+<li><a href="cordova_storage_storage.md.html#database_displayname">database_displayname</a></li>
+<li><a href="cordova_storage_storage.md.html#database_size">database_size</a></li>
+</ul>
+<h2>
+<a name="Storage_objects">Objects</a>
+</h2>
+
+<ul>
+<li><a href="cordova_storage_storage.md.html#Database">Database</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLTransaction">SQLTransaction</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLResultSetList">SQLResultSetList</a></li>
+<li><a href="cordova_storage_storage.md.html#SQLError">SQLError</a></li>
+<li><a href="cordova_storage_storage.md.html#localStorage">localStorage</a></li>
+</ul>
+<h2>
+<a name="Storage_permissions">Permissions</a>
+</h2>
+
+<h3>Android</h3>
+
+<h4>app/res/xml/plugins.xml</h4>
+
+<pre class="prettyprint"><code>&lt;plugin name="<a href="cordova_storage_storage.md.html#Storage">Storage</a>" value="org.apache.cordova.<a href="cordova_storage_storage.md.html#Storage">Storage</a>" /&gt;
+</code></pre>
+
+<h3>Bada</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>BlackBerry WebWorks</h3>
+
+<h4>www/config.xml</h4>
+
+<pre class="prettyprint"><code>&lt;feature id="blackberry.widgetcache" required="true" version="1.0.0.0" /&gt;
+</code></pre>
+
+<h3>iOS</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>webOS</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<h3>Windows Phone</h3>
+
+<pre class="prettyprint"><code>No permissions are required.
+</code></pre>
+
+<hr>
+<h1><a name="openDatabase">openDatabase</a></h1>
+
+<p>Returns a new <a href="cordova_storage_storage.md.html#Database">Database</a> object.</p>
+
+<pre class="prettyprint"><code>var dbShell = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>(<a href="cordova_storage_storage.md.html#database_name">database_name</a>, <a href="cordova_storage_storage.md.html#database_version">database_version</a>, <a href="cordova_storage_storage.md.html#database_displayname">database_displayname</a>, <a href="cordova_storage_storage.md.html#database_size">database_size</a>);
+</code></pre>
+
+<h2>
+<a name="openDatabase_description">Description</a>
+</h2>
+
+<p>window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a> returns a new <a href="cordova_storage_storage.md.html#Database">Database</a> object.</p>
+
+<p>This method will create a new SQL Lite <a href="cordova_storage_storage.md.html#Database">Database</a> and return a <a href="cordova_storage_storage.md.html#Database">Database</a> object.  Use the <a href="cordova_storage_storage.md.html#Database">Database</a> Object to manipulate the data.</p>
+
+<h2>
+<a name="openDatabase_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>webOS</li>
+</ul>
+<h2>
+<a name="openDatabase_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("test", "1.0", "Test DB", 1000000);
+</code></pre>
+
+<h2>
+<a name="openDatabase_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
+&lt;html&gt;
+  &lt;head&gt;
+    &lt;title&gt;<a href="cordova_storage_storage.md.html#Storage">Storage</a> Example&lt;/title&gt;
+
+    &lt;script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"&gt;&lt;/script&gt;
+    &lt;script type="text/javascript" charset="utf-8"&gt;
+
+    // Wait for Cordova to load
+    //
+    document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+    // Cordova is ready
+    //
+    function onDeviceReady() {
+        var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("test", "1.0", "Test DB", 1000000);
+    }
+
+    &lt;/script&gt;
+  &lt;/head&gt;
+  &lt;body&gt;
+    &lt;h1&gt;Example&lt;/h1&gt;
+    &lt;p&gt;Open <a href="cordova_storage_storage.md.html#Database">Database</a>&lt;/p&gt;
+  &lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+
+<hr>
+<h1><a name="database_name">database_name</a></h1>
+
+<p>The name of the database.</p>
+
+<hr>
+<h1><a name="database_version">database_version</a></h1>
+
+<p>The version of the database.</p>
+
+<hr>
+<h1><a name="database_displayname">database_displayname</a></h1>
+
+<p>The display name of the database.</p>
+
+<hr>
+<h1><a name="database_size">database_size</a></h1>
+
+<p>The size of the database in bytes.</p>
+
+<hr>
+<h1><a name="Database">Database</a></h1>
+
+<p>Contains methods that allow the user to manipulate the <a href="cordova_storage_storage.md.html#Database">Database</a></p>
+
+<h2>
+<a name="Database_methods">Methods</a>
+</h2>
+
+<ul>
+<li>
+<strong>transaction</strong>: Runs a database transaction. </li>
+<li>
+<strong>changeVersion</strong>: method allows scripts to atomically verify the version number and change it at the same time as doing a schema update. </li>
+</ul>
+<h2>
+<a name="Database_details">Details</a>
+</h2>
+
+<p>A <a href="cordova_storage_storage.md.html#Database">Database</a> object is returned from a call to <code>window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>()</code>.</p>
+
+<h2>
+<a name="Database_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>webOS</li>
+</ul>
+<h2>
+<a name="Database_transaction_quick_example">Transaction Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>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.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+db.transaction(populateDB, errorCB, successCB);
+</code></pre>
+
+<h2>
+<a name="Database_change_version_quick_example">Change Version Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+db.changeVersion("1.0", "1.1");
+</code></pre>
+
+<h2>
+<a name="Database_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
+&lt;html&gt;
+  &lt;head&gt;
+    &lt;title&gt;<a href="cordova_storage_storage.md.html#Storage">Storage</a> Example&lt;/title&gt;
+
+    &lt;script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"&gt;&lt;/script&gt;
+    &lt;script type="text/javascript" charset="utf-8"&gt;
+
+    // Wait for Cordova to load
+    //
+    document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+    // Cordova is ready
+    //
+    function onDeviceReady() {
+        var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "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!");
+    }
+
+    &lt;/script&gt;
+  &lt;/head&gt;
+  &lt;body&gt;
+    &lt;h1&gt;Example&lt;/h1&gt;
+    &lt;p&gt;<a href="cordova_storage_storage.md.html#Database">Database</a>&lt;/p&gt;
+  &lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+
+<h2>
+<a name="Database_android_1_x_quirks">Android 1.X Quirks</a>
+</h2>
+
+<ul>
+<li>
+<strong>changeVersion:</strong> This method is not support by Android 1.X devices.</li>
+</ul>
+<hr>
+<h1><a name="SQLTransaction">SQLTransaction</a></h1>
+
+<p>Contains methods that allow the user to execute SQL statements against the <a href="cordova_storage_storage.md.html#Database">Database</a>.</p>
+
+<h2>
+<a name="SQLTransaction_methods">Methods</a>
+</h2>
+
+<ul>
+<li>
+<strong>executeSql</strong>: executes a SQL statement</li>
+</ul>
+<h2>
+<a name="SQLTransaction_details">Details</a>
+</h2>
+
+<p>When you call a <a href="cordova_storage_storage.md.html#Database">Database</a> objects transaction method it's callback methods will be called with a <a href="cordova_storage_storage.md.html#SQLTransaction">SQLTransaction</a> object.  The user can build up a database transaction by calling the executeSql method multiple times.  </p>
+
+<h2>
+<a name="SQLTransaction_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>webOS</li>
+</ul>
+<h2>
+<a name="SQLTransaction_execute_sql_quick_example">Execute SQL Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>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.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+db.transaction(populateDB, errorCB, successCB);
+</code></pre>
+
+<h2>
+<a name="SQLTransaction_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
+&lt;html&gt;
+  &lt;head&gt;
+    &lt;title&gt;<a href="cordova_storage_storage.md.html#Storage">Storage</a> Example&lt;/title&gt;
+
+    &lt;script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"&gt;&lt;/script&gt;
+    &lt;script type="text/javascript" charset="utf-8"&gt;
+
+    // Wait for Cordova to load
+    //
+    document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+    // Cordova is ready
+    //
+    function onDeviceReady() {
+        var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "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!");
+    }
+
+    &lt;/script&gt;
+  &lt;/head&gt;
+  &lt;body&gt;
+    &lt;h1&gt;Example&lt;/h1&gt;
+    &lt;p&gt;<a href="cordova_storage_storage.md.html#SQLTransaction">SQLTransaction</a>&lt;/p&gt;
+  &lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+
+<hr>
+<h1><a name="SQLResultSet">SQLResultSet</a></h1>
+
+<p>When the executeSql method of a <a href="cordova_storage_storage.md.html#SQLTransaction">SQLTransaction</a> is called it will invoke it's callback with a <a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a>.</p>
+
+<h2>
+<a name="SQLResultSet_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>insertId</strong>: the row ID of the row that the <a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a> object's SQL statement inserted into the database</li>
+<li>
+<strong>rowsAffected</strong>: 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. </li>
+<li>
+<strong>rows</strong>: a SQLResultSetRowList representing the rows returned.  If no rows are returned the object will be empty.</li>
+</ul>
+<h2>
+<a name="SQLResultSet_details">Details</a>
+</h2>
+
+<p>When you call the <a href="cordova_storage_storage.md.html#SQLTransaction">SQLTransaction</a> executeSql method its callback methods will be called with a <a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a> object.  The result object has three properties.  The first is the <code>insertId</code> which will return the row number of a success SQL insert statement.  If the SQL statement is not an insert then the <code>insertId</code> is not set.  The <code>rowsAffected</code> 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 <a href="cordova_storage_storage.md.html#SQLResultSetList">SQLResultSetList</a> and it contains the data returned from a SQL select statement.</p>
+
+<h2>
+<a name="SQLResultSet_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>webOS</li>
+</ul>
+<h2>
+<a name="SQLResultSet_execute_sql_quick_example">Execute SQL Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>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.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+db.transaction(queryDB, errorCB);
+</code></pre>
+
+<h2>
+<a name="SQLResultSet_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
+&lt;html&gt;
+  &lt;head&gt;
+    &lt;title&gt;<a href="cordova_storage_storage.md.html#Storage">Storage</a> Example&lt;/title&gt;
+
+    &lt;script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"&gt;&lt;/script&gt;
+    &lt;script type="text/javascript" charset="utf-8"&gt;
+
+    // Wait for Cordova to load
+    //
+    document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", 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.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+        db.transaction(queryDB, errorCB);
+    }
+
+    // Cordova is ready
+    //
+    function onDeviceReady() {
+        var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+        db.transaction(populateDB, errorCB, successCB);
+    }
+
+    &lt;/script&gt;
+  &lt;/head&gt;
+  &lt;body&gt;
+    &lt;h1&gt;Example&lt;/h1&gt;
+    &lt;p&gt;<a href="cordova_storage_storage.md.html#Database">Database</a>&lt;/p&gt;
+  &lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+
+<hr>
+<h1><a name="SQLResultSetList">SQLResultSetList</a></h1>
+
+<p>One of the properties of the <a href="cordova_storage_storage.md.html#SQLResultSet">SQLResultSet</a> containing the rows returned from a SQL query.</p>
+
+<h2>
+<a name="SQLResultSetList_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>length</strong>: the number of rows returned by the SQL query</li>
+</ul>
+<h2>
+<a name="SQLResultSetList_methods">Methods</a>
+</h2>
+
+<ul>
+<li>
+<strong>item</strong>: returns the row at the specified index represented by a JavaScript object.</li>
+</ul>
+<h2>
+<a name="SQLResultSetList_details">Details</a>
+</h2>
+
+<p>The <a href="cordova_storage_storage.md.html#SQLResultSetList">SQLResultSetList</a> 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 <code>item</code> 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.</p>
+
+<h2>
+<a name="SQLResultSetList_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>webOS</li>
+</ul>
+<h2>
+<a name="SQLResultSetList_execute_sql_quick_example">Execute SQL Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>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&lt;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.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+db.transaction(queryDB, errorCB);
+</code></pre>
+
+<h2>
+<a name="SQLResultSetList_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
+&lt;html&gt;
+  &lt;head&gt;
+    &lt;title&gt;<a href="cordova_storage_storage.md.html#Storage">Storage</a> Example&lt;/title&gt;
+
+    &lt;script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"&gt;&lt;/script&gt;
+    &lt;script type="text/javascript" charset="utf-8"&gt;
+
+    // Wait for Cordova to load
+    //
+    document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", 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&lt;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.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+        db.transaction(queryDB, errorCB);
+    }
+
+    // Cordova is ready
+    //
+    function onDeviceReady() {
+        var db = window.<a href="cordova_storage_storage.md.html#openDatabase">openDatabase</a>("<a href="cordova_storage_storage.md.html#Database">Database</a>", "1.0", "Cordova Demo", 200000);
+        db.transaction(populateDB, errorCB, successCB);
+    }
+
+    &lt;/script&gt;
+  &lt;/head&gt;
+  &lt;body&gt;
+    &lt;h1&gt;Example&lt;/h1&gt;
+    &lt;p&gt;<a href="cordova_storage_storage.md.html#Database">Database</a>&lt;/p&gt;
+  &lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+
+<hr>
+<h1><a name="SQLError">SQLError</a></h1>
+
+<p>A <code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a></code> object is thrown when an error occurs.</p>
+
+<h2>
+<a name="SQLError_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>code:</strong> One of the predefined error codes listed below.</li>
+<li>
+<strong>message:</strong> A description of the error.</li>
+</ul>
+<h2>
+<a name="SQLError_constants">Constants</a>
+</h2>
+
+<ul>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.UNKNOWN_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.DATABASE_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.VERSION_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.TOO_LARGE_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.QUOTA_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.SYNTAX_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.CONSTRAINT_ERR</code></li>
+<li><code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a>.TIMEOUT_ERR</code></li>
+</ul>
+<h2>
+<a name="SQLError_description">Description</a>
+</h2>
+
+<p>The <code><a href="cordova_storage_storage.md.html#SQLError">SQLError</a></code> object is thrown when an error occurs when manipulating a database.</p>
+
+<hr>
+<h1><a name="localStorage">localStorage</a></h1>
+
+<p>Provides access to a W3C <a href="cordova_storage_storage.md.html#Storage">Storage</a> interface (http://dev.w3.org/html5/webstorage/#the-localstorage-attribute)</p>
+
+<pre class="prettyprint"><code>var storage = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>;
+</code></pre>
+
+<h2>
+<a name="localStorage_methods">Methods</a>
+</h2>
+
+<ul>
+<li>
+<strong>key</strong>: Returns the name of the key at the position specified. </li>
+<li>
+<strong>getItem</strong>: Returns the item identified by it's key.</li>
+<li>
+<strong>setItem</strong>: Saves and item at the key provided.</li>
+<li>
+<strong>removeItem</strong>: Removes the item identified by it's key.</li>
+<li>
+<strong>clear</strong>: Removes all of the key value pairs.</li>
+</ul>
+<h2>
+<a name="localStorage_details">Details</a>
+</h2>
+
+<p><a href="cordova_storage_storage.md.html#localStorage">localStorage</a> provides an interface to a W3C <a href="cordova_storage_storage.md.html#Storage">Storage</a> interface.  It allows one to save data as key-value pairs.</p>
+
+<p>Note: window.sessionStorage provides the same interface, but is cleared between app launches.</p>
+
+<h2>
+<a name="localStorage_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 6.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 7</li>
+<li>webOS</li>
+</ul>
+<h2>
+<a name="localStorage_key_quick_example">Key Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var keyName = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.key(0);
+</code></pre>
+
+<h2>
+<a name="localStorage_set_item_quick_example">Set Item Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.setItem("key", "value");
+</code></pre>
+
+<h2>
+<a name="localStorage_get_item_quick_example">Get Item Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var value = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.getItem("key");
+// value is now equal to "value"
+</code></pre>
+
+<h2>
+<a name="localStorage_remove_item_quick_example">Remove Item Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.removeItem("key");
+</code></pre>
+
+<h2>
+<a name="localStorage_clear_quick_example">Clear Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.clear();
+</code></pre>
+
+<h2>
+<a name="localStorage_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code>&lt;!DOCTYPE html&gt;
+&lt;html&gt;
+  &lt;head&gt;
+    &lt;title&gt;<a href="cordova_storage_storage.md.html#Storage">Storage</a> Example&lt;/title&gt;
+
+    &lt;script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"&gt;&lt;/script&gt;
+    &lt;script type="text/javascript" charset="utf-8"&gt;
+
+    // Wait for Cordova to load
+    //
+    document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+    // Cordova is ready
+    //
+    function onDeviceReady() {
+        window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.setItem("key", "value");
+        var keyname = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.key(i);
+        // keyname is now equal to "key"
+        var value = window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.getItem("key");
+        // value is now equal to "value"
+        window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.removeItem("key");
+        window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.setItem("key2", "value2");
+        window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.clear();
+        // <a href="cordova_storage_storage.md.html#localStorage">localStorage</a> is now empty
+    }
+
+
+    &lt;/script&gt;
+  &lt;/head&gt;
+  &lt;body&gt;
+    &lt;h1&gt;Example&lt;/h1&gt;
+    &lt;p&gt;<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>&lt;/p&gt;
+  &lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+
+<h2>
+<a name="localStorage_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
+</h2>
+
+<ul>
+<li>dot notation is NOT available on Windows Phone. Be sure to use : window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.setItem/getItem, and not the w3 spec defined calls to window.<a href="cordova_storage_storage.md.html#localStorage">localStorage</a>.someKey = 'someValue';</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>

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/62a5f4d2/www/guide_command-line_index.md.html
----------------------------------------------------------------------
diff --git a/www/guide_command-line_index.md.html b/www/guide_command-line_index.md.html
new file mode 100644
index 0000000..4581fed
--- /dev/null
+++ b/www/guide_command-line_index.md.html
@@ -0,0 +1,279 @@
+<!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="English" value="en"><option selected value="edge">edge</option></optgroup></select></small>
+        </div>
+        <div id="subheader">
+            <h1>Command-Line Usage</h1>
+            <small><select><option value="Command-Line%2520Usage">Command-Line Usage</option>
+<option value="Command-Line%20Usage_supported_platforms">      - Supported Platforms</option>
+<option value="Command-Line%20Usage_ios">      - iOS</option>
+<option value="Command-Line%20Usage_android">      - Android</option>
+<option value="Command-Line%20Usage_blackberry">      - BlackBerry</option></select></small>
+        </div>
+
+        <div id="sidebar">
+            <div class="vertical_divider"></div>
+        <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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+        <div id="scrollable">
+            <div id="content">
+                <h1><a name="Command-Line%20Usage">Command-Line Usage</a></h1>
+
+<p>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.</p>
+
+<h2>
+<a name="Command-Line%20Usage_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li><a href="#Command-Line%20Usage_ios">iOS</a></li>
+<li><a href="#Command-Line%20Usage_android">Android</a></li>
+<li><a href="#Command-Line%20Usage_blackberry">BlackBerry</a></li>
+</ul>
+<h2>
+<a name="Command-Line%20Usage_ios">iOS</a>
+</h2>
+
+<p>The iOS command-line tools are built upon shell scripts and rely on
+XCode command-line tools such as <code>xcode-select</code> and <code>xcodebuild</code>.</p>
+
+<h3>Create a project</h3>
+
+<p>Run the <code>create</code> command with the following parameters:</p>
+
+<ul>
+<li>Path to your new Cordova iOS project</li>
+<li>Package name, following reverse-domain style convention</li>
+<li>Project name</li>
+</ul>
+<!-- --><pre class="prettyprint"><code>$ ./path/to/cordova-ios/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
+</code></pre>
+
+<h3>Build a project</h3>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/debug
+</code></pre>
+
+<h3>Launch emulator</h3>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/emulate
+</code></pre>
+
+<h3>Logging</h3>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/log
+</code></pre>
+
+<h2>
+<a name="Command-Line%20Usage_android">Android</a>
+</h2>
+
+<p>The Android command-line tools are built upon shell scripts. You <em>must</em>
+have the Android SDK's <code>tools</code> and <code>platform-tools</code> folders in your
+PATH!</p>
+
+<h3>Create a project</h3>
+
+<p>Run the <code>create</code> command with the following parameters:</p>
+
+<ul>
+<li>Path to your new Cordova Android project</li>
+<li>Package name, following reverse-domain style convention</li>
+<li>Main Activity name</li>
+</ul>
+<!-- --><pre class="prettyprint"><code>$ /path/to/cordova-android/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
+</code></pre>
+
+<p>or, on <strong>Windows</strong></p>
+
+<pre class="prettyprint"><code>$ /path/to/cordova-android/bin/create.bat /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
+</code></pre>
+
+<h3>Build a project</h3>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/debug
+</code></pre>
+
+<p>or, on <strong>Windows</strong></p>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/debug.bat
+</code></pre>
+
+<h3>Launch emulator</h3>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/emulate
+</code></pre>
+
+<p>or, on <strong>Windows</strong></p>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/emulate.bat
+</code></pre>
+
+<p>Make sure you have created at least one Android Virtual <a href="cordova_device_device.md.html#Device">Device</a>. If you did not it will ask you to create one with the <code>android</code> command.
+If you have multiple AVDs, it will prompt you to select an AVD.</p>
+
+<h3>Logging</h3>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/log
+</code></pre>
+
+<p>or, on <strong>Windows</strong></p>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/log.bat
+</code></pre>
+
+<h3>Cleaning</h3>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/clean
+</code></pre>
+
+<p>or, on <strong>Windows</strong></p>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/clean.bat
+</code></pre>
+
+<h3>Clean, build, deploy and launch</h3>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/BOOM
+</code></pre>
+
+<p>or, on <strong>Windows</strong></p>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/BOOM.bat
+</code></pre>
+
+<p>Make sure you have an emulator or a device connected.</p>
+
+<h2>
+<a name="Command-Line%20Usage_blackberry">BlackBerry</a>
+</h2>
+
+<p>The BlackBerry command-line tools are built upon shell scripts.</p>
+
+<h3>Create a project</h3>
+
+<p>Run the <code>create</code> command with the following parameters:</p>
+
+<ul>
+<li>Path to your new Cordova BlackBerry project</li>
+<li>Application name</li>
+</ul>
+<!-- --><pre class="prettyprint"><code>$ /path/to/cordova-blackberry-webworks/bin/create /path/to/my_new_cordova_project CordovaProjectName
+</code></pre>
+
+<p>or, on <strong>Windows</strong></p>
+
+<pre class="prettyprint"><code>$ /path/to/cordova-blackberry-webworks/bin/create.bat /path/to/my_new_cordova_project CordovaProjectName
+</code></pre>
+
+<h3>Build a project</h3>
+
+<p>For BlackBerry projects, please make sure you customize the
+<code>project.properties</code> 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.</p>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/debug
+</code></pre>
+
+<p>or, on <strong>Windows</strong></p>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/debug.bat
+</code></pre>
+
+<h3>Launch emulator</h3>
+
+<p>For BlackBerry projects, please make sure you customize the
+<code>project.properties</code> 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.</p>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/emulate
+</code></pre>
+
+<p>or, on <strong>Windows</strong></p>
+
+<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/emulate.bat
+</code></pre>
+
+<h3>Logging</h3>
+
+<p>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 <code>console.log</code>) on your device
+by holding down the ALT key from the home screen and hitting "lglg"
+keys.</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>

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/62a5f4d2/www/guide_cordova-webview_android.md.html
----------------------------------------------------------------------
diff --git a/www/guide_cordova-webview_android.md.html b/www/guide_cordova-webview_android.md.html
new file mode 100644
index 0000000..b4c2837
--- /dev/null
+++ b/www/guide_cordova-webview_android.md.html
@@ -0,0 +1,136 @@
+<!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="English" value="en"><option selected value="edge">edge</option></optgroup></select></small>
+        </div>
+        <div id="subheader">
+            <h1>Embedding Cordova WebView on Android</h1>
+            <small><select><option value="Embedding%2520Cordova%2520WebView%2520on%2520Android">Embedding Cordova WebView on Android</option>
+<option value="Embedding%20Cordova%20WebView%20on%20Android_prerequisites">      - Prerequisites</option>
+<option value="Embedding%20Cordova%20WebView%20on%20Android_guide_to_using_cordovawebview_in_an_android_project">      - Guide to using CordovaWebView in an Android Project</option></select></small>
+        </div>
+
+        <div id="sidebar">
+            <div class="vertical_divider"></div>
+        <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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+        <div id="scrollable">
+            <div id="content">
+                <h1><a name="Embedding%20Cordova%20WebView%20on%20Android">Embedding Cordova WebView on Android</a></h1>
+
+<p>Beginning in Cordova 1.9, with the assistance of the <code>CordovaActivity</code>, you can use Cordova as a component in a larger native Android application. This component is known in Android
+as the <code>CordovaWebView</code>. New Cordova-based applications from 1.9 onwards will be using the <code>CordovaWebView</code> as its main view, whether the legacy <code>DroidGap</code> approach is 
+used or not.</p>
+
+<p>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.</p>
+
+<h2>
+<a name="Embedding%20Cordova%20WebView%20on%20Android_prerequisites">Prerequisites</a>
+</h2>
+
+<ol>
+<li>
+<strong>Cordova 1.9</strong> or greater</li>
+<li>Android SDK updated with 15</li>
+</ol>
+<h2>
+<a name="Embedding%20Cordova%20WebView%20on%20Android_guide_to_using_cordovawebview_in_an_android_project">Guide to using CordovaWebView in an Android Project</a>
+</h2>
+
+<ol>
+<li>Use <code>bin/create</code> to fetch the commons-codec-1.6.jar</li>
+<li>
+<code>cd</code> into <code>/framework</code> and run <code>ant jar</code> to build the cordova jar (it
+will create the .jar file in the form <code>cordova-x.x.x.jar</code> in the
+<code>/framework</code> folder)</li>
+<li>Copy the cordova jar into your Android project's <code>/libs</code> directory</li>
+<li>
+<p>Edit your application's <code>main.xml</code> file (under <code>/res/xml</code>) to look similar the following. The <code>layout_height</code>, <code>layout_width</code> and <code>id</code> can be modified to suit your application</p>
+
+<pre class="prettyprint"><code>&lt;org.apache.cordova.CordovaWebView
+    android:id="@+id/tutorialView"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent" /&gt;
+</code></pre>
+</li>
+<li>
+<p>Modify your activity so that it implements the <code>CordovaInterface</code>.  It is recommended that you implement the methods that are included.  You may wish to copy the methods from <code>/framework/src/org/apache/cordova/DroidGap.java</code>, 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 <code>id</code> attribute specified in the above XML fragment from step 4):</p>
+
+<pre class="prettyprint"><code>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");
+    }
+</code></pre>
+</li>
+<li><p>Copy your application's HTML and JavaScript used to the <code>/assets/www</code> directory of your Android project</p></li>
+<li>Copy <code>cordova.xml</code> and <code>plugins.xml</code> from <code>/framework/res/xml</code> to the <code>/res/xml</code> folder in your project</li>
+</ol>
+</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>

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/62a5f4d2/www/guide_cordova-webview_index.md.html
----------------------------------------------------------------------
diff --git a/www/guide_cordova-webview_index.md.html b/www/guide_cordova-webview_index.md.html
new file mode 100644
index 0000000..f01ddb1
--- /dev/null
+++ b/www/guide_cordova-webview_index.md.html
@@ -0,0 +1,87 @@
+<!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="English" value="en"><option selected value="edge">edge</option></optgroup></select></small>
+        </div>
+        <div id="subheader">
+            <h1>Embedding WebView</h1>
+            <small></small>
+        </div>
+
+        <div id="sidebar">
+            <div class="vertical_divider"></div>
+        <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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+        <div id="scrollable">
+            <div id="content">
+                <h1><a name="Embedding%20WebView">Embedding WebView</a></h1>
+
+<blockquote>
+  <p>Implement the Cordova WebView in your own project.</p>
+</blockquote>
+
+<ul>
+<li><a href="guide_cordova-webview_android.md.html#Embedding%20Cordova%20WebView%20on%20Android">Embedding Cordova WebView on Android</a></li>
+<li><a href="guide_cordova-webview_ios.md.html#Embedding%20Cordova%20WebView%20on%20iOS">Embedding Cordova WebView on iOS</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>

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/62a5f4d2/www/guide_cordova-webview_ios.md.html
----------------------------------------------------------------------
diff --git a/www/guide_cordova-webview_ios.md.html b/www/guide_cordova-webview_ios.md.html
new file mode 100644
index 0000000..7cdc8dc
--- /dev/null
+++ b/www/guide_cordova-webview_ios.md.html
@@ -0,0 +1,297 @@
+<!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="English" value="en"><option selected value="edge">edge</option></optgroup></select></small>
+        </div>
+        <div id="subheader">
+            <h1>Embedding Cordova WebView on iOS</h1>
+            <small><select><option value="Embedding%2520Cordova%2520WebView%2520on%2520iOS">Embedding Cordova WebView on iOS</option>
+<option value="Embedding%20Cordova%20WebView%20on%20iOS_prerequisites">      - Prerequisites</option>
+<option value="Embedding%20Cordova%20WebView%20on%20iOS_adding_cleaver_to_your_xcode_project_cordova_framework">      - Adding Cleaver to your Xcode project (Cordova.framework)</option>
+<option value="Embedding%20Cordova%20WebView%20on%20iOS_adding_cleaver_to_your_xcode_project_cordovalib_sub_project">      - Adding Cleaver to your Xcode project (CordovaLib sub-project)</option>
+<option value="Embedding%20Cordova%20WebView%20on%20iOS_adding_new_classes_to_cordovalib_sub_project">      - Adding new classes to CordovaLib sub-project</option>
+<option value="Embedding%20Cordova%20WebView%20on%20iOS_using_cdvviewcontroller_in_your_code">      - Using CDVViewController in your code</option>
+<option value="Embedding%20Cordova%20WebView%20on%20iOS_adding_your_html_css_and_javascript_assets">      - Adding your HTML, CSS and JavaScript assets</option></select></small>
+        </div>
+
+        <div id="sidebar">
+            <div class="vertical_divider"></div>
+        <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_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+        <div id="scrollable">
+            <div id="content">
+                <h1><a name="Embedding%20Cordova%20WebView%20on%20iOS">Embedding Cordova WebView on iOS</a></h1>
+
+<p>Beginning with Cordova 1.4, you can use Cordova as a component in your iOS applications. This component is code-named "Cleaver".</p>
+
+<p>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.</p>
+
+<p>It is recommended that you follow the <code>Cordova.framework</code> instructions below. The <code>CordovaLib</code> sub-project instructions are for Cordova core developers or users that have custom <code>CordovaLib</code> project code (for ease of debugging the core).</p>
+
+<h2>
+<a name="Embedding%20Cordova%20WebView%20on%20iOS_prerequisites">Prerequisites</a>
+</h2>
+
+<ol>
+<li>
+<strong>Cordova 1.4.1</strong> or greater</li>
+<li>
+<strong>Xcode 4.2</strong> or greater</li>
+<li>
+<code>Cordova.plist</code> file</li>
+</ol>
+<h2>
+<a name="Embedding%20Cordova%20WebView%20on%20iOS_adding_cleaver_to_your_xcode_project_cordova_framework">Adding Cleaver to your Xcode project (Cordova.framework)</a>
+</h2>
+
+<ol>
+<li>
+<strong>Copy</strong> the <code>Cordova.plist</code> file into your project folder on disk</li>
+<li>
+<strong>Drag and drop</strong> the <code>Cordova.plist</code> file into the Project Navigator of Xcode</li>
+<li>
+<strong>Choose</strong> the radio-button <strong>"Create groups for any added folders"</strong>
+</li>
+<li>Press the key combination <strong>Option-Command-A</strong>, which should drop down a sheet to add files to your project (the <strong>"Add Files..." sheet</strong>). Make sure the <strong>"Created groups for any added folders"</strong> radio-button is selected</li>
+<li>Press the key combination <strong>Shift-Command-G</strong>, which should drop down another sheet for you to go to a folder (the <strong>"Go to the folder:" sheet</strong>)</li>
+<li>Enter <code>/Users/Shared/Cordova/Frameworks/Cordova.framework</code> in the <strong>"Go to the folder:" sheet</strong> and then press the <strong>"Go"</strong> button</li>
+<li>Press the <strong>"Add"</strong> button in the <strong>"Add Files..." sheet</strong>
+</li>
+<li>Select <code>Cordova.framework</code> in the Project Navigator</li>
+<li>Press the key combination <strong>Option-Command-1</strong> to show the <strong><a href="cordova_file_file.md.html#File">File</a> Inspector</strong>
+</li>
+<li>Choose <strong>"Absolute Path"</strong> in the <strong><a href="cordova_file_file.md.html#File">File</a> Inspector</strong> for the drop-down menu for <strong>Location</strong> </li>
+<li>Click on the <strong>project icon</strong> in the Project Navigator, select your <strong>Target</strong>, then select the <strong>"Build Phase"</strong> tab</li>
+<li>Expand <strong>"Link Binaries with Libraries"</strong>
+</li>
+<li>
+<p>Click on the <strong>"+" button</strong>, and add these <strong>frameworks</strong> (and optionally in the Project Navigator, <strong>move</strong> them under the Frameworks group):</p>
+
+<pre class="prettyprint"><code>AddressBook.framework
+AddressBookUI.framework
+AudioToolbox.framework
+AVFoundation.framework
+CoreLocation.framework
+MediaPlayer.framework
+QuartzCore.framework
+SystemConfiguration.framework
+MobileCoreServices.framework
+CoreMedia.framework
+</code></pre>
+</li>
+</ol>
+<h2>
+<a name="Embedding%20Cordova%20WebView%20on%20iOS_adding_cleaver_to_your_xcode_project_cordovalib_sub_project">Adding Cleaver to your Xcode project (CordovaLib sub-project)</a>
+</h2>
+
+<ol>
+<li>
+<strong>Copy</strong> the <code>Cordova.plist</code> file into your project folder on disk</li>
+<li>
+<strong>Drag and drop</strong> the <code>Cordova.plist</code> file into the Project Navigator of Xcode</li>
+<li>
+<strong>Choose</strong> the radio-button <strong>"Create groups for any added folders"</strong>
+</li>
+<li>Press the key combination <strong>Option-Command-A</strong>, which should drop down a sheet to add files to your project (the <strong>"Add Files..." sheet</strong>). Make sure the <strong>"Created groups for any added folders"</strong> radio-button is selected</li>
+<li>Press the key combination <strong>Shift-Command-G</strong>, which should drop down another sheet for you to go to a folder (the <strong>"Go to the folder:" sheet</strong>)</li>
+<li>Enter <code>~/Documents/CordovaLib/</code> in the <strong>"Go to the folder:" sheet</strong> and then press the <strong>"Go"</strong> button</li>
+<li>Select the <code>VERSION</code> file in the the <strong>"Add Files..." sheet</strong>
+</li>
+<li>Press the <strong>"Add"</strong> button in the <strong>"Add Files..." sheet</strong>
+</li>
+<li>Press the key combination <strong>Option-Command-A</strong>, which should drop down a sheet to add files to your project (the <strong>"Add Files..." sheet</strong>). Make sure the <strong>"Created groups for any added folders"</strong> radio-button is selected</li>
+<li>Press the key combination <strong>Shift-Command-G</strong>, which should drop down another sheet for you to go to a folder (the <strong>"Go to the folder:" sheet</strong>)</li>
+<li>Enter <code>~/Documents/CordovaLib/CordovaLib.xcodeproj</code> in the <strong>"Go to the folder:" sheet</strong> and then press the <strong>"Go"</strong> button</li>
+<li>Press the <strong>"Add"</strong> button in the <strong>"Add Files..." sheet</strong>
+</li>
+<li>Select <code>CordovaLib.xcodeproj</code> in the Project Navigator</li>
+<li>Press the key combination <strong>Option-Command-1</strong> to show the <strong><a href="cordova_file_file.md.html#File">File</a> Inspector</strong>
+</li>
+<li>Choose <strong>"Relative to CORDOVALIB"</strong> in the <strong><a href="cordova_file_file.md.html#File">File</a> Inspector</strong> for the drop-down menu for <strong>Location</strong> </li>
+<li>Click on the <strong>project icon</strong> in the Project Navigator, select your <strong>Project</strong>, then select the <strong>"Build Settings"</strong> tab</li>
+<li>Enter <strong>"Header Search Paths"</strong> in the search field</li>
+<li>Add <code>$(CORDOVALIB)/Classes</code> and check the <strong>Recursive</strong> checkbox (the checkbox may be unlabeled) - for the <strong>"Header Search Paths"</strong> value</li>
+<li>Add <code>-all_load</code> and <code>-Obj-C</code> - for the <strong>"Other Linker <a href="cordova_file_file.md.html#Flags">Flags</a>"</strong> value</li>
+<li>Click on the <strong>project icon</strong> in the Project Navigator, select your <strong>Target</strong>, then select the <strong>"Build Phases"</strong> tab</li>
+<li>Expand <strong>"Link Binaries with Libraries"</strong> </li>
+<li>
+<p>Click on the <strong>"+" button</strong>, and add these <strong>frameworks</strong> (and optionally in the Project Navigator, <strong>move</strong> them under the Frameworks group):</p>
+
+<pre class="prettyprint"><code>AddressBook.framework
+AddressBookUI.framework
+AudioToolbox.framework
+AVFoundation.framework
+CoreLocation.framework
+MediaPlayer.framework
+QuartzCore.framework
+SystemConfiguration.framework
+MobileCoreServices.framework
+CoreMedia.framework
+</code></pre>
+</li>
+<li><p>Expand <strong>"Target Dependencies"</strong> - the top box labeled like this if
+you have multiple boxes!</p></li>
+<li>Click on the <strong>"+" button</strong>, and add the <code>CordovaLib</code> build product</li>
+<li>Expand <strong>"Link Binaries with Libraries"</strong> - the top box labeled like
+this if you have multiple boxes!</li>
+<li>Click on the <strong>"+" button</strong>, and add <code>libCordova.a</code>
+</li>
+</ol>
+<h2>
+<a name="Embedding%20Cordova%20WebView%20on%20iOS_adding_new_classes_to_cordovalib_sub_project">Adding new classes to CordovaLib sub-project</a>
+</h2>
+
+<p>In general if you are only modifying or debugging existing CordovaLib
+classes you should be OK with just the above steps. However if you are
+adding new classes you need to follow a few additional steps:</p>
+
+<ol>
+<li>In your project's Frameworks directory in Xcode, remove
+<code>Cordova.framework</code>.</li>
+<li>Just to reiterate step 18 and 20 above: make sure your dependencies
+and libraries are in the top-most boxes under Build Phases for your
+project's Target.</li>
+<li>In your project's Target's Build Settings, search for "Other Linker
+<a href="cordova_file_file.md.html#Flags">Flags</a>". Add <code>-Obj-C</code> and <code>-all_load</code> to this.</li>
+</ol>
+<h2>
+<a name="Embedding%20Cordova%20WebView%20on%20iOS_using_cdvviewcontroller_in_your_code">Using CDVViewController in your code</a>
+</h2>
+
+<ol>
+<li>
+<p>Add this <strong>header</strong> if you used the <code>Cordova.framework</code>:</p>
+
+<pre class="prettyprint"><code>#import &lt;Cordova/CDVViewController.h&gt;
+</code></pre>
+</li>
+<li>
+<p>Add this <strong>header</strong> if you used the <code>CordovaLib</code> sub-project:</p>
+
+<pre class="prettyprint"><code>#import "CDVViewController.h"
+</code></pre>
+</li>
+<li>
+<p>Instantiate a <strong>new</strong> <code>CDVViewController</code>, and retain it somewhere: </p>
+
+<pre class="prettyprint"><code>CDVViewController* viewController = [CDVViewController new];
+</code></pre>
+</li>
+<li>
+<p>(<em>OPTIONAL</em>) Set the <code>wwwFolderName</code> property (defaults to <code>"www"</code>):</p>
+
+<pre class="prettyprint"><code>viewController.wwwFolderName = @"myfolder";
+</code></pre>
+</li>
+<li>
+<p>(<em>OPTIONAL</em>) Set the <code>startPage</code> property (defaults to <code>"index.html"</code>):</p>
+
+<pre class="prettyprint"><code>viewController.startPage = @"mystartpage.html";
+</code></pre>
+</li>
+<li>
+<p>(<em>OPTIONAL</em>) Set the <code>useSplashScreen</code> property (defaults to <code>NO</code>):</p>
+
+<pre class="prettyprint"><code>viewController.useSplashScreen = YES;
+</code></pre>
+</li>
+<li>
+<p>Set the <strong>view frame</strong> (always set this as the last property):</p>
+
+<pre class="prettyprint"><code>viewController.view.frame = CGRectMake(0, 0, 320, 480);
+</code></pre>
+</li>
+<li>
+<p><strong>Add</strong> Cleaver to your view:</p>
+
+<pre class="prettyprint"><code>[myView addSubview:viewController.view];
+</code></pre>
+</li>
+</ol>
+<h2>
+<a name="Embedding%20Cordova%20WebView%20on%20iOS_adding_your_html_css_and_javascript_assets">Adding your HTML, CSS and JavaScript assets</a>
+</h2>
+
+<ol>
+<li>Create a <strong>new folder</strong> in your project <strong>on disk</strong>, for example, name it <code>www</code>
+</li>
+<li>Put your <strong>HTML, CSS and JavaScript assets</strong> into this folder</li>
+<li>
+<strong>Drag and drop</strong> the folder into the Project Navigator of Xcode</li>
+<li>
+<strong>Choose</strong> the radio-button <strong>"Create folder references for any added folders"</strong>
+</li>
+<li>
+<p><strong>Set the appropriate <code>wwwFolderName</code> and <code>startPage</code> properties</strong> for the folder you created in <strong>(1)</strong> or use the defaults (see previous section) when you instantiate the <code>CDVViewController</code>.</p>
+
+<pre class="prettyprint"><code>/*
+ 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"
+</code></pre>
+</li>
+</ol>
+</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>


Mime
View raw message