You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by de...@apache.org on 2012/03/30 16:38:46 UTC
docs commit: Update BlackBerry getting started for 1.6.
Updated Branches:
refs/heads/master 63837941d -> e9bc0ff24
Update BlackBerry getting started for 1.6.
Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/commit/e9bc0ff2
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/e9bc0ff2
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/e9bc0ff2
Branch: refs/heads/master
Commit: e9bc0ff249f71cea372643d1e016aacf2431faa7
Parents: 6383794
Author: Drew Walters <de...@apache.org>
Authored: Fri Mar 30 09:38:22 2012 -0500
Committer: Drew Walters <de...@apache.org>
Committed: Fri Mar 30 09:38:22 2012 -0500
----------------------------------------------------------------------
.../edge/guide/getting-started/blackberry/index.md | 107 +++++++++------
1 files changed, 62 insertions(+), 45 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e9bc0ff2/docs/en/edge/guide/getting-started/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/blackberry/index.md b/docs/en/edge/guide/getting-started/blackberry/index.md
index a6f887e..cf4d131 100644
--- a/docs/en/edge/guide/getting-started/blackberry/index.md
+++ b/docs/en/edge/guide/getting-started/blackberry/index.md
@@ -1,65 +1,82 @@
Getting Started with Blackberry
============================
-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.
+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.
-
-Video Tutorials:
-----------------
-
-- [Cordova and BlackBerry Widgets Quick Start Video](http://www.youtube.com/v/eF0h0K0OLwI?autoplay=1)
-
-
-
-1. Requirements
+1. Requirements
---------------
- Windows XP (32-bit) or Windows 7 (32-bit and 64-bit) or Mac OSX 10.6.4+
-
-For 4.x devices check out [this guide](http://wiki.phonegap.com/w/page/25653281/Getting%20Started%20with%20PhoneGap-BlackBerry%20with%20the%20Latest%20Environment).
-
-
-2. Install SDK + Cordova
-------------------------
-
-- (Windows Only) Download and install [SUN JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html#jdk) (32-Bit Version). Add it to your PATH variable.
-- (Windows Only) Download and extract [Apache Ant](http://ant.apache.org/bindownload.cgi). Add it to your PATH variable.
-- Download [BlackBerry WebWorks Smartphone SDK](ttps://bdsc.webapps.blackberry.com/html5/download/sdk) for BlackBerry development and/or [BlackBerry WebWorks Tablet OS SDK](https://bdsc.webapps.blackberry.com/html5/download/sdk) for Playbook development. Keep note of the directories you install these SDKs.
-- 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
+- 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. CD into the Cordova BlackBerry directory.
-- Create a Cordova BlackBerry and PlayBook project. Type 'ant create -Dproject.path='followed by the location you wish to create your project into the command prompt/terminal.
-- Change to the newly created directory located at `C:\Dev\bbw\sample`.
-- Open up the project.properties file with your favourite editor and change the lines `BlackBerry.bbwp.dir=` and `PlayBook.bbwp.dir=` to equal the respective install locations of the SDKs you downloaded earlier.
-
+- 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
+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 the target with either blackberry or playbook. Note this is the sample Cordova project and not a basic hello world application. You can go edit the index.html file located in the www directory of your project to make it say Hello World if you wish.
+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 (Windows Only)
+5A. Deploy to Simulator
--------------------------------------
-- While in your project directory, in command prompt/terminal type `ant target load-simulator`. Replace the target with either blackberry or playbook.
-- Press the BlackBerry button on the simulator, go to downloads and you should see your app loaded there.
+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)
+5B. Deploy to Device (Windows and Mac)
--------------------------------------
-- You have to have your signing keys from RIM by filling out this [form](https://www.blackberry.com/SignedKeys/).
-- While in your project directory, in command prompt/terminal type `ant target load-device`. Replace the target with either blackberry or playbook.
-- Press the BlackBerry button on the simulator, go to downloads and you should see your app loaded there.
-
-
-Done!
------
-
-You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/31930982/Getting-Started-with-PhoneGap-BlackBerry-WebWorks).
+- 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)