incubator-callback-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ste...@apache.org
Subject [6/6] tagged 1.6.1
Date Wed, 18 Apr 2012 18:33:21 GMT
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/cordova/storage/parameters/version.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/cordova/storage/parameters/version.md b/docs/en/1.6.1/cordova/storage/parameters/version.md
new file mode 100644
index 0000000..712dc78
--- /dev/null
+++ b/docs/en/1.6.1/cordova/storage/parameters/version.md
@@ -0,0 +1,4 @@
+database_version
+=============
+
+The version of the database.

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/cordova/storage/sqlerror/sqlerror.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/cordova/storage/sqlerror/sqlerror.md b/docs/en/1.6.1/cordova/storage/sqlerror/sqlerror.md
new file mode 100644
index 0000000..9f12197
--- /dev/null
+++ b/docs/en/1.6.1/cordova/storage/sqlerror/sqlerror.md
@@ -0,0 +1,28 @@
+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/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/1.6.1/cordova/storage/sqlresultset/sqlresultset.md
new file mode 100644
index 0000000..6f30820
--- /dev/null
+++ b/docs/en/1.6.1/cordova/storage/sqlresultset/sqlresultset.md
@@ -0,0 +1,119 @@
+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
+
+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>Contact Example</title>
+
+        <script type="text/javascript" charset="utf-8" src="cordova-1.6.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 (!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);
+		}
+
+		// 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/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md b/docs/en/1.6.1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md
new file mode 100644
index 0000000..9886ecf
--- /dev/null
+++ b/docs/en/1.6.1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md
@@ -0,0 +1,116 @@
+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
+
+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>Contact Example</title>
+
+        <script type="text/javascript" charset="utf-8" src="cordova-1.6.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/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/1.6.1/cordova/storage/sqltransaction/sqltransaction.md
new file mode 100644
index 0000000..20989c8
--- /dev/null
+++ b/docs/en/1.6.1/cordova/storage/sqltransaction/sqltransaction.md
@@ -0,0 +1,93 @@
+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
+
+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>Contact Example</title>
+
+        <script type="text/javascript" charset="utf-8" src="cordova-1.6.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/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/cordova/storage/storage.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/cordova/storage/storage.md b/docs/en/1.6.1/cordova/storage/storage.md
new file mode 100644
index 0000000..1ce586e
--- /dev/null
+++ b/docs/en/1.6.1/cordova/storage/storage.md
@@ -0,0 +1,29 @@
+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
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/cordova/storage/storage.opendatabase.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/cordova/storage/storage.opendatabase.md b/docs/en/1.6.1/cordova/storage/storage.opendatabase.md
new file mode 100644
index 0000000..7493081
--- /dev/null
+++ b/docs/en/1.6.1/cordova/storage/storage.opendatabase.md
@@ -0,0 +1,54 @@
+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
+
+Quick Example
+-------------
+
+    var db = window.openDatabase("test", "1.0", "Test DB", 1000000);
+
+Full Example
+------------
+
+    <!DOCTYPE html>
+    <html>
+      <head>
+        <title>Contact Example</title>
+
+        <script type="text/javascript" charset="utf-8" src="cordova-1.6.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/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/guide/getting-started/android/index.md b/docs/en/1.6.1/guide/getting-started/android/index.md
new file mode 100644
index 0000000..2ecd2e4
--- /dev/null
+++ b/docs/en/1.6.1/guide/getting-started/android/index.md
@@ -0,0 +1,112 @@
+Getting Started with Android
+============================
+
+This guide describes how to set up your development environment for Cordova and run a sample
application.  Note that Cordova used to be called PhoneGap, so some of the sites still use
the old PhoneGap name.
+
+
+1. Requirements
+---------------
+
+- Eclipse 3.4+
+
+
+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://phonegap.com/download) and extract its contents.
We will be working with the Android directory.
+
+ 3. Setup New Project
+---------------------
+
+- Launch Eclipse, and select menu item **New &gt; Android Project**.  Fill out the three
panels of the **New Android Project** wizard shown below.
+
+    ![](img/guide/getting-started/android/AndroidFlow.png)
+    
+- In the root directory of your project, create two new directories:
+ 	- **/libs**
+ 	- **assets/www**
+- Copy **cordova-1.6.0.js** from your Cordova download earlier to **assets/www**
+- Copy **cordova-1.6.0.jar** from your Cordova download earlier to **/libs**
+- Copy **xml** folder from your Cordova download earlier to **/res**
+
+- Verify that **cordova-1.6.0.jar** is listed in the Build Path for your project. Right click
on the /libs folder and go to **Build Paths/ &gt; Configure Build Path...**. Then, in
the Libraries tab, add **cordova-1.6.0.jar** to the project. If Eclipse is being temperamental,
you might need to refresh (F5) the project once again.
+
+    ![](img/guide/getting-started/android/buildPath.jpg)
+
+- Edit your project's main Java file found in the **src** folder in Eclipse:
+	- Add **import org.apache.cordova.*;**
+	- Change the class's extend from **Activity** to **DroidGap**
+	- Replace the **setContentView()** line with **super.loadUrl("file:///android_asset/www/index.html");**

+
+	![](img/guide/getting-started/android/javaSrc.jpg)
+	
+- Right click on AndroidManifest.xml and select **Open With &gt; XML Editor**
+- Paste the following permissions between the **&lt;uses-sdk.../&gt;** and **&lt;application.../&gt;**
tags.
+
+        <supports-screens 
+            android:largeScreens="true" 
+            android:normalScreens="true" 
+            android:smallScreens="true" 
+            android:resizeable="true" 
+            android:anyDensity="true" />
+        <uses-permission android:name="android.permission.CAMERA" />
+        <uses-permission android:name="android.permission.VIBRATE" />
+        <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+        <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+        <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS"
/>
+        <uses-permission android:name="android.permission.READ_PHONE_STATE" />
+        <uses-permission android:name="android.permission.INTERNET" />
+        <uses-permission android:name="android.permission.RECEIVE_SMS" />
+        <uses-permission android:name="android.permission.RECORD_AUDIO" />
+        <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
+        <uses-permission android:name="android.permission.READ_CONTACTS" />
+        <uses-permission android:name="android.permission.WRITE_CONTACTS" />
+        <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+        <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

+        <uses-permission android:name="android.permission.GET_ACCOUNTS" />
+        <uses-permission android:name="android.permission.BROADCAST_STICKY" />
+
+- Support orientation changes by pasting the folowing inside the **&lt;activity&gt;**
tag.
+
+        android:configChanges="orientation|keyboardHidden"
+
+- Your AndroidManifest.xml file should look like
+
+    ![](img/guide/getting-started/android/manifest.jpg)
+
+4. Hello World
+--------------    
+
+- Create and open a new file named **index.html** in the **assets/www** directory. Paste
the following code:
+
+	    <!DOCTYPE HTML>
+        <html>
+        <head>
+        <title>Cordova</title>
+        <script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
+        </head>
+        <body>
+        <h1>Hello World</h1>
+        </body>
+        </html>
+
+
+5A. Deploy to Simulator
+-----------------------
+
+- Right click the project and go to **Run As &gt; Android Application**
+- Eclipse will ask you to select an appropriate AVD. If there isn't one, then you'll need
to create it.
+
+
+5B. Deploy to Device
+--------------------
+
+- Make sure USB debugging is enabled on your device and plug it into your system. (**Settings
&gt; Applications &gt; Development**)
+- Right click the project and go to **Run As &gt; Android Application**
+
+
+Done!
+-----

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/guide/getting-started/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/guide/getting-started/blackberry/index.md b/docs/en/1.6.1/guide/getting-started/blackberry/index.md
new file mode 100644
index 0000000..cf4d131
--- /dev/null
+++ b/docs/en/1.6.1/guide/getting-started/blackberry/index.md
@@ -0,0 +1,82 @@
+Getting Started with Blackberry
+============================
+
+Cordova for BlackBerry makes use of the [BlackBerry WebWorks framework](https://bdsc.webapps.blackberry.com/html5).
BlackBerry WebWorks tooling is available for Windows or Mac environments. WebWorks applications
can ONLY be deployed to BlackBerry devices running OS 5.0 and higher or the BlackBerry PlayBook
operating system.
+
+1.  Requirements
+---------------
+
+- Windows XP (32-bit) or Windows 7 (32-bit and 64-bit) or Mac OSX 10.6.4+
+- Java Development Kit (JDK)
+    - Windows: [Oracle JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html#jdk)
(32-Bit Version)
+    - Mac OS X: Versions prior to Mac OS X 10.7 provided Java by default.  OS X 10.7+ requires
installation of [Java](http://support.apple.com/kb/DL1421).
+-   Apache Ant
+    - Windows: [Apache Ant](http://ant.apache.org/bindownload.cgi).
+    - Mac OS X: Apache Ant is bundled with Java install.
+
+2.  Install SDK + Cordova
+-------------------------
+
+- PlayBook development requires the [Adobe Air SDK](http://www.adobe.com/devnet/air/air-sdk-download.html)
+- Download and install one or more of the WebWorks SDKs. Keep note of the install directory.
+    - Smartphone Development: [BlackBerry WebWorks Smartphone SDK](https://bdsc.webapps.blackberry.com/html5/download/sdk)
+    - PlayBook Development: [BlackBerry WebWorks Tablet OS SDK](https://bdsc.webapps.blackberry.com/html5/download/sdk)
+- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents.
+
+3.  Setup New Project
+--------------------
+
+- Open up a command prompt/terminal and navigate to where you extracted Cordova.
+- There is a directory for each platform that Cordova supports.  CD into the blackberry directory.
+- The blackberry directory contains two directories, `sample` and `www`.  The `sample` folder
contains a complete Cordova project.  Copy the `sample` folder to another location on your
computer.
+- Change to the newly created directory.
+- Open up the project.properties file with your favorite editor and edit the entries for
`blackberry.bbwp.dir=` and/or `playbook.bbwp.dir=`. Set the  value(s) to the directory containing
the `bbwp` binary in the WebWorks SDK(s) installed earlier.
+
+4.  Hello World
+--------------
+
+Build the Cordova sample project by typing `ant target build` in your command prompt/terminal
while you are in your project's directory. Replace `target` with either `blackberry` or `playbook`.
Note this is a sample Cordova project and not a basic hello world application. The provided
index.html in the www contains example usages of many of the Cordova API.
+
+5A.  Deploy to Simulator
+--------------------------------------
+
+BlackBerry smartphone simulators are only available on Windows. PlayBook simulators require
VMWare Player (Windows) or VMWare Fusion (Mac OS X). The WebWorks SDK provides a default simulator.
Additional simulators are [available](http://us.blackberry.com/developers/resources/simulators.jsp).
+
+- Open the project.properties file with your favorite editor and customize the following
properties.
+    - Smartphone (Optional)
+        - `blackberry.sim.dir` : Path to directory containing simulator. On windows file
separator '\' must be escaped '\\\'.
+        - `blackberry.sim.bin` : Name of the simulator executable in the specified directory.
+    - Playbook
+        - `playbook.sim.ip` : IP address of simulator obtained when placing the simulator
in developer mode through simulator security settings.
+        - `playbook.sim.password` : Simulator password which can be set through simulator
security settings.
+- While in your project directory, in command prompt/terminal type `ant target load-simulator`.
Replace `target` with either `blackberry` or `playbook`.  Note, for PlayBook the simulator
virtual image must already be started.
+- The application will be installed in the All Applications section in the simulator.  Note,
on BlackBerry OS 5 the application is installed in the Downloads folder.
+
+5B.  Deploy to Device (Windows and Mac)
+--------------------------------------
+
+- Deploying to a device requires signing keys which can be obtained from RIM.
+    - Fill out this [form](https://bdsc.webapps.blackberry.com/html5/signingkey). to request
signing keys.
+    - Install the signing keys once they have been received:
+        - [Setup Smartphone Signing keys](https://bdsc.webapps.blackberry.com/html5/documentation/ww_publishing/signing_setup_smartphone_apps_1920010_11.html)
+        - [Setup Tablet Signing keys](https://bdsc.webapps.blackberry.com/html5/documentation/ww_publishing/signing_setup_tablet_apps_1920009_11.html)
+- Install [BlackBerry Desktop Sofware](http://us.blackberry.com/apps-software/desktop/) to
be able to install a signed application to a smartphone device attached via USB.
+- Open the project.properties file with your favorite editor and customize the following
properties:
+    - Smartphone (Optional)
+        - `blackberry.sigtool.password` : Password used when code signing keys were registered.
 If not specified, a prompt will occur.
+    - Playbook (Required)
+        - `playbook.sigtool.csk.password` : Signing key password.
+        - `playbook.sigtool.p12.password` : Signing key password.
+        - `playbook.device.ip` : IP address of device obtained when placing the device in
developer mode through device security settings.
+        - `playbook.device.password` : Device password which is set through device security
settings.
+- While in your project directory, in command prompt/terminal type `ant target load-device`.
Replace `target` with either `blackberry` or `playbook`.
+- The application will be installed in the All Applications section in the device.  Note,
on BlackBerry OS 5 the application is installed in the Downloads folder.
+
+Additional Information
+----------------------
+
+The following articles provide help to issues you may encounter when developing a Cordova
application which is based on the BlackBerry WebWorks framework.
+
+- [BlackBerry WebWorks Development Pitfalls](http://supportforums.blackberry.com/t5/Web-and-WebWorks-Development/Common-BlackBerry-WebWorks-development-pitfalls-that-can-be/ta-p/624712)
+- [Best practices for packaging WebWorks applications](https://bdsc.webapps.blackberry.com/html5/documentation/ww_developing/bestpractice_compiling_ww_apps_1873324_11.html)
+

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/guide/getting-started/index.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/guide/getting-started/index.md b/docs/en/1.6.1/guide/getting-started/index.md
new file mode 100644
index 0000000..dd04ef8
--- /dev/null
+++ b/docs/en/1.6.1/guide/getting-started/index.md
@@ -0,0 +1,9 @@
+Getting Started Guides
+======================
+
+- Getting Started with Android
+- Getting Started with Blackberry
+- Getting Started with iOS
+- Getting Started with Symbian
+- Getting Started with WebOS
+- Getting Started with Windows Phone
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/guide/getting-started/ios/index.md b/docs/en/1.6.1/guide/getting-started/ios/index.md
new file mode 100644
index 0000000..768e065
--- /dev/null
+++ b/docs/en/1.6.1/guide/getting-started/ios/index.md
@@ -0,0 +1,100 @@
+Getting Started with iOS
+========================
+
+This guide describes how to set up your development environment for Cordova and run a sample
application.
+
+Video Tutorials:
+----------------
+
+- [Cordova Installer - Xcode 4 Template](http://www.youtube.com/v/R9zktJUN7AI?autoplay=1)
+
+
+1. Requirements
+---------------
+- Intel-based computer with Mac OS X Lion (10.7)
+- Necessary for Installing on Device:
+    - An Apple iOS device (iPhone, iPad, iPod Touch)
+    - iOS ceveloper certification
+
+
+2. Install SDK + Cordova
+------------------------
+
+- Install Xcode from the [Mac App Store](http://itunes.apple.com/us/app/xcode/id497799835?mt=12)
</p>
+- Donwload the latest copy of [Cordova](http://phonegap.com/download) and extract its contents.
We will be working with the **lib/ios** directory.
+
+
+3. Setup New Project
+--------------------
+
+- Launch Xcode
+- Select the **File** menu
+- Select **New**, then **New Project...**
+- Select **Cordova-based Application** from the list of templates
+
+    ![](img/guide/getting-started/ios/XCode4-templates.png)
+- Select the **Next** button
+- Fill in the "Product Name" &amp; "Company Identifier" for your app
+
+    ![](img/guide/getting-started/ios/xcode4-name_your_app.png)
+    
+- Do **NOT** check the "Use Automatic Reference Counting" checkbox
+- Select the **Next** button
+- **Choose a folder** to save your new app in
+- Select the **Create** button, this will create your project
+- Select the **Run** button in the top left corner. Your build should succeed and launch
in the iOS Simulator
+
+    a. You should see an error in the iOS Simulator informing you that **www/index.html**
was not found
+    
+    b. To fix this, we need to add a folder reference to the **www** directory into the project.

+    
+    ![](img/guide/getting-started/ios/index-not-found.png)
+
+- **Right-click** on the project icon in the Project Navigator (left sidebar) and select
**Show in Finder**
+- **In the Finder**, you should see the **www** directory beside your project
+
+    ![](img/guide/getting-started/ios/www-folder.png)
+
+- **IMPORTANT**! **Drag** the **www** folder into Xcode 4. **Don't** drag the www folder
into your app's folder. **It needs to be dragged into Xcode 4.** For example, you would drag
and drop it on the **highlighted red section** of the HelloWorld project shown below.
+    
+    ![](img/guide/getting-started/ios/project.jpg)
+- A window sheet should slide down with a few options, after the **"www"** folder has been
dragged and dropped into the project. 
+- Select the radio-button **Create folder references for any added folders**.
+
+    ![](img/guide/getting-started/ios/create-folder-reference.png)
+
+- Select the **Finish** button
+
+
+4. Hello World
+--------------
+
+- Select the folder named **www** in your Project Navigator in Xcode
+- Select the **index.html** file
+- Type `<h1>Hello World</h1>` after the `<body>` tag
+
+You can also add any associated JavaScript and CSS files there as well.
+    
+    
+5A. Deploy to Simulator
+-----------------------
+
+- Change the Active SDK in the Scheme drop-down menu on the toolbar to **iOS version# Simulator**.
+- Select the **Run** button in your project window's toolbar
+
+
+5B. Deploy to Device
+--------------------
+
+- Open [AppName]-Info.plist (where [AppName] is your application's name), under the "Supporting
Files" group
+- Change **BundleIdentifier** to the identifier provided by Apple, or your own bundle identifier.
If you have a developer license, you can access and run the Assistant [here](http://developer.apple.com/iphone/manage/overview/index.action)
and register your app.
+- Change the Active SDK in the Scheme drop-down menu on the toolbar to **[DEVICENAME]** where
[DEVICENAME] is the name of the device you want to deploy to.
+- Select the **Run** button in your project window's toolbar
+
+    ![](img/guide/getting-started/ios/HelloWorldiPhone4.png)    
+
+
+Done!
+-----
+
+Add more HTML, CSS and JavaScript to your **www** folder outside of Xcode, your file additions
will be picked up automatically inside Xcode.

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/guide/getting-started/symbian/index.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/guide/getting-started/symbian/index.md b/docs/en/1.6.1/guide/getting-started/symbian/index.md
new file mode 100644
index 0000000..d60a453
--- /dev/null
+++ b/docs/en/1.6.1/guide/getting-started/symbian/index.md
@@ -0,0 +1,59 @@
+Getting Started with Symbian
+============================
+
+This guide describes how to set up your development environment for Cordova and run a sample
application.  Note that Cordova used to be called PhoneGap, so some of the sites still use
the old PhoneGap name.
+
+Video Tutorials:
+----------------
+
+- [Cordova Installer - Xcode 4 Template](http://www.youtube.com/v/R9zktJUN7AI?autoplay=1)
+
+
+1. Requirements
+---------------
+
+- Windows, OS X, or Linux
+
+There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGap-Symbian-%28Qt%29)
and [Symbian with Sony Ericsson](http://wiki.phonegap.com/w/page/16494782/Getting-Started-with-PhoneGap-Symbian-(WRT-on-Sony-Ericsson))
guides.
+
+
+2. Install SDK + Cordova
+-------------------------
+
+- Download and install [cygwin](http://www.cygwin.com/setup.exe) (Windows only). Make sure
you select "make" as it is not included by default
+- Donwload the latest copy of [Cordova](http://phonegap.com/download) and extract its contents.
We will be working with the Android directory.
+
+
+3. Setup New Project
+--------------------
+
+- In cygwin, navigate to where you extracted Cordova and go into the Symbian directory</li>
+
+ 
+4. Hello World
+--------------
+
+- Open up index.html located in phonegap/symbian/framework/www with your favourite editor.

+- In the `body` tag, remove the line `"Build your phonegap app here! Dude!"` and add the
line `<h1>Hello World</h1>`
+- In cygwin/terminal, type make. This will produce phonegap-symbian.wrt/app.wgz. 
+
+
+5A. Deploy to Simulator
+-----------------------
+
+- For Mac or Linux you should install [Aptana Studio](http://www.aptana.org/products/studio2/download)
and [Nokia WRT Plug-in for Aptana Studio](http://www.forum.nokia.com/info/sw.nokia.com/id/00d62bd8-4214-4c86-b608-5f11b94dad54/Nokia_WRT_Plug_in_for_Aptana_Studio.html).
This has a browser-based javascript emulator
+- For Windows you can download the [S60 SDK](http://www.forum.nokia.com/info/sw.nokia.com/id/ec866fab-4b76-49f6-b5a5-af0631419e9c/S60_All_in_One_SDKs.html)
which includes the S60 Emulator
+- Load the phonegap-symbian.wrt/app.wgz file into the emulator.
+
+
+5B. Deploy to Device
+--------------------
+
+- Load the phonegap-symbian.wrt/app.wgz file into the device using bluetooth or email.
+
+
+Done!
+-----
+
+You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/16494780/Getting-Started-with-Phonegap-Nokia-WRT).
+

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/guide/getting-started/webos/index.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/guide/getting-started/webos/index.md b/docs/en/1.6.1/guide/getting-started/webos/index.md
new file mode 100644
index 0000000..8217757
--- /dev/null
+++ b/docs/en/1.6.1/guide/getting-started/webos/index.md
@@ -0,0 +1,59 @@
+Getting Started with WebOS
+==========================
+
+This guide describes how to set up your development environment for Cordova and run a sample
application.  Note that Cordova used to be called PhoneGap, so some of the sites still use
the old PhoneGap name.
+
+Video Tutorials:
+----------------
+
+- [Cordova and HP Palm webOS quick start video](http://www.youtube.com/v/XEnAUbDRZfw?autoplay=1)
+- [How to convert iPhone app to a Palm](http://www.youtube.com/v/wWoJfQw79XI?autoplay=1)
+
+
+1. Requirements
+---------------
+
+- Windows, OS X, or Linux
+
+
+2. Install SDK + Cordova
+----------------------------
+
+- Download and install [Virtual Box](http://www.virtualbox.org/)
+- Download and install [WebOS SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321/)
+- Download and install [cygwin SDK](http://developer.palm.com/index.php?option=com_content&amp;view=article&amp;layout=page&amp;id=1788&amp;Itemid=321)
 (Windows only). Make sure you select "make" as it is not included by default
+- Donwload the latest copy of [Cordova](http://phonegap.com/download) and extract its contents.
We will be working with the Android directory.
+
+
+ 
+3. Setup New Project
+--------------------
+
+- Open up terminal/cygwin and navigate to where you extracted your Cordova Download. Go into
the webOS directory.
+
+
+4. Hello World
+--------------
+
+In phonegap/webOS/framework/www, open up index.html with your favourite editor. After the
body tag add `<h1>Hello World</h1>`
+
+
+5A. Deploy to Simulator
+-----------------------
+
+- Open up your Palm Emulator from your applications folder/start menu.
+- Type `make` in your terminal/cygwin while in the webOS directory.
+
+
+5B. Deploy to Device
+--------------------
+
+- Make sure your device is in [Developer Mode and plug it in.](http://developer.palm.com/index.php?option=com_content&amp;view=article&amp;id=1552&amp;Itemid=59#dev_mode)
+- Type `make` in your terminal/cygwin while in the webOS directory.
+       
+
+Done!
+-----
+
+You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/16494781/Getting-Started-with-PhoneGap-webOS).
+

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/guide/getting-started/windows-phone/index.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/guide/getting-started/windows-phone/index.md b/docs/en/1.6.1/guide/getting-started/windows-phone/index.md
new file mode 100644
index 0000000..971e268
--- /dev/null
+++ b/docs/en/1.6.1/guide/getting-started/windows-phone/index.md
@@ -0,0 +1,77 @@
+Getting Started with Windows Phone
+==================================
+
+This guide describes how to set up your development environment for Cordova and run a sample
application.  Note that Cordova used to be called PhoneGap, so some of the sites still use
the old PhoneGap name.
+
+Video Tutorials:
+----------------
+
+- [Cordova and Windows Phone quick setup video](http://www.youtube.com/v/wO9xdRcNHIM?autoplay=1)
+- [Cordova and Windows Phone deep dive](http://www.youtube.com/v/BJFX1GRUXj8?autoplay=1)
+
+
+1. Requirements
+---------------
+
+- Windows 7 or Windows Vista with SP2
+
+Note: Running in VM has issues, if you are on a Mac, you will need to setup a bootcamp partition
with Windows 7 or Vista
+
+Necessary for Installing on Device and Submitting to Market Place:
+
+- Become an [App Hub member](http://create.msdn.com/en-US/home/membership).
+
+
+2. Install SDK + Cordova
+----------------------------
+
+- Download and install [Windows Phone  SDK](http://www.microsoft.com/download/en/details.aspx?displaylang=en&amp;id=27570/)
+- Donwload the latest copy of [Cordova](http://phonegap.com/download) and extract its contents.
We will be working with the Android directory.
+
+
+3. Setup New Project
+--------------------
+
+- Open Visual Studio Express for Windows Phone and choose **New Project**.
+- Select **CordovaStarter**. ( the version number will be displayed in the template description
)
+- Give your project a name, and select OK.
+
+    ![](img/guide/getting-started/windows-phone/wpnewproj.PNG)
+
+ 
+4. Review the project structure
+-------------------------------
+
+- The 'www' folder contains your Cordova html/js/css and any other resources included in
your app.
+- Any content that you add here needs to be a part of the Visual Studio project, and it must
be set as content. 
+
+    ![](img/guide/getting-started/windows-phone/wp7projectstructure.PNG)
+
+
+5. Build and Deploy to Emulator
+-------------------------------
+
+- Make sure to have **Windows Phone Emulator** selected in the top drop-down menu.
+- Hit the green **play button** beside the Windows Phone Emulator drop-down menu to start
debugging or press F5.
+
+    ![](img/guide/getting-started/windows-phone/wprun.png)
+    ![](img/guide/getting-started/windows-phone/wpfirstrun.PNG)
+
+
+6. Build your project for the device
+------------------------------------
+
+In order to test your application on a device, the device must be registered. Click [here](http://msdn.microsoft.com/en-us/library/gg588378(v=VS.92).aspx)
to read documentation on deploying and testing on your Windows Phone.
+
+- Make sure your phone is connected, and the screen is unlocked
+- In Visual Studio, select 'Windows Phone Device' from the top drop-down menu.
+- Hit the green **play button** beside the drop-down menu to start debugging or press F5.
+
+    ![](img/guide/getting-started/windows-phone/wpd.png)
+
+
+Done!
+-----
+
+You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/48672055/Getting%20Started%20with%20PhoneGap%20Windows%20Phone%207).
+

http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/18d7ea01/docs/en/1.6.1/index.md
----------------------------------------------------------------------
diff --git a/docs/en/1.6.1/index.md b/docs/en/1.6.1/index.md
new file mode 100644
index 0000000..ed23b39
--- /dev/null
+++ b/docs/en/1.6.1/index.md
@@ -0,0 +1,68 @@
+<div id="home">
+    <h1>API Reference</h1>
+    <ul>
+        <li>
+            <h2>Accelerometer</h2>
+            <span>Tap into the device's motion sensor.</span>
+        </li>
+        <li>
+            <h2>Camera</h2>
+            <span>Capture a photo using the device's camera.</span>
+        </li>
+        <li>
+            <h2>Capture</h2>
+            <span>Capture media files using device's media capture applications.</span>
+        </li>
+        <li>
+            <h2>Compass</h2>
+            <span>Obtain the direction that the device is pointing.</span>
+        </li>
+        <li>
+            <h2>Connection</h2>
+            <span>Quickly check the network state, and cellular network information.</span>
+        </li>
+        <li>
+            <h2>Contacts</h2>
+            <span>Work with the devices contact database.</span>
+        </li>
+        <li>
+            <h2>Device</h2>
+            <span>Gather device specific information.</span>
+        </li>
+        <li>
+            <h2>Events</h2>
+            <span>Hook into native events through JavaScript.</span>
+        </li>
+        <li>
+            <h2>File</h2>
+            <span>Hook into native file system through JavaScript.</span>
+        </li>
+        <li>
+            <h2>Geolocation</h2>
+            <span>Make your application location aware.</span>
+        </li>
+        <li>
+            <h2>Media</h2>
+            <span>Record and play back audio files.</span>
+        </li>
+        <li>
+            <h2>Notification</h2>
+            <span>Visual, audible, and tactile device notifications.</span>
+        </li>
+        <li>
+            <h2>Storage</h2>
+            <span>Hook into the devices native storage options.</span>
+        </li>
+    </ul>
+    <h1>Guides</h1>
+    <ul>
+        <li>
+            <h2>Getting Started Guides</h2>
+            <span>Setup each SDK and create your first Cordova app.</span>
+        </li>
+        <li>
+            <h2><a href="_index.html">Keyword Index</a></h2>
+            <span>Full index of the Cordova Documentation.</span>
+        </li>
+    </ul>
+</div>
\ No newline at end of file


Mime
View raw message