cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tim...@apache.org
Subject [2/3] docs commit: added BlackBerry 10
Date Fri, 14 Dec 2012 20:59:57 GMT
added BlackBerry 10


Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/6d2c95b8
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/6d2c95b8
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/6d2c95b8

Branch: refs/heads/master
Commit: 6d2c95b826675abd40b9b54c62d7f1230e7a251e
Parents: cb480fc
Author: Chad Tetreault <ctetreault@rim.com>
Authored: Thu Dec 13 17:26:10 2012 -0500
Committer: Tim Kim <timk@adobe.com>
Committed: Fri Dec 14 12:59:20 2012 -0800

----------------------------------------------------------------------
 .../edge/guide/getting-started/blackberry/index.md |  286 ++++++++++-----
 1 files changed, 185 insertions(+), 101 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6d2c95b8/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 178cba1..20e0435 100644
--- a/docs/en/edge/guide/getting-started/blackberry/index.md
+++ b/docs/en/edge/guide/getting-started/blackberry/index.md
@@ -1,101 +1,185 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
-         or more contributor license agreements.  See the NOTICE file
-         distributed with this work for additional information
-         regarding copyright ownership.  The ASF licenses this file
-         to you under the Apache License, Version 2.0 (the
-         "License"); you may not use this file except in compliance
-         with the License.  You may obtain a copy of the License at
-
-           http://www.apache.org/licenses/LICENSE-2.0
-
-         Unless required by applicable law or agreed to in writing,
-         software distributed under the License is distributed on an
-         "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-         KIND, either express or implied.  See the License for the
-         specific language governing permissions and limitations
-         under the License.
----
-
-Getting Started with 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)
-
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+         or more contributor license agreements.  See the NOTICE file
+         distributed with this work for additional information
+         regarding copyright ownership.  The ASF licenses this file
+         to you under the Apache License, Version 2.0 (the
+         "License"); you may not use this file except in compliance
+         with the License.  You may obtain a copy of the License at
+
+           http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing,
+         software distributed under the License is distributed on an
+         "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+         KIND, either express or implied.  See the License for the
+         specific language governing permissions and limitations
+         under the License.
+---
+
+Getting Started with 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 the following BlackBerry platforms:
+
+* BlackBerry OS 5.0 and higher
+* BlackBerry PlayBook
+* BlackBerry 10 (QNX)
+
+
+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 the WebWorks SDK
+-------------------------
+Download and install the appropriate WebWorks SDKs for your development. BlackBerry 10, BlackBerry
PlayBook, and BlackBerry Smartphone WebWorks SDKs can all be downloaded from the following
locations.  Please note that BlackBerry PlayBook development requires the Adobe Air SDK as
well.
+
+- [BlackBerry 10 (QNX) SDK] (https://developer.blackberry.com/html5/download/#blackberry10)
+- [BlackBerry PlayBook SDK] (https://developer.blackberry.com/html5/download/#playbook) &
[Adobe Air SDK](http://www.adobe.com/devnet/air/air-sdk-download.html)
+- [BlackBerry Smartphones SDK] (https://developer.blackberry.com/html5/download/#smartphones)
+
+
+3.  Register for Signing Keys
+-------------------------
+If you wish to publish your application on BlackBerry App World, or deploy on an actual device
you’ll need to register for a set of free Code Signing Keys.  
+
+To register for Signing Keys visit, and complete the [BlackBerry Keys Order Form](https://www.blackberry.com/SignedKeys).
+
+Once you receive your Signing Keys, they'll need to be setup. To learn how to setup your
Signing Keys visit the [BlackBerry HTML5/WebWorks website](https://developer.blackberry.com/html5/documentation/signing_setup_bb10_apps_2008396_11.html).
+
+
+4.  Install Cordova
+-------------------------
+
+Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents
to your local machine.
+
+
+5.  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
the WebWorks SDKs you are using. For example...
+
+BlackBerry 10 (QNX)
+- `qnx.bbwp.dir=C:\\Program Files (x86)\\Research In Motion\\BlackBerry 10 WebWorks SDK 1.0.2.9`
+
+BlackBerry PlayBook
+- `playbook.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks SDK for TabletOS
2.1.0.6\\bbwp`
+
+BlackBerry Smartphone (OS5-7)
+- `blackberry.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks Packager`
+
+
+6.  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 `qnx` `playbook` or
`blackberry`. For example...
+
+BlackBerry 10 (QNX)
+- `ant qnx build`
+
+BlackBerry PlayBook
+- `ant playbook build`
+
+BlackBerry Smartphone (OS5-7)
+- `ant blackberry build`
+
+
+7A.  Deploy to Simulator
+--------------------------------------
+
+BlackBerry smartphone simulators are only available on Windows. BlackBerry 10, and 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).
+
+For instructions on installing simulators, please visit the following link(s):
+- [BlackBerry 10](https://developer.blackberry.com/html5/documentation/using_the_bb10_simulator_2008466_11.html)
+- [BlackBerry PlayBook](https://developer.blackberry.com/html5/documentation/using_the_tablet_simulator_1866980_11.html)
+- [BlackBerry Smartphone](https://developer.blackberry.com/html5/documentation/run_your_app_on_smartphone_sim_1876976_11.html)
+
+- Open the project.properties file with your favorite editor and customize the following
properties.
+    
+BlackBerry 10
+- `qnx.sim.ip`
+- `qnx.sim.password`
+- Note: IP address of simulator obtained when placing the simulator in developer mode through
simulator security settings. Simulator password can be set through simulator security settings.
+
+Playbook
+- `playbook.sim.ip` : 
+- `playbook.sim.password`
+- Note: IP address of simulator obtained when placing the simulator in developer mode through
simulator security settings. Simulator password can be set through simulator security settings.
+
+Smartphone (Optional)
+- `blackberry.sim.dir` 
+- `blackberry.sim.bin`
+- Note: On windows file separator '\' must be escaped when specifying directories.  For example
`C:\\Program Files\\BlackBerry\\Simulator`.  
+
+While in your project directory, in command prompt/terminal type `ant target load-simulator`.
Replace `target` with either `qnx`, `playbook`, or `blackberry`. Note, for BlackBerry 10 and
PlayBook, the simulator virtual image must already be started.  For example...
+
+BlackBerry 10 (QNX)
+- `ant qnx load-simulator`
+
+BlackBerry PlayBook
+- `ant playbook load-simulator`
+
+BlackBerry Smartphone (OS5-7)
+- `ant blackberry load-simulator`
+
+The application will be installed to the home screen of the simulator. Note, on BlackBerry
OS 5 the application is installed in the Downloads folder.
+
+
+7B.  Deploy to Device (Windows and Mac)
+--------------------------------------
+
+To deploy your app to a device you must have registered for, and setup BlackBerry Code Signing
Keys.  See section 3 for details. Also, to deploy apps on BlackBerry 10 or PlayBook, the device
must be set to Development Mode which can be enabled from the Settings > Security menu.
+
+- Open the project.properties file with your favorite editor and customize the following
properties:
+
+BlackBerry 10 (QNX)
+- `qnx.sigtool.password`
+- `qnx.device.ip`
+- `qnx.device.password`
+
+BlackBerry PlayBook
+- `playbook.sigtool.csk.password`
+- `playbook.sigtool.p12.password`
+- `playbook.device.ip`
+- `playbook.device.password`
+
+BlackBerry Smartphone (OS5-7)
+- Smartphone (Optional)
+- `blackberry.sigtool.password`
+
+While in your project directory, in command prompt/terminal type `ant target load-device`.
Replace `target` with either `qnx`, `playbook`, or `blackberry`.  For example...
+
+BlackBerry 10 (QNX)
+- `ant qnx load-device`
+
+BlackBerry PlayBook
+- `ant playbook load-device`
+
+BlackBerry Smartphone (OS5-7)
+- `ant blackberry load-device`
+
+The application will be installed to the home screen of 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.blackberrycom/html5/documentation/ww_developing/bestpractice_compiling_ww_apps_1873324_11.html)


Mime
View raw message