You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/08/02 00:11:38 UTC
[4/6] Update 3.0.0 from edge directory.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/cli/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/cli/index.md b/docs/en/3.0.0/guide/cli/index.md
index 1f94040..7d4c42f 100644
--- a/docs/en/3.0.0/guide/cli/index.md
+++ b/docs/en/3.0.0/guide/cli/index.md
@@ -39,7 +39,7 @@ platform's SDK. The CLI supports the following combinations:
* iOS (Mac)
* Android (Mac, Linux)
-* BlackBerry (Mac, Windows)
+* BlackBerry 10 (Mac, Linux, Windows)
* Windows Phone 7 (Windows)
* Windows Phone 8 (Windows)
@@ -72,9 +72,12 @@ To install the `cordova` command-line tool, follow these steps:
Go to the directory where you maintain your source code, and run a
command such as the following:
- $ cordova create HelloWorld com.example.hello "HelloWorld"
+ $ cordova create hello com.example.hello HelloWorld
-The first argument specifies a _HelloWorld_ directory to be generated
+It may take some time for the command to complete, so be patient. Run
+the `cordova -d` to see information about progress.
+
+The first argument specifies a _hello_ directory to be generated
for your project. Its `www` subdirectory houses your application's
home page, along with various resources under `css`, `js`, and `img`,
which follow common web development file-naming conventions. The
@@ -83,7 +86,7 @@ distribute the application.
The other two arguments are optional: the `com.example.hello` argument
provides your project with a reverse domain-style identifier, and the
-`"HelloWorld!"` provides the application's display text. You can edit
+`HelloWorld` provides the application's display text. You can edit
both of these values later in the `config.xml` file.
## Add Platforms
@@ -91,7 +94,7 @@ both of these values later in the `config.xml` file.
All subsequent commands need to be run within the project's directory,
or any subdirectories within its scope:
- $ cd HelloWorld
+ $ cd hello
Before you can build the project, you need to specify a set of target
platforms. Your ability to run these commands depends on whether your
@@ -146,7 +149,7 @@ Edit this application however you want, but any initialization should
be specified as part of the `deviceready` event handler, referenced by
default from `www/js/index.js`.
<!-- XREF
-(See Application Development Guide for details.)
+(See the Application Development Guide for details.)
XREF -->
Run the following command to iteratively build the project:
@@ -170,7 +173,7 @@ an alternative to modify and compile the platform-specific code that
Cordova generates within `platforms/ios`. You can use the same
approach with other platforms' SDKs.
-## View the App in an Emulator
+## Test the App on an Emulator or Device
SDKs for mobile platforms often come bundled with emulators that
execute a device image, so that you can launch the app from the home
@@ -196,6 +199,18 @@ launch from the home screen:
+Alternately, you can plug the handset into your computer and test the
+app directly:
+
+ $ cordova run android
+
+Before running this command, you need to set up the device for
+testing, following procedures that vary for each platform. In
+Android's case, you would have to enable a __USB debugging__ option on
+the device, and perhaps add a USB driver depending on your development
+environmnent.
+See Platform Guides for details on each platform's requirements.
+
## Add Features
When you build and view a new project, the default application that
@@ -218,59 +233,114 @@ The `cordova plugin add` command requires you to specify the
repository for the plugin code. Here are examples of features you
might add:
-* Basic device information:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git
-* Network and battery status:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git
-* Accelerometer, compass, and geolocation:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
-* Camera, media capture, and media playback:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git
-* Access files on device or network:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer.git
-* Notifications via dialog box or vibration:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git
+* Basic device information (Device API):
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git
+
+* Network Connection and Battery Events:
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git
+
+* Accelerometer, Compass, and Geolocation:
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
+
+* Camera, Media playback and Capture:
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git
+
+* Access files on device or network (File API):
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer.git
+
+* Notification via dialog box or vibration:
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git
+
* Contacts:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git
+
* Globalization:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git
-* Splash Screen:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git
-* In-app browser:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git
+
+* Splashscreen:
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git
+
+* Open new browser windows (InAppBrowser):
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git
+
* Debug console:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-console.git
-Use `plugin ls` (or `plugin list`) to view currently installed
-plugins. Each displays by its identifier:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-console.git
- $ cordova plugin ls # or 'plugin list'
- [ 'org.apache.cordova.core.console' ]
+Use `plugin ls` (or `plugin list`, or `plugin` by itself) to view
+currently installed plugins. Each displays by its identifier:
+
+ $ cordova plugin ls # or 'plugin list'
+ [ 'org.apache.cordova.core.console' ]
To remove a plugin, refer to it by the same identifier that appears in
the listing. For example, here is how you would remove support for a
debug console from a release version:
- $ cordova plugin rm org.apache.cordova.core.console
- $ cordova plugin remove org.apache.cordova.core.console # same
+ $ cordova plugin rm org.apache.cordova.core.console
+ $ cordova plugin remove org.apache.cordova.core.console # same
You can batch-remove or add plugins by specifying more than one
argument for each command.
-<!--
+## Customize Each Platform
+
+While Cordova allows you to easily deploy an app for many different
+platforms, sometimes you need to add customizations. In that case,
+you don't want to modify the source files in various `www` directories
+within the top-level `platforms` directory, because they're regularly
+replaced with the top-level `www` directory's cross-platform source.
+
+Instead, the top-level `merges` directory offers a place to specify
+assets to deploy on specific platforms. Each platform-specific
+subdirectory within `merges` mirrors the directory structure of the
+`www` source tree, allowing you to override or add files as needed.
+For example, here is how you might uses `merges` to boost the default
+font size for Android devices:
+
+* Edit the `www/index.html` file, adding a link to an additional CSS
+ file, `overrides.css` in this case:
+
+ <link rel="stylesheet" type="text/css" href="css/overrides.css" />
+
+* Optionally create an empty `www/css/overrides.css` file, which would
+ apply for all non-Android builds, preventing a missing-file error.
+
+* Create a `css` subdirectory within `merges/android`, then add a
+ corresponding `overrides.css` file. Specify CSS that overrides the
+ 12-point default font size specified within `www/css/index.css`, for
+ example:
+
+ body { font-size:14px; }
-## Run the App on the Device
+When you rebuild the project, the Android version features the custom
+font size, while others remain unchanged.
--->
+You can also use `merges` to add files not present in the original
+`www` directory. For example, an app can incorporate a _back button_
+graphic into the iOS interface, stored in
+`merges/ios/img/back_button.png`, while the Android version can
+instead capture `backbutton` events from the corresponding hardware
+button.
-## Update the App
+## Updating Cordova
After installing installing the `cordova` utility, you can always
update it to the latest version by running the following command:
@@ -279,10 +349,19 @@ update it to the latest version by running the following command:
Use this syntax to install a specific version:
- $ sudo npm install -g cordova@2.8.0
+ $ sudo npm install -g cordova@3.0.0
-Run the `info` command for a listing that includes the current version
+Run `cordova -v` to see the currently running version. Run the `npm
+info` command for a longer listing that includes the current version
along with other available version numbers:
$ npm info cordova
+Cordova 3.0 is the first version to support the command-line interface
+described in this section. If you are updating from a version prior to
+3.0, you need to create a new project as described above, then copy
+the older application's assets into the top-level `www` directory.
+Where applicable, further details about upgrading to 3.0 are available
+in the Platform Guides. Once you upgrade to the `cordova`
+command-line interface and use `npm update` to stay current, the more
+time-consuming procedures described there are no longer relevant.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/hybrid/plugins/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/hybrid/plugins/index.md b/docs/en/3.0.0/guide/hybrid/plugins/index.md
index 64896fd..cb4d01b 100644
--- a/docs/en/3.0.0/guide/hybrid/plugins/index.md
+++ b/docs/en/3.0.0/guide/hybrid/plugins/index.md
@@ -44,44 +44,48 @@ front-facing and arguably most important part of your Cordova plugin.
You can structure your plugin's JavaScript however you like. The one
thing you _must_ use to communicate between the Cordova JavaScript
- and native environments is the `cordova.exec` function. Here is an example:
+and native environments is the `cordova.exec` function. Here is an example:
- cordova.exec(function(winParam) {}, function(error) {}, "service",
- "action", ["firstArgument", "secondArgument", 42,
- false]);
+ cordova.exec(function(winParam) {}, function(error) {}, "service",
+ "action", ["firstArgument", "secondArgument", 42,
+ false]);
The parameters are detailed below:
-1. `function(winParam) {}` - Success function callback. Assuming your
- `exec` call completes successfully, this function is invoked
- (optionally with any parameters you pass back to it).
-2. `function(error) {}` - Error function callback. If the operation does
- not complete successfully, this function is invoked (optionally
- with an error parameter).
-3. `"service"` - The service name to call into on the native side. This
- is mapped to a native class, about which more information is
- available in the native guides listed below.
-4. `"action"` - The action name to call into. This is picked up by the
- native class receiving the `exec` call, and, depending on the
- platform, essentially maps to a class's method.
- The native guides listed below provide details.
-5. `[/* arguments */]` - Arguments to pass into the native environment.
+* `function(winParam) {}`: Success function callback. Assuming your
+ `exec` call completes successfully, this function is invoked
+ (optionally with any parameters you pass back to it).
+
+* `function(error) {}`: Error function callback. If the operation does
+ not complete successfully, this function is invoked (optionally with
+ an error parameter).
+
+* `"service"`: The service name to call into on the native side. This
+ is mapped to a native class, about which more information is
+ available in the native guides listed below.
+
+* `"action"`: The action name to call into. This is picked up by the
+ native class receiving the `exec` call, and, depending on the
+ platform, essentially maps to a class's method. The native guides
+ listed below provide details.
+
+* `[/* arguments */]`: Arguments to pass into the native environment.
### Echo Plugin JavaScript Example
- window.echo = function(str, callback) {
- cordova.exec(callback, function(err) {
- callback('Nothing to echo.');
- }, "Echo", "echo", [str]);
- };
+ window.echo = function(str, callback) {
+ cordova.exec(callback, function(err) {
+ callback('Nothing to echo.');
+ }, "Echo", "echo", [str]);
+ };
Let's dive into this. The plugin attaches itself to `window`,
specifically to the `echo` function. Plugin users would then use it as
follows:
- window.echo("echome", function(echoValue) {
- alert(echoValue == "echome"); // should alert true.
- });
+ window.echo("echome", function(echoValue) {
+ alert(echoValue == "echome"); // should alert true.
+ });
First, let's take a look at the last three arguments to the `exec`
function. We will be calling the `Echo` "service", requesting the `echo`
@@ -100,7 +104,7 @@ Cordova has a plugin specification available to enable automated
installation of the plugin for Android, iOS, BlackBerry 10 and Windows
Phone platforms. By structuring your plugin in a particular way and
adding a `plugin.xml` manifest file, you can enable users to install
-your plugin via the command line tooling.
+your plugin via the command-line tooling.
- Plugin Specification
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/overview/index.md b/docs/en/3.0.0/guide/overview/index.md
index 195c84e..c6b7b83 100644
--- a/docs/en/3.0.0/guide/overview/index.md
+++ b/docs/en/3.0.0/guide/overview/index.md
@@ -38,7 +38,7 @@ Use Cordova if you are:
* a mobile developer interested in mixing native application
components with a _WebView_ (browser window) that can access
- device-level APIs, or if you want to develop a plug-in interface
+ device-level APIs, or if you want to develop a plugin interface
between native and WebView components.
## Basic Components
@@ -58,14 +58,14 @@ which you distribute to app stores. For the web app to interact with
various device features the way native apps do, it must also reference
a `cordova.js` file, which provides API bindings.
<!-- XREF
-(See the API Reference for an overview, and the API and Configuration
-Guide for examples of how to use them.)
+(See the API Reference for an overview, and the Application
+Development Guide for examples of how to use them.)
XREF -->
The Cordova-enabled WebView may provide the application with its
entire user interface. It can also be a component within a larger,
hybrid application that mixes the WebView with native application
-components. Cordova provides a _plug-in_ interface for these
+components. Cordova provides a _plugin_ interface for these
components to communicate with each other.
## Development Paths
@@ -136,64 +136,46 @@ available for each mobile platform:
<th>Windows<br/>Phone 7</th>
<th>Windows<br/>Phone 8</th>
<th>Windows<br/>8</th>
+ <th>Tizen</th>
</tr>
</thead>
<tbody>
<tr>
- <th><a href="#">cordova<br/>CLI</a></th>
+ <th><a href="guide_cli_index.md.html">cordova<br/>CLI</a></th>
<td data-col="android" class="y">Mac, Windows, Linux</td>
- <td data-col="blackberry" class="y">Mac, Windows</td>
+ <td data-col="blackberry" class="n">Mac, Windows</td>
<td data-col="blackberry10" class="y">Mac, Windows</td>
<td data-col="ios" class="y">Mac</td>
<td data-col="winphone7" class="y">Windows</td>
<td data-col="winphone8" class="y">Windows</td>
- <td data-col="win8" class="u"></td>
- </tr>
-
- <tr>
- <th><a href="#">PhoneGap<br/>Build</a></th>
- <td data-col="android" class="y"></td>
- <td data-col="blackberry" class="y"></td>
- <td data-col="blackberry10" class="y"></td>
- <td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="u"></td>
- <td data-col="winphone8" class="y"></td>
- <td data-col="win8" class="u"></td>
- </tr>
-
- <tr>
- <th><a href="guide_platforms_index.md.html">SDK platform support</a></th>
- <td data-col="android" class="y"><a href="guide_platforms_android_index.md.html"> </a></td>
- <td data-col="blackberry" class="y"><a href="guide_platforms_blackberry_index.md.html"> </a></td>
- <td data-col="blackberry10" class="y"><a href="guide_platforms_blackberry10_index.md.html"> </a></td>
- <td data-col="ios" class="y"><a href="guide_platforms_ios_index.md.html"> </a></td>
- <td data-col="winphone7" class="y"><a href="guide_platforms_wp7_index.md.html"> </a></td>
- <td data-col="winphone8" class="y"><a href="guide_platforms_windows-phone-8_index.md.html"> </a></td>
- <td data-col="win8" class="y"><a href="guide_platforms_windows-8_index.md.html"> </a></td>
+ <td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
- <th><a href="#">Embedded<br/>WebView</a></th>
- <td data-col="android" class="y"><a href="guide_platforms_android_webview.md.html"></a></td>
+ <th><a href="guide_hybrid_webviews_index.md.html">Embedded<br/>WebView</a></th>
+ <td data-col="android" class="y"><a href="guide_platforms_android_webview.md.html">(see details)</a></td>
<td data-col="blackberry" class="n"></td>
<td data-col="blackberry10" class="n"></td>
- <td data-col="ios" class="y"><a href="guide_platforms_ios_webview.md.html"></a></td>
+ <td data-col="ios" class="y"><a href="guide_platforms_ios_webview.md.html">(see details)</a></td>
<td data-col="winphone7" class="n"></td>
<td data-col="winphone8" class="n"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
- <th><a href="guide_plugin-development_index.md.html">Plug-in<br/>Interface</a></th>
- <td data-col="android" class="y"><a href="guide_guide_platforms_android_plugin.md.html"></a></td>
- <td data-col="blackberry" class="y"><a href="guide_guide_platforms_blackberry_plugin.md.html"></a></td>
- <td data-col="blackberry10" class="y"><a href="guide_guide_platforms_blackberry10_plugin.md.html"></a></td>
- <td data-col="ios" class="y"><a href="guide_guide_platforms_ios_plugin.md.html"></a></td>
- <td data-col="winphone7" class="y"><a href="guide_guide_platforms_wp8_plugin.md.html"></a></td>
- <td data-col="winphone8" class="n"></td>
+ <th><a href="guide_hybrid_plugins_index.md.html">Plug-in<br/>Interface</a></th>
+ <td data-col="android" class="y"><a href="guide_guide_platforms_android_plugin.md.html">(see details)</a></td>
+ <td data-col="blackberry" class="y"><a href="guide_guide_platforms_blackberry_plugin.md.html">(see details)</a></td>
+ <td data-col="blackberry10" class="y"><a href="guide_guide_platforms_blackberry10_plugin.md.html">(see details)</a></td>
+ <td data-col="ios" class="y"><a href="guide_guide_platforms_ios_plugin.md.html">(see details)</a></td>
+ <td data-col="winphone7" class="y"><a href="guide_guide_platforms_wp8_plugin.md.html">(see details)</a></td>
+ <td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
@@ -210,6 +192,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -221,6 +204,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -232,17 +216,19 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
<th><a href="cordova_compass_compass.md.html">Compass</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="n"></td>
- <td data-col="blackberry10" class="n"></td>
+ <td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y">(3GS+)</td>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -254,6 +240,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -265,6 +252,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
@@ -276,6 +264,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -287,6 +276,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -295,9 +285,10 @@ available for each mobile platform:
<td data-col="blackberry" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="y"></td>
- <td data-col="winphone8" class="y"></td>
+ <td data-col="winphone7" class="p">(no FileTransfer)</td>
+ <td data-col="winphone8" class="p">(no FileTransfer)</td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
@@ -309,17 +300,19 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_globalization_globalization.md.html">Globalization</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="y"></td>
- <td data-col="blackberry10" class="y"></td>
+ <td data-col="blackberry10" class="n"></td>
<td data-col="ios" class="y"></td>
<td data-col="winphone7" class="n"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
@@ -330,18 +323,20 @@ available for each mobile platform:
<td data-col="ios" class="y"></td>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
- <td data-col="win8" class="y"></td>
+ <td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
<th><a href="cordova_media_media.md.html">Media</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="n"></td>
- <td data-col="blackberry10" class="n"></td>
+ <td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -353,17 +348,19 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_splashscreen_splashscreen.md.html">Splashscreen</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="n"></td>
- <td data-col="blackberry10" class="n"></td>
+ <td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="n"></td>
- <td data-col="winphone8" class="n"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
@@ -372,9 +369,10 @@ available for each mobile platform:
<td data-col="blackberry" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="y"></td>
- <td data-col="winphone8" class="y"></td>
+ <td data-col="winphone7" class="p">localStorage only</td>
+ <td data-col="winphone8" class="p">localStorage only</td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
</tbody>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/config.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/config.md b/docs/en/3.0.0/guide/platforms/android/config.md
index 00a1ecd..d3e710c 100644
--- a/docs/en/3.0.0/guide/platforms/android/config.md
+++ b/docs/en/3.0.0/guide/platforms/android/config.md
@@ -19,22 +19,47 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Android Configuration
-The `config.xml` settings file controls various settings of Cordova. This is application wide, and not set per CordovaWebView Instance.
+The `config.xml` file controls various Cordova settings. These apply
+across the application, and per CordovaWebView instance.
-## <preference>
+## `<preference>`
-Various **other** preferences (as **<preference>** tags) default on not breaking existing apps. The available preferences are:
+Various other preferences (as `<preference>` tags) default on not
+breaking existing apps. The available preferences are:
-1. **useBrowserHistory (boolean, defaults to true)** - set to false if you want to use the history shim that was used to work around the hashtag error present in Android 3.x prior to the history fix. (Note: This setting will be deprecated in April 2013)
-2. **loadingDialog** - Display a native loading dialog when loading the app. The value's format is _Title, Message_
-3. **loadingPageDialog** - Display a native loading dialog when loading sub-pages. The value's format is _Title, Message_
-4. **errorUrl** - Set the error page for your application. Should be located in your Android project in file://android_asset/www/
-5. **backgroundColor** - Set the background color for your application. Supports a four-byte hex value, with the first byte representing alpha value, and the following three bytes with standard RGB values. (i.e. 0x00000000 = Black)
-6. **loadUrlTimeoutValue** - How much time Cordova should wait before throwing a timeout error on the application.
-7. **keepRunning (boolean, defaults to true)** - Determines whether Cordova will keep running in the background or not
-8. **splashscreen** - The name of the file minus its extension in the `res/drawable` directory. If you have multiple assets, they all must share this common name in their respective directories.
-9. **disallowOverscroll (boolean, defaults to false)** - set to true if you want to disable the glow when a user scrolls beyond the edge of the webview.
+* `useBrowserHistory` (boolean, defaults to `true`): set to false if you
+ want to use the history shim that was used to work around the
+ hashtag error present in Android 3.x prior to the history fix.
+ (Note: This setting will be deprecated in April 2013)
-## <plugin>
+* `loadingDialog`: Display a native loading dialog when loading the
+ app. The value's format is _Title, Message_
+
+* `loadingPageDialog`: Display a native loading dialog when loading
+ sub-pages. The value's format is _Title, Message_
+
+* `errorUrl`: Set the error page for your application. Should be
+ located in your Android project in file://android_asset/www/
+
+* `backgroundColor`: Set the background color for your application.
+ Supports a four-byte hex value, with the first byte representing
+ alpha value, and the following three bytes with standard RGB
+ values. (i.e. 0x00000000 = Black)
+
+* `loadUrlTimeoutValue`: How much time Cordova should wait before
+ throwing a timeout error on the application.
+
+* `keepRunning` (boolean, defaults to `true`): Determines whether
+ Cordova stays running in the background.
+
+* `splashscreen`: The name of the file minus its extension in the
+ `res/drawable` directory. If you have multiple assets, they all
+ must share this common name in their respective directories.
+
+* `disallowOverscroll` (boolean, defaults to `false`): set to `true` to
+ disable the glow when a user scrolls beyond the edge of the webview.
+
+## `<plugin>`
+
+Android supports using `<feature>` as analogues to `<plugin>` elements.
-Android supports using <feature> as analogues to <plugin> elements.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/index.md b/docs/en/3.0.0/guide/platforms/android/index.md
index 63673f0..4e42f50 100644
--- a/docs/en/3.0.0/guide/platforms/android/index.md
+++ b/docs/en/3.0.0/guide/platforms/android/index.md
@@ -30,7 +30,7 @@ detailed platform-specific information:
* Android Command-line Tools
The command-line tools above refer to versions prior to Cordova 3.0.
-See The Cordova Command-line Interface for information about the
+See The Command-line Interface for information about the
current interface.
## Requirements and Support
@@ -111,19 +111,27 @@ Cordova The Command-line Interface. For example, in a source-code directory:
Once created, here's how to use the SDK to modify it:
* Launch the __Eclipse__ application.
+
* Select the __New Project__ menu item.
+
* Choose __Android Project from Existing Code__ from the resulting dialog box, and press __Next__:
+
* Navigate to `hello`, or whichever directory you created for the project, then to the `platforms/android` subdirectory.
+
* Press __Finish__.
Once the Eclipse window opens, a red __X__ may appear to indicate
unresolved problems. If so, follow these additional steps:
-* Right-click on the project folder.
+* Right-click on the project directory.
+
* In the resulting __Properties__ dialog, select __Android__ from the navigation pane.
+
* For the project build target, select the highest Android API level you have installed.
+
* Click __OK__.
+
* Select __Clean__ from the __Project__ menu. This should correct all the errors in the project.
## Deploy to Emulator
@@ -179,9 +187,12 @@ For a faster experience, use an Intel-based emulator image:
* Install one or more `Intel x86 Atom` System Images as well as the
`Intel Hardware Accelerated Execution Manager`, available under
__Extras__.
+
* Run the Intel installer, which is available within your Android SDK
at `extras/intel/Hardware_Accelerated_Execution_Manager`.
+
* Create a new AVD with the target set to an Intel image.
+
* When starting the emulator, ensure there are no error messages
indicating a failure to load HAX modules.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/plugin.md b/docs/en/3.0.0/guide/platforms/android/plugin.md
index 6a6540a..ecd5a5a 100644
--- a/docs/en/3.0.0/guide/platforms/android/plugin.md
+++ b/docs/en/3.0.0/guide/platforms/android/plugin.md
@@ -19,14 +19,19 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Android Plugins
-Writing a plugin requires an understanding of the architecture of Cordova-Android. Cordova-Android consists
-of an Android WebView with hooks attached to it. These plugins are represented as class mappings in the config.xml
-file.
-
-A plugin consists of at least one Java class that extends the `CordovaPlugin` class. A plugin must override one
-of the `execute` methods from `CordovaPlugin`.
-As best practice, the plugin should handle `pause` and `resume` events, and any message passing between plugins.
-Plugins with long-running requests, background activity such as media playback, listeners, or internal state should implement the `onReset()` method as well. This method is run when the `WebView` navigates to a new page or refreshes, which reloads the JavaScript.
+Writing a plugin requires an understanding of the architecture of
+Cordova-Android. Cordova-Android consists of an Android WebView with
+hooks attached to it. These plugins are represented as class mappings
+in the `config.xml` file.
+
+A plugin consists of at least one Java class that extends the
+`CordovaPlugin` class. A plugin must override one of the `execute`
+methods from `CordovaPlugin`. As best practice, the plugin should
+handle `pause` and `resume` events, and any message passing between
+plugins. Plugins with long-running requests, background activity such
+as media playback, listeners, or internal state should implement the
+`onReset()` method as well. It executeswhen the `WebView` navigates to
+a new page or refreshes, which reloads the JavaScript.
## Plugin Class Mapping
@@ -38,9 +43,13 @@ This marshals a request from the WebView to the Android native side,
more or less boiling down to calling the `action` method on the
`service` class, with the arguments passed in the `args` Array.
-Whether you distribute your plugin as Java file or as a JAR of its own, the plugin must be added to the `config.xml` file in your Cordova-Android application's `res/xml/` folder.
+Whether you distribute your plugin as Java file or as a JAR of its
+own, the plugin must be added to the `config.xml` file in your
+Cordova-Android application's `res/xml/` directory.
- <plugin name="<service_name>" value="<full_name_including_namespace>"/>
+ <feature name="<service_name>">
+ <param name="android-package" value="<full_name_including_namespace>" />
+ </feature>
The service name should match the one used in the JavaScript `exec`
call, and the value is the Java classes full name, including the
@@ -118,7 +127,9 @@ If you do not need to run on the UI thread, but do not want to block the WebCore
Add the following to our `config.xml` file:
- <plugin name="Echo" value="org.apache.cordova.plugin.Echo" />
+ <feature name="Echo">
+ <param name="android-package" value="org.apache.cordova.plugin.Echo" />
+ </feature>
Then add the following file to
`src/org/apache/cordova/plugin/Echo.java` inside our Cordova-Android
@@ -184,6 +195,7 @@ Eclipse can be used to debug an Android project, and the plugins can be debugged
* Plugins have access to a `CordovaInterface` object. This object has access to the Android `Activity` that is running the application. This is the `Context` required to launch
a new Android `Intent`. The `CordovaInterface` allows plugins to start an `Activity` for a result, and to set the callback plugin for when the `Intent` comes back to the application. This is important, since the
`Intent`s system is how Android communicates between processes.
+
* Plugins do not have direct access to the `Context` as they have in the past. The legacy `ctx` member is deprecated, and will be removed six months after 2.0 is released. All of `ctx` methods exist on the `Context`, so both `getContext()` and `getActivity()` are capable of returning the proper object required.
## Use the Source
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/tools.md b/docs/en/3.0.0/guide/platforms/android/tools.md
index 09fcfdc..ce4b19c 100644
--- a/docs/en/3.0.0/guide/platforms/android/tools.md
+++ b/docs/en/3.0.0/guide/platforms/android/tools.md
@@ -58,6 +58,7 @@ Release, on Mac or Windows:
The `run` command accepts the following _optional_ parameters:
* Target specification. This includes `--emulator`, `--device`, or `--target=<targetID>`.
+
* Build specification. This includes `--debug`, `--release`, or `--nobuild`.
$ /path/to/project/cordova/run [Target] [Build]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/upgrading.md b/docs/en/3.0.0/guide/platforms/android/upgrading.md
index 64be68f..d703ef6 100644
--- a/docs/en/3.0.0/guide/platforms/android/upgrading.md
+++ b/docs/en/3.0.0/guide/platforms/android/upgrading.md
@@ -21,21 +21,24 @@ license: Licensed to the Apache Software Foundation (ASF) under one
This guide shows how to modify Android projects to upgrade from older versions of Cordova.
Most of these instructions apply to projects created with an older set
-of command-line tools that precede the `cordova` CLI utility. See The
-Cordova Command-line Interface for information how to update the
+of command-line tools that precede the `cordova` CLI utility. See The Command-line Interface for information how to update the
version of the CLI.
## Upgrade to the CLI (3.0.0) from 2.9.0 ##
1. Create a new Apache Cordova 3.0.0 project using the cordova CLI, as
- described in The Cordova Command-line Interface.
+ described in The Command-line Interface.
+
2. Add your platforms the the cordova project, for example: `cordova
platform add android`.
-3. Copy the contents of your project's `www` folder to the `www` folder
+
+3. Copy the contents of your project's `www` directory to the `www` directory
at the root of the cordova project you just created.
+
4. Copy any native assets from your old project into the appropriate
directories under `platforms/android`: this directory is where your
native cordova-android project exists.
+
5. Use the cordova CLI tool to install any plugins you need. Note that
the CLI handles all core APIs as plugins, so they may need to be
added. Only 3.0.0 plugins are compatible with the CLI.
@@ -43,226 +46,375 @@ version of the CLI.
## Upgrade to 3.0.0 from 2.9.0 ##
1. Create a new Apache Cordova Android project.
-2. Copy the contents of your `www` folder to the new project.
-3. Copy any native Android assets from your `res` folder to the new project.
+
+2. Copy the contents of your `www` directory to the new project.
+
+3. Copy any native Android assets from your `res` directory to the new project.
+
4. Copy over any plugins you installed from the `src` subdirectories into the new project.
-5. Make sure to upgrade any deprecated `<plugin>` references from your old `config.xml` file to the new `<feature>` specification.
+
+5. Make sure to upgrade any deprecated `<plugin>` references from your old `config.xml` file to the new `<feature>` specification.
+
+6. Update any references to the `org.apache.cordova.api` package to be `org.apache.cordova`.
+
- __NOTE:__ all core APIs have been removed and must be installed as plugins. Please see the Using Plugman to Manage Plugins Guide for details.
## Upgrade to 2.9.0 from 2.8.0
-1. Run `bin/update <project_path>`
+
+1. Run `bin/update <project_path>`.
## Upgrade to 2.8.0 from 2.7.0 ##
-1. Remove `cordova-2.7.0.jar` from the project's `libs` directory
-2. Add `cordova-2.8.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new cordova.js into your project
-5. Update your HTML to use the new cordova.js file
-6. Copy the `res/xml/config.xml` file to match `framework/res/xml/config.xml`
-7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
-8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+1. Remove `cordova-2.7.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.8.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova.js` into your project.
+
+5. Update your HTML to use the new `cordova.js` file.
+
+6. Copy the `res/xml/config.xml` file to match `framework/res/xml/config.xml`.
+
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously.
+
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.7.0 from 2.6.0 ##
-1. Remove `cordova-2.6.0.jar` from the project's `libs` directory
-2. Add `cordova-2.7.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.7.0.js` into your project
-5. Update your HTML to use the new `cordova-2.7.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
-8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+1. Remove `cordova-2.6.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.7.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.7.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.7.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously.
+
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.6.0 from 2.5.0 ##
-1. Remove `cordova-2.5.0.jar` from the project's `libs` directory
-2. Add `cordova-2.6.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.6.0.js` into your project
-5. Update your HTML to use the new `cordova-2.6.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
-8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+1. Remove `cordova-2.5.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.6.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.6.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.6.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously.
+
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
Run `bin/update <project>` with the project path listed in the Cordova Source directory.
## Upgrade to 2.5.0 from 2.4.0 ##
-1. Remove `cordova-2.4.0.jar` from the project's `libs` directory
-2. Add `cordova-2.5.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.5.0.js` into your project
-5. Update your HTML to use the new `cordova-2.5.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
-8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+1. Remove `cordova-2.4.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.5.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.5.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.5.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously.
+
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.4.0 from 2.3.0 ##
-1. Remove `cordova-2.3.0.jar` from the project's `libs` directory
-2. Add `cordova-2.4.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.4.0.js` into your project
-5. Update your HTML to use the new `cordova-2.4.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+1. Remove `cordova-2.3.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.4.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.4.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.4.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.3.0 from 2.2.0 ##
-1. Remove `cordova-2.2.0.jar` from the project's `libs` directory
-2. Add `cordova-2.3.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.3.0.js` into your project
-5. Update your HTML to use the new `cordova-2.3.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+1. Remove `cordova-2.2.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.3.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.3.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.3.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.2.0 from 2.1.0 ##
-1. Remove `cordova-2.1.0.jar` from the project's `libs` directory
-2. Add `cordova-2.2.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.2.0.js` into your project
-5. Update your HTML to use the new `cordova-2.2.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+1. Remove `cordova-2.1.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.2.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.2.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.2.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.1.0 from 2.0.0 ##
-1. Remove `cordova-2.0.0.jar` from the project's `libs` directory
-2. Add `cordova-2.1.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.1.0.js` into your project
-5. Update your HTML to use the new `cordova-2.1.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+1. Remove `cordova-2.0.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.1.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.1.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.1.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.0.0 from 1.9.0 ##
-1. Remove `cordova-1.9.0.jar` from the project's `libs` directory
-2. Add `cordova-2.0.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.0.0.js` into your project
-5. Update your HTML to use the new `cordova-2.0.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
+1. Remove `cordova-1.9.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.0.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.0.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.0.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
### Notes about 2.0.0 release
-config.xml will be replacing cordova.xml and plugins.xml. This new file is a combination of the previous two. However, the
-old files are deprecated, and while currently still work, will cease working in a future release.
+
+`config.xml` will be replacing `cordova.xml` and `plugins.xml`. This
+new file is a combination of the previous two. However, the old files
+are deprecated, and while currently still work, will cease working in
+a future release.
## Upgrade to 1.9.0 from 1.8.1 ##
-1. Remove `cordova-1.8.0.jar` from the project's `libs` directory
-2. Add `cordova-1.9.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.9.0.js` into your project
-5. Update your HTML to use the new `cordova-1.9.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.8.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.9.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.9.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.9.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
### Notes about 1.9.0 release
-- Third-Party plugins may or may not work. This is because of the introduction of the CordovaWebView. These plugins need to get a context from the CordovaInterface using
-getContext() or getActivity(). If you are not an experienced Android developer, please contact the plugin maintainer and add this task to their bug tracker.
+Due to the introduction of the `CordovaWebView`, third-Party plugins
+may not work. These plugins need to get a context from the
+`CordovaInterface` using `getContext()` or `getActivity()`. If you
+are not an experienced Android developer, please contact the plugin
+maintainer and add this task to their bug tracker.
## Upgrade to 1.8.0 from 1.8.0 ##
-1. Remove `cordova-1.8.0.jar` from the project's `libs` directory
-2. Add `cordova-1.8.1.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.8.1.js` into your project
-5. Update your HTML to use the new `cordova-1.8.1.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.8.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.8.1.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.8.1.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.8.1.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.8.0 from 1.7.0 ##
-1. Remove `cordova-1.7.0.jar` from the project's `libs` directory
-2. Add `cordova-1.8.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.8.0.js` into your project
-5. Update your HTML to use the new `cordova-1.8.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.7.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.8.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.8.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.8.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.8.0 from 1.7.0 ##
-1. Remove `cordova-1.7.0.jar` from the project's `libs` directory
-2. Add `cordova-1.8.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.8.0.js` into your project
-5. Update your HTML to use the new `cordova-1.8.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.7.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.8.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.8.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.8.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.7.0 from 1.6.1 ##
-1. Remove `cordova-1.6.1.jar` from the project's `libs` directory
-2. Add `cordova-1.7.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.7.0.js` into your project
-5. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.6.1.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.7.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.7.0.js` into your project.
+
+5. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.6.1 from 1.6.0 ##
-1. Remove `cordova-1.6.0.jar` from the project's `libs` directory
-2. Add `cordova-1.6.1.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.6.1.js` into your project
-5. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.6.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.6.1.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.6.1.js` into your project.
+
+5. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.6.0 from 1.5.0 ##
-1. Remove `cordova-1.5.0.jar` from the project's `libs` directory
-2. Add `cordova-1.6.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.6.0.js` into your project
-5. Update your HTML to use the new `cordova-1.6.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
-7. Replace `res/xml/phonegap.xml` with `res/xml/cordova.xml` to match `framework/res/xml/cordova.xml`
+
+1. Remove `cordova-1.5.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.6.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.6.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.6.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
+
+7. Replace `res/xml/phonegap.xml` with `res/xml/cordova.xml` to match `framework/res/xml/cordova.xml`.
## Upgrade to 1.5.0 from 1.4.0##
-1. Remove `phonegap-1.4.0.jar` from the project's `libs` directory
-2. Add `cordova-1.5.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.5.0.js` into your project
-5. Update your HTML to use the new `cordova-1.5.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
-7. Replace `res/xml/phonegap.xml` with `res/xml/cordova.xml` to match `framework/res/xml/cordova.xml`
+
+1. Remove `phonegap-1.4.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.5.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.5.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.5.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
+
+7. Replace `res/xml/phonegap.xml` with `res/xml/cordova.xml` to match `framework/res/xml/cordova.xml`.
## Upgrade to 1.4.0 from 1.3.0 ##
-1. Remove `phonegap-1.3.0.jar` from the project's `libs` directory
-2. Add `phonegap-1.4.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `phonegap-1.4.0.js` into your project
-5. Update your HTML to use the new `phonegap-1.4.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
-7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`
+
+1. Remove `phonegap-1.3.0.jar` from the project's `libs` directory.
+
+2. Add `phonegap-1.4.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `phonegap-1.4.0.js` into your project.
+
+5. Update your HTML to use the new `phonegap-1.4.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
+
+7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`.
## Upgrade to 1.3.0 from 1.2.0 ##
-1. Remove `phonegap-1.2.0.jar` from the project's `libs` directory
-2. Add `phonegap-1.3.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `phonegap-1.3.0.js` into your project
-5. Update your HTML to use the new `phonegap-1.2.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
-7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`
+
+1. Remove `phonegap-1.2.0.jar` from the project's `libs` directory.
+
+2. Add `phonegap-1.3.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `phonegap-1.3.0.js` into your project.
+
+5. Update your HTML to use the new `phonegap-1.2.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
+
+7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`.
## Upgrade to 1.2.0 from 1.1.0 ##
-1. Remove `phonegap-1.1.0.jar` from the project's `libs` directory
-2. Add `phonegap-1.2.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `phonegap-1.2.0.js` into your project
-5. Update your HTML to use the new `phonegap-1.2.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
-7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`
+
+1. Remove `phonegap-1.1.0.jar` from the project's `libs` directory.
+
+2. Add `phonegap-1.2.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `phonegap-1.2.0.js` into your project.
+
+5. Update your HTML to use the new `phonegap-1.2.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
+
+7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`.
## Upgrade to 1.1.0 from 1.0.0 ##
-1. Remove `phonegap-1.0.0.jar` from the project's `libs` directory
-2. Add `phonegap-1.1.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `phonegap-1.1.0.js` into your project
-5. Update your HTML to use the new `phonegap-1.1.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
+1. Remove `phonegap-1.0.0.jar` from the project's `libs` directory.
+
+2. Add `phonegap-1.1.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `phonegap-1.1.0.js` into your project.
+
+5. Update your HTML to use the new `phonegap-1.1.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.0.0 from 0.9.6 ##
-1. Remove `phonegap-0.9.6.jar` from the project's `libs` directory
-2. Add `phonegap-1.0.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `phonegap-1.0.0.js` into your project
-5. Update your HTML to use the new `phonegap-1.0.0.js` file
-6. Add the `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
+1. Remove `phonegap-0.9.6.jar` from the project's `libs` directory.
+
+2. Add `phonegap-1.0.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `phonegap-1.0.0.js` into your project.
+
+5. Update your HTML to use the new `phonegap-1.0.0.js` file.
+
+6. Add the `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/webview.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/webview.md b/docs/en/3.0.0/guide/platforms/android/webview.md
index ece0458..dd45a33 100644
--- a/docs/en/3.0.0/guide/platforms/android/webview.md
+++ b/docs/en/3.0.0/guide/platforms/android/webview.md
@@ -34,14 +34,18 @@ but may be eventually be automated.
## Prerequisites
-1. **Cordova 1.9** or greater
-2. Android SDK updated with 15
+* Cordova 1.9 or greater
+
+* Android SDK updated with 15
## Guide to using CordovaWebView in an Android Project
1. Use `bin/create` to fetch the `commons-codec-1.6.jar` file.
-2. `cd` into `/framework` and run `ant jar` to build the cordova jar. It creates the .jar file formed as `cordova-x.x.x.jar` in the `/framework` folder.
+
+2. `cd` into `/framework` and run `ant jar` to build the cordova jar. It creates the .jar file formed as `cordova-3.0.0.jar` in the `/framework` directory.
+
3. Copy the cordova jar into your Android project's `/libs` directory.
+
4. Edit your application's `main.xml` file (under `/res/xml`) to look like the following, with the `layout_height`, `layout_width` and `id` modified to suit your application:
<org.apache.cordova.CordovaWebView
@@ -116,4 +120,5 @@ but may be eventually be automated.
}
6. Copy your application's HTML and JavaScript files to your Android project's `/assets/www` directory.
-7. Copy `cordova.xml` and `plugins.xml` from `/framework/res/xml` to your project's `/res/xml` folder.
+
+7. Copy `cordova.xml` and `plugins.xml` from `/framework/res/xml` to your project's `/res/xml` directory.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/blackberry/index.md b/docs/en/3.0.0/guide/platforms/blackberry/index.md
index 3c8f407..76eb31c 100644
--- a/docs/en/3.0.0/guide/platforms/blackberry/index.md
+++ b/docs/en/3.0.0/guide/platforms/blackberry/index.md
@@ -31,7 +31,7 @@ information:
* BlackBerry Command-line Tools
The command-line tools above refer to versions prior to Cordova 3.0.
-See The Cordova Command-line Interface for information about the
+See The Command-line Interface for information about the
current interface.
## Requirements and Support
@@ -68,30 +68,49 @@ development. BlackBerry PlayBook and BlackBerry Smartphone WebWorks
SDKs can be downloaded from the following locations.
- [BlackBerry PlayBook SDK] (https://developer.blackberry.com/html5/download/#playbook) and [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.
+- [BlackBerry Smartphones SDK] (https://developer.blackberry.com/html5/download/#smartphones)
-To register for Signing Keys visit, and complete the [BlackBerry Keys Order Form](https://www.blackberry.com/SignedKeys).
+## Register for Signing Keys
-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).
+If you wish to publish your application on BlackBerry App World, or on
+an actual device, you’ll need to register for a set of free Code
+Signing Keys. To do so, complete the [BlackBerry Keys Order
+Form](https://www.blackberry.com/SignedKeys).
+Once you receive your Signing Keys, they require setup. See the [BlackBerry HTML5/WebWorks website](https://developer.blackberry.com/html5/documentation/signing_setup_bb10_apps_2008396_11.html) for information.
-## 4. Install Cordova
+## Install Cordova
Download and extract the latest copy of [Cordova](http://cordova.apache.org/#download).
-## 5. Set up New Project
+## Set up a New Project
- Open up a command-line 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 several directories. The `example` folder contains a complete Cordova project. Copy the `example` 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`
+- There is a directory for each platform that Cordova supports.
+ Navigate to the `blackberry` directory.
+
+- The `blackberry` directory contains several subdirectories. The
+ `example` directory contains a complete Cordova project. Copy the
+ `example` directory to another location on your computer, and
+ navigate there.
+
+- Edit the `project.properties` file to specify the WebWorks SDK you
+ are using. For example, here are the respective settings for
+ BlackBerry PlayBook, BlackBerry Smartphone (OS5-7), or BlackBerry 10
+ (QNX):
+
+ playbook.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks SDK for TabletOS 2.1.0.6\\bbwp
+ blackberry.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks Packager
+ qnx.bbwp.dir=C:\\Program Files (x86)\\Research In Motion\\BlackBerry 10 WebWorks SDK 1.0.2.9
+
+These correspond to parameters you specify when building your
+project. The first time you run these commands, they generate a
+"HelloWorld" application:
+
+ cordova/build playbook
+ cordova/build blackberry
+ cordova/build qnx
Along with the SDK, you also need to register for a code signing key
and debug token. The signing key allows you to distribute apps through
@@ -99,40 +118,16 @@ BlackBerry World. The debug token allows you to test unsigned apps on
a BlackBerry emulator or device. You do not need to create and
install the debug token yourself; if you supply the keystore password,
the build script creates and installs the debug token for you. To set
-up the signing key, go to the Blackberry website to obtain it, making
+up the signing key, go to the BlackBerry website to obtain it, making
sure to retain the password you specify. Then run the
-`blackberry-signer` utility that is included with the SDK. Consult the
-following for more information:
+`blackberry-signer` utility that is included with the SDK.
+BlackBerry provides more information here:
* [Register for your code signing key](https://www.blackberry.com/SignedKeys/codesigning.html)
* [Set up your computer for code signing](http://developer.blackberry.com/html5/documentation/set_up_for_signing.html)
-Build the Cordova sample project by typing `./cordova/build <target>` in your command prompt while you are in your project's directory. Replace `<target>` with either `qnx` `playbook` or `blackberry`. For example...
-
-* [Comprehensive guide to setting up your SDK environment](http://developer.blackberry.com/native/documentation/bb10/com.qnx.doc.native_sdk.quickstart/topic/set_up_your_environment.html)
-
-## Set up a New Project
-
-* Open up a command-line terminal. From the directory where you
- extracted Cordova, navigate to the `blackberry` subdirectory.
-
-* Copy the `blackberry` directory's `example` subdirectory to another
- location on your computer and navigate there.
-
-* Edit the `project.properties` file to specify the WebWorks SDK you
- are using. For example, here are the respective settings for
- BlackBerry PlayBook or BlackBerry Smartphone (OS5-7):
-
- playbook.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks SDK for TabletOS 2.1.0.6\\bbwp
- blackberry.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks Packager
-
-These correspond to parameters you specify when building your project.
-The first time you run these commands, they generate a "HelloWorld"
-application:
-
- cordova/build playbook
- cordova/build blackberry
+* [comprehensive guide to setting up your SDK environment](http://developer.blackberry.com/native/documentation/bb10/com.qnx.doc.native_sdk.quickstart/topic/set_up_your_environment.html)
## Deploy to Emulator
@@ -142,7 +137,12 @@ VMWare Fusion (Mac OS X). The WebWorks SDK provides a default
emulator, but additional emulators are [available through
BlackBerry](http://us.blackberry.com/developers/resources/simulators.jsp).
-While in your project directory, in command prompt type `./cordova/run <target>`. Replace `<target>` with either `qnx`, `playbook`, or `blackberry`. Note, for BlackBerry 10 and PlayBook, the emulator virtual image must already be started. For example...
+From your project directory, type `./cordova/run <target>`, replacing
+`<target>` with either `qnx`, `playbook`, or `blackberry`. Note that
+for BlackBerry 10 and PlayBook, the emulator virtual image must
+already be started.
+
+See the following for more information:
* [BlackBerry PlayBook](https://developer.blackberry.com/html5/documentation/using_the_tablet_simulator_1866980_11.html)
@@ -164,14 +164,14 @@ Files\\BlackBerry\\Simulator`.
Once the emulator is installed and running, run either of the
following to install an application to the home screen:
- cordova/run playbook
- cordova/run blackberry
+ cordova/run playbook
+ cordova/run blackberry
If you are prompted whether a device is connected to your computer,
answer no.
__NOTE:__ On BlackBerry OS 5, the application is installed in the
-`Downloads` folder.
+`Downloads` directory.
## Deploy to Device
@@ -180,11 +180,12 @@ registered for code signing keys as described above. Also, to deploy
apps on BlackBerry PlayBook, the __Settings → Security →
Development Mode__ option must be enabled.
-On Blackberry PlayBook, edit the `project.properties` file and modify
+On BlackBerry PlayBook, edit the `project.properties` file and modify
the following to reflect the device's IP and password as descibed
above, along with the signing key password you set up:
-While in your project directory, in command prompt type `./cordova/run <target>`. Replace `<target>` with either `qnx`, `playbook`, or `blackberry`. For example...
+From your project directory, type `./cordova/run <target>`, replacing
+`<target>` with either `qnx`, `playbook`, or `blackberry`.
On BlackBerry Smartphone (OS5-7), specify the
`blackberry.sigtool.password` property as the signing key password.
@@ -192,14 +193,14 @@ On BlackBerry Smartphone (OS5-7), specify the
Then from the project's directory, run either of the commands you
would to view the app in an emulator:
- cordova/run playbook
- cordova/run blackberry
+ cordova/run playbook
+ cordova/run blackberry
If you are prompted whether a device is connected to your computer,
answer yes.
__NOTE:__ On BlackBerry OS 5, the application is installed in the
-`Downloads` folder.
+`Downloads` directory.
## Additional Information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/blackberry/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/blackberry/plugin.md b/docs/en/3.0.0/guide/platforms/blackberry/plugin.md
index 56ba5ac..560d97d 100644
--- a/docs/en/3.0.0/guide/platforms/blackberry/plugin.md
+++ b/docs/en/3.0.0/guide/platforms/blackberry/plugin.md
@@ -43,27 +43,25 @@ to the `window.echo` function:
## Modifying plugins.xml
-Your project's `www/plugins.xml` folder contains all of the necessary
-references to your Cordova project's plugins. Add an
+Your project's `www/plugins.xml` directory contains all of the
+necessary references to your Cordova project's plugins. Add an
additional reference so that when `cordova.exec` is called, Cordova
knows how to map the `Echo` argument of `cordova.exec` to the `Echo`
class that we want to write natively:
- <plugins>
- ...
- <plugin name="Echo" value="org.apache.cordova.echo.Echo"/>
- ...
- </plugins>
+ <feature name="Echo">
+ <param name="blackberry-package" value="org.apache.cordova.echo.Echo" />
+ </feature>
## Adding Echo.java
If you notice the structure of the value attribute, you'll see a
-defined path that leads to the Echo plugin. In the root folder of the
-Cordova BlackBerry WebWorks repo, look for a folder called framework.
-This folder contains all of the source code that runs natively on the
+defined path that leads to the Echo plugin. In the root directory of the
+Cordova BlackBerry WebWorks repo, look for a directory called `framework`.
+This directory contains all of the source code that runs natively on the
BlackBerry. Navigate to `framework/ext/src/org/apache/cordova`. At
-this point, you'll see all of the plugin folders, inside of which is
-the source code. So add the folder echo to
+this point, you'll see all of the plugin directorys, inside of which is
+the source code. So add the directory echo to
`framework/ext/src/org/apache/cordova/echo` and create a file called
`Echo.java` at `framework/ext/src/org/apache/cordova/echo/Echo.java`.
@@ -131,7 +129,7 @@ status exceptions like `PluginResult.Status.ERROR`,
`PluginResult.Status.INVALID_ACTION`. When passed back, these types of
results fire the fail callback in JavaScript.
-## Updating the .jar in your project's www folder
+## Updating the .jar in your project's www directory
The added `Echo.java` needs to be updated in your project. To build
the `.jar` file, Navigate to the BlackBerry WebWorks repo's root
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/blackberry/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/blackberry/tools.md b/docs/en/3.0.0/guide/platforms/blackberry/tools.md
index ee9f3b3..df4a1f7 100644
--- a/docs/en/3.0.0/guide/platforms/blackberry/tools.md
+++ b/docs/en/3.0.0/guide/platforms/blackberry/tools.md
@@ -57,7 +57,7 @@ emulator executables.
## Launch emulator
For BlackBerry projects, please make sure you customize the
-`project.properties` file in the root of your Cordova project folder.
+`project.properties` file in the root of your Cordova project directory.
You need to do so to supply your BlackBerry signing key password, and
specify locations for the BlackBerry WebWorks SDK and BlackBerry
emulator executables.