cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwbro...@apache.org
Subject [10/15] docs commit: [CB-4347 CB-3962 CB-3822] minor stylesheet fixes & reformat
Date Wed, 31 Jul 2013 20:01:05 GMT
[CB-4347 CB-3962 CB-3822] minor stylesheet fixes & reformat


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

Branch: refs/heads/master
Commit: 65e1372593a4e0d3a84d8c4611ae1d30aea0e339
Parents: 2fa779a
Author: Mike Sierra <letmespellitoutforyou@gmail.com>
Authored: Wed Jul 31 13:06:29 2013 -0400
Committer: Michael Brooks <michael@michaelbrooks.ca>
Committed: Wed Jul 31 13:00:07 2013 -0700

----------------------------------------------------------------------
 .../edge/guide/platforms/blackberry10/index.md  | 115 ++++++++++++-------
 1 file changed, 73 insertions(+), 42 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/65e13725/docs/en/edge/guide/platforms/blackberry10/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry10/index.md b/docs/en/edge/guide/platforms/blackberry10/index.md
index 7695c8d..2eb91b4 100644
--- a/docs/en/edge/guide/platforms/blackberry10/index.md
+++ b/docs/en/edge/guide/platforms/blackberry10/index.md
@@ -19,55 +19,65 @@ license: Licensed to the Apache Software Foundation (ASF) under one
 
 # BlackBerry 10 Platform Guide
 
-This guide shows how to set up your development environment to build and deploy Cordova apps
for BlackBerry 10 devices.
-
-For previous versions of BlackBerry, you need to use a different set of command-line tools,
described in BlackBerry Platform Guide.
+This guide shows how to set up your development environment to build
+and deploy Cordova apps for BlackBerry 10 devices.  For previous
+versions of BlackBerry, you need to use a different set of
+command-line tools, described in BlackBerry Platform Guide.
 
 ## Requirements
 
 The development environment is available on Windows, Mac and Linux.
 
-Developers should use the `cordova` utility in conjunction with the Blackberry Native SDK.
 See The Command-line Interface for information how to install `cordova`, add projects, then
build and deploy.
+Developers should use the `cordova` utility in conjunction with the
+Blackberry Native SDK.  See The Command-line Interface for information
+how to install `cordova`, add projects, then build and deploy for each
+platform.
 
 ## Install the BlackBerry Native SDK
 
-The BlackBerry Native SDK is available from [developer.blackberry.com](http://developer.blackberry.com/native/download/).
-
-After installing the BlackBerry Native SDK, its tools must be added to your system path.
+The BlackBerry Native SDK is available from
+[developer.blackberry.com](http://developer.blackberry.com/native/download/).
+Following installation, you need to add its command-line tools to your
+system path.
 
-### Windows
+On Windows:
 
-Go to My Computer &rarr; Properties &rarr; Advanced &rarr; Environment Variables
+* Go to __My Computer &rarr; Properties &rarr; Advanced &rarr; Environment Variables__.
 
-Append to PATH based on where you installed the Native SDK, for example:
+* Append the Native SDK's install directory to the PATH, for example:
 
     ;C:\bbndk\host_10_1_0_132\darwin\x86\usr\bin\
 
-### Mac/Linux
+On Mac and Linux:
 
-Edit the ~/.bash_profile file, adding a line such as the following, depending on where the
Native SDK was installed:
+* Edit the `~/.bash_profile` file, adding a line such as the
+  following, depending on where the Native SDK was installed:
 
     $ export PATH=${PATH}:/Applications/bbndk/host_10_1_0_132/darwin/x86/usr/bin/
 
-Then run the following to apply the change immidiately:
+* Run the following to apply the change in the current session:
 
     $ source ~/.bash_profile
 
 ## Set up for Signing
 
-If you wish to test on a device or distribute apps through BlackBerry World, your system
must be setup for code signing.
+If you wish to test on a device or distribute apps through BlackBerry
+World, your system must be setup for code signing.
 
-To obtain a signing key, go to the BlackBerry website and make sure to retain the password
you specify. Then run the `blackberry-signer` utility that is included with the BlackBerry
Native SDK.
+To obtain a signing key, go to the BlackBerry website and make sure to
+retain the password you specify. Then run the `blackberry-signer`
+utility that is included with the BlackBerry Native SDK.
 
 Detailed instuctions can be found here:
 
 * [Register for your code signing key.](https://www.blackberry.com/SignedKeys/codesigning.html)
+
 * [Set up your system for code signing.](https://developer.blackberry.com/html5/documentation/signing_setup_bb10_apps_2008396_11.html)
 
 ## Create a Project
 
-Use the `cordova` utility to set up a new project, as described in The Command-line Interface.
For example, in a source-code
-directory:
+Use the `cordova` utility to set up a new project, as described in The
+Command-line Interface. For example, in a source-code directory:
  
     $ cordova create hello com.example.hello
     $ cd hello
@@ -76,28 +86,36 @@ directory:
 
 ## Deploy to Emulator
 
-If you wish to run a device emulator, download and install the BlackBerry 10 Simulator.
+If you wish to run a device emulator, download and install the
+BlackBerry 10 Simulator.
 
 * [Download](http://developer.blackberry.com/native/download/)
 * [Getting Started](http://developer.blackberry.com/devzone/develop/simulator/blackberry_10_simulator_start.html)
 
-Before testing an app on either an emulator or a device, you need to add a _target_ to your
project. Each is identified with a unique name, and associated with an IP address. You need
to get the IP address from the emulator before you use it to view apps.
+Before testing an app on either an emulator or a device, you need to
+add a _target_ to your project. Each is identified with a unique name,
+and associated with an IP address. You need to get the IP address from
+the emulator before you use it to view apps.
 
 Launch the emulator image, then choose __Settings__ from the home screen:
 
 ![](img/guide/platforms/blackberry10/bb_home.png)
 
-Navigate to the __Security and Privacy &rarr; Development Mode__ section, enable the
option, and obtain the IP address:
+Navigate to the __Security and Privacy &rarr; Development Mode__
+section, enable the option, and obtain the IP address:
 
 ![](img/guide/platforms/blackberry10/bb_devel.png)
 
-An additional set of command-line utilities are included when you set up the BlackBerry 10
platform for your project.  The following command, in this case invoked from the project top-level
directory, associates a target named _emu_ with the IP address displayed above.
+An additional set of command-line utilities are included when you set
+up the BlackBerry 10 platform for your project.  The following
+command, in this case invoked from the project top-level directory,
+associates a target named _emu_ with the IP address displayed above.
 
-Windows
+* On Windows:
 
     $ platforms\blackberry10\cordova\target.bat add emu 169.254.0.1 -t simulator
 
-Mac/Linux
+* On Mac/Linux:
 
     $ platforms/blackberry10/cordova/target add emu 169.254.0.1 -t simulator
 
@@ -107,58 +125,71 @@ Then, run the `emulate` command to view the app:
 
 ## Deploy to Device
 
-To deploy to a device, make sure it is plugged into your computer. Enable development mode
and obtain the IP address as desribed in the emulator section above. You will also need to
obtain the PIN from the the __Settings__ application under __About &rarr; Hardware__.
+To deploy to a device, make sure it is plugged into your computer.
+Enable development mode and obtain the IP address as desribed in the
+emulator section above. You will also need to obtain the PIN from the
+the __Settings__ application under __About &rarr; Hardware__:
 
 ![](img/guide/platforms/blackberry10/bb_pin.png)
 
-Run the target command-line utility to associate a name with an IP address, device password
and PIN.
+Run the target command-line utility to associate a name with an IP
+address, device password and PIN.
 
-Windows
+* On Windows:
 
     $ platforms\blackberry10\cordova\target.bat add mydevice 169.254.0.1 -t device --password
123456 --pin FFFF972E
 
-Mac/Linux
+* On Mac/Linux:
 
     $ platforms/blackberry10/cordova/target add mydevice 169.254.0.1 -t device --password
123456 --pin FFFF972E
 
---password refers to the password to unlock the device
+where:
 
---pin refers to the device PIN obtained from the Settings application
+* `--password` refers to the password to unlock the device.
+
+* `--pin` refers to the device PIN obtained from the __Settings__ application.
 
 Then, run the `run` command to view the app:
 
     $ cordova run blackberry10
 
-If a debug token has not yet been created for this device, an error message will prompt you
to use the platform run script with the password you provided when registering for signing
keys.
+If a debug token is not yet set up for the device, an error message
+prompts you to use the platform run script with the password you
+provided when registering for signing keys.
 
-Windows
+* On Windows:
 
     $ platforms\blackberry10\cordova\run.bat --device --keystorepass mysecret
 
-Mac/Linux
+* On Mac/Linux:
 
     $ platforms/blackberry10/cordova/run --device --keystorepass mysecret
 
 ## Debugging with WebInspector
 
-When debugging on the device or a simulator, you may run WebInspector remotely to view the
application's internal state.
-
-A prompt displays the URL that allows you to connect to your app with a standard web browser.
-
-For more information, see [Debugging using WebInspector](http://developer.blackberry.com/html5/documentation/web_inspector_overview_1553586_11.html).
+When debugging on the device or an emulator, you may run WebInspector
+remotely to view the application's internal state.  A prompt displays
+the URL that allows you to connect to your app with a standard web
+browser.  For more information, see
+[Debugging using WebInspector](http://developer.blackberry.com/html5/documentation/web_inspector_overview_1553586_11.html).
 
 ## Building a Release Version
 
-By default, running the `cordova build` command creates an unsigned _.bar_ package file suitable
for testing on a device or simulator.
+By default, running the `cordova build` command creates an unsigned
+_.bar_ package file suitable for testing on a device or simulator.
 
-You need to run a different `build` command to create a release version suitable for distribution
through BlackBerry World.  This command uses the following syntax:
+You need to run a different `build` command to create a release
+version suitable for distribution through BlackBerry World.  It does
+not rely on the `cordova` CLI tool, and instead uses the following
+syntax:
 
-Windows
+* On Windows:
 
     $ platforms\blackberry10\cordova\build.bat --release --keystorepass mysecret
 
-Mac/Linux
+* On Mac/Linux:
 
     $ platforms/blackberry10/cordova/build --release --keystorepass mysecret
 
---keystorepass specifies the password you defined when you configured your computer to sign
applications.
+The `--keystorepass` option specifies the password you defined when
+configuring your computer to sign applications.


Mime
View raw message