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/07/16 23:20:57 UTC
[6/8] docs commit: [CB-3962] Update formatting of BlackBerry and
BlackBerry 10 guides.
[CB-3962] Update formatting of BlackBerry and BlackBerry 10 guides.
- monospace for path/dir/file components
- changed from italic
- no unformatted barewords allowed
Conflicts:
docs/en/edge/guide/platforms/blackberry/index.md
docs/en/edge/guide/platforms/blackberry10/index.md
docs/en/edge/guide/platforms/blackberry10/tools.md
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/2d175336
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/2d175336
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/2d175336
Branch: refs/heads/master
Commit: 2d175336c4776fa8bfd402660224b8ef67ae7190
Parents: a6d123a
Author: Mike Sierra <le...@gmail.com>
Authored: Tue Jul 16 11:34:52 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Tue Jul 16 14:19:04 2013 -0700
----------------------------------------------------------------------
STYLESHEET.md | 8 +-
docs/en/edge/cordova/media/media.startRecord.md | 2 +-
docs/en/edge/guide/cli/index.md | 2 +-
docs/en/edge/guide/platforms/android/config.md | 2 +-
.../edge/guide/platforms/android/upgrading.md | 251 +++++++++----------
.../en/edge/guide/platforms/blackberry/index.md | 35 ++-
.../guide/platforms/blackberry/upgrading.md | 8 +-
.../edge/guide/platforms/blackberry10/index.md | 226 ++++++++---------
.../edge/guide/platforms/blackberry10/plugin.md | 1 -
.../edge/guide/platforms/blackberry10/tools.md | 49 ++++
docs/en/edge/guide/platforms/ios/config.md | 2 +-
docs/en/edge/guide/platforms/ios/index.md | 2 +-
docs/en/edge/guide/platforms/ios/plugin.md | 2 +-
docs/en/edge/guide/platforms/ios/upgrading.md | 1 -
docs/en/edge/guide/platforms/tizen/index.md | 2 -
docs/en/edge/guide/platforms/win8/upgrading.md | 8 +-
docs/en/edge/guide/platforms/wp7/index.md | 5 +-
docs/en/edge/guide/platforms/wp8/index.md | 4 +-
docs/en/edge/guide/platforms/wp8/tools.md | 2 -
docs/en/edge/guide/platforms/wp8/upgrading.md | 183 +++++++-------
20 files changed, 422 insertions(+), 373 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/STYLESHEET.md
----------------------------------------------------------------------
diff --git a/STYLESHEET.md b/STYLESHEET.md
index cb4667b..70954d7 100644
--- a/STYLESHEET.md
+++ b/STYLESHEET.md
@@ -25,14 +25,14 @@ editorial guidelines.
## In-line Font Formatting
* Use `monospace` for all-purpose nouns used in programming, e.g.: API
- interfaces, methods, properties, literal values, Unix commands, etc.
+ interfaces, methods, properties, literal values, Unix commands,
+ pathnames, filenames, etc.
* Use __bold__ for on-screen items, such as the names of menu items,
buttons, and check boxes.
-* Use _italics_ for emphasis, pathnames, filenames, simple
- mathematical expressions, variable items (e.g., _x_/_y_
- coordinates).
+* Use _italics_ for emphasis, simple mathematical expressions, and
+ variable items (e.g., _x_/_y_ coordinates).
* Do _not_ use ALL CAPS for emphasis. (Exception: in commented code)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/cordova/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.startRecord.md b/docs/en/edge/cordova/media/media.startRecord.md
index b94cee9..ec95b56 100644
--- a/docs/en/edge/cordova/media/media.startRecord.md
+++ b/docs/en/edge/cordova/media/media.startRecord.md
@@ -144,7 +144,7 @@ iOS Quirks
----------
- iOS only records to files of type _.wav_ and returns an error if the file name extension is not correct.
-- If a full path is not provided, the recording is placed in the application's _documents/tmp_ directory. This can be accessed via the `File` API using `LocalFileSystem.TEMPORARY`. Any subdirectory specified at record time must already exist.
+- If a full path is not provided, the recording is placed in the application's `documents/tmp` directory. This can be accessed via the `File` API using `LocalFileSystem.TEMPORARY`. Any subdirectory specified at record time must already exist.
- Files can be recorded and played back using the documents URI:
var myMedia = new Media("documents://beer.mp3")
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/cli/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cli/index.md b/docs/en/edge/guide/cli/index.md
index 4c63c12..7a00013 100644
--- a/docs/en/edge/guide/cli/index.md
+++ b/docs/en/edge/guide/cli/index.md
@@ -144,7 +144,7 @@ Running commands to add or remove platforms affects the contents of
the project's _platforms_ directory, where each specified platform
appears as a subdirectory. The _www_ source directory is reproduced
within each platform's subdirectory, appearing for example in
-_platforms/ios/www_ or _platforms/android/assets/www_. By default,
+`platforms/ios/www` or `platforms/android/assets/www`. By default,
each platform's configuration file is set up to be able to access all
of Cordova's APIs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/android/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/android/config.md b/docs/en/edge/guide/platforms/android/config.md
index b3c02b5..4e8dd74 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -35,7 +35,7 @@ Various **other** preferences (as **<preference>** tags) default on not br
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.
+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.
## <plugin>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/android/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/android/upgrading.md b/docs/en/edge/guide/platforms/android/upgrading.md
index 4428ccb..c05e35c 100644
--- a/docs/en/edge/guide/platforms/android/upgrading.md
+++ b/docs/en/edge/guide/platforms/android/upgrading.md
@@ -23,100 +23,99 @@ Upgrading Android
This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova.
## 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 libs directory in your project
-2. Add cordova-2.8.0.jar to the libs directory in your project
+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 to be the same as the one found in 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 cordova directory in your project
+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 libs directory in your project
-2. Add cordova-2.7.0.jar to the libs directory in your project
+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 be the same as the one found in 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 cordova directory in your project
-
+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 libs directory in your project
-2. Add cordova-2.6.0.jar to the libs directory in your project
+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 be the same as the one found in 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 cordova directory in your project
+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
+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 libs directory in your project
-2. Add cordova-2.5.0.jar to the libs directory in your project
+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 be the same as the one found in 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 cordova directory in your project
+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 libs directory in your project
-2. Add cordova-2.4.0.jar to the libs directory in your project
+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 be the same as the one found in framework/res/xml/config.xml
-7. Copy files from bin/templates/cordova to the cordova directory in your project
+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 libs directory in your project
-2. Add cordova-2.3.0.jar to the libs directory in your project
+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 be the same as the one found in framework/res/xml/config.xml
-7. Copy files from bin/templates/cordova to the cordova directory in your project
+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 libs directory in your project
-2. Add cordova-2.2.0.jar to the libs directory in your project
+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 be the same as the one found in framework/res/xml/config.xml
-7. Copy files from bin/templates/cordova to the cordova directory in your project
+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 libs directory in your project
-2. Add cordova-2.1.0.jar to the libs directory in your project
+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 be the same as the one found in framework/res/xml/config.xml
-7. Copy files from bin/templates/cordova to the cordova directory in your project
+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 libs directory in your project
-2. Add cordova-2.0.0.jar to the libs directory in your project
+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 be the same as the one found in framework/res/xml/config.xml
+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
@@ -124,12 +123,12 @@ old files are deprecated, and while currently still work, will cease working in
## Upgrade to 1.9.0 from 1.8.1 ##
-1. Remove cordova-1.8.0.jar from the libs directory in your project
-2. Add cordova-1.9.0.jar to the libs directory in your project
+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 the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml
+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
@@ -138,105 +137,105 @@ getContext() or getActivity(). If you are not an experienced Android developer,
## Upgrade to 1.8.0 from 1.8.0 ##
-1. Remove cordova-1.8.0.jar from the libs directory in your project
-2. Add cordova-1.8.1.jar to the libs directory in your project
+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 the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml
+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 libs directory in your project
-2. Add cordova-1.8.0.jar to the libs directory in your project
+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 the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml
+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 libs directory in your project
-2. Add cordova-1.8.0.jar to the libs directory in your project
+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 the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml
+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 libs directory in your project
-2. Add cordova-1.7.0.jar to the libs directory in your project
+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 the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml
+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 libs directory in your project
-2. Add cordova-1.6.1.jar to the libs directory in your project
+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 the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml
+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 libs directory in your project
-2. Add cordova-1.6.0.jar to the libs directory in your project
+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 the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
-7. Replace the res/xml/phonegap.xml with res/xml/cordova.xml so that it is the same as the one found in framework/res/xml/cordova.xml
+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 libs directory in your project
-2. Add cordova-1.5.0.jar to the libs directory in your project
+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 the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
-7. Replace the res/xml/phonegap.xml with res/xml/cordova.xml so that it is the same as the one found in framework/res/xml/cordova.xml
+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 libs directory in your project
-2. Add phonegap-1.4.0.jar to the libs directory in your project
+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 the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
-7. Update the res/xml/phonegap.xml so that it is the same as the one found in framework/res/xml/phonegap.xml
+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 libs directory in your project
-2. Add phonegap-1.3.0.jar to the libs directory in your project
+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 the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
-7. Update the res/xml/phonegap.xml so that it is the same as the one found in framework/res/xml/phonegap.xml
+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 libs directory in your project
-2. Add phonegap-1.2.0.jar to the libs directory in your project
+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 the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
-7. Update the res/xml/phonegap.xml so that it is the same as the one found in framework/res/xml/phonegap.xml
+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 libs directory in your project
-2. Add phonegap-1.1.0.jar to the libs directory in your project
+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 the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
+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 libs directory in your project
-2. Add phonegap-1.0.0.jar to the libs directory in your project
+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 so that it is the same as the one found in framework/res/xml/plugins.xml
+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/2d175336/docs/en/edge/guide/platforms/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry/index.md b/docs/en/edge/guide/platforms/blackberry/index.md
index 8ef6f54..b0a5352 100644
--- a/docs/en/edge/guide/platforms/blackberry/index.md
+++ b/docs/en/edge/guide/platforms/blackberry/index.md
@@ -61,8 +61,30 @@ 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)
-BlackBerry PlayBook also requires the [Adobe Air
-SDK](http://www.adobe.com/devnet/air/air-sdk-download.edu.html).
+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 and extract the latest copy of [Cordova](http://cordova.apache.org/#download).
+
+5. Set up 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`
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
@@ -79,7 +101,7 @@ following for more information:
* [Set up your computer for code signing](http://developer.blackberry.com/html5/documentation/set_up_for_signing.html)
-* [Learn more about debug tokens](http://developer.blackberry.com/html5/documentation/running_your_bb10_app_2008471_11.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)
@@ -113,7 +135,7 @@ 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).
-Consult the following for instructions on how to install emulators:
+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...
* [BlackBerry PlayBook](https://developer.blackberry.com/html5/documentation/using_the_tablet_simulator_1866980_11.html)
@@ -155,10 +177,7 @@ 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:
-* `playbook.sigtool.csk.password`
-* `playbook.sigtool.p12.password`
-* `playbook.device.ip`
-* `playbook.device.password`
+While in your project directory, in command prompt type `./cordova/run <target>`. Replace `<target>` with either `qnx`, `playbook`, or `blackberry`. For example...
On BlackBerry Smartphone (OS5-7), specify the
`blackberry.sigtool.password` property as the signing key password.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/blackberry/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry/upgrading.md b/docs/en/edge/guide/platforms/blackberry/upgrading.md
index d278a17..5489ec3 100644
--- a/docs/en/edge/guide/platforms/blackberry/upgrading.md
+++ b/docs/en/edge/guide/platforms/blackberry/upgrading.md
@@ -129,7 +129,7 @@ Updating the example/ folder or migrating an existing project:
## Upgrade to 2.4.0 from 2.3.0 ##
-Updating just the www folder:
+Updating just the `www` folder:
1. Open your `www/` folder, which contains your app.
2. Remove and update the .jar file in the `ext/` folder.
@@ -139,7 +139,6 @@ Updating just the www folder:
- If BlackBerry10, then update the .js file in the `qnx/` folder.
5. Update your HTML to use the new `cordova-2.4.0.js` file.
-
Updating the sample folder (ie, updating using the ant tools):
1. Open the `sample/lib/` folder.
@@ -163,7 +162,6 @@ Updating just the `www` folder:
- If BlackBerry10, then update the .js file in the `qnx/` folder.
5. Update your HTML to use the new `cordova-2.3.0.js` file.
-
Updating the sample folder (ie, updating using the ant tools):
1. Open the `sample/lib/` folder.
@@ -187,7 +185,6 @@ Updating just the www folder:
- If BlackBerry10, then update the .js file in the `qnx/` folder.
5. Update your HTML to use the new `cordova-2.2.0.js` file.
-
Updating the sample folder (ie, updating using the ant tools):
1. Open the `sample/lib/` folder.
@@ -201,7 +198,7 @@ Updating the sample folder (ie, updating using the ant tools):
## Upgrade to 2.1.0 from 2.0.0 ##
-Updating just the www folder:
+Updating just the `www` folder:
1. Open your `www/` folder, which contains your app.
2. Remove and update the .jar file in the `ext/` folder.
@@ -210,7 +207,6 @@ Updating just the www folder:
- If playbook, then update the .js file in the `playbook/` folder.
5. Update your HTML to use the new `cordova-2.1.0.js` file.
-
Updating the sample folder (ie, updating using the ant tools):
1. Open the `sample/lib/` folder.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/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 07e99f9..1f3dcdd 100644
--- a/docs/en/edge/guide/platforms/blackberry10/index.md
+++ b/docs/en/edge/guide/platforms/blackberry10/index.md
@@ -1,171 +1,165 @@
+---
+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.
+---
+
BlackBerry 10 Platform Guide
==================================
-This guide describes how to set up your SDK development environment to
-deploy Cordova apps for Blackberry 10 devices.
+Apache Cordova is an application development platform that allows you to use common web technologies, primarily HTML5, JavaScript, and CSS, to create applications for mobile devices. Cordova uses a standard set of APIs to access common device features. Additional plugins allow you to access BlackBerry specific APIs, so that you can extend your application to tightly integrate with the BlackBerry 10 OS.
+
+Requirements
+------------
+
+Cordova for BlackBerry has the following software requirements:
+
+- Windows XP (32-bit) or Windows 7 (32-bit and 64-bit) or Mac OSX 10.6.4+
+- node.js (> 0.9.9) [Download node.js now](http://nodejs.org/)
+- BlackBerry 10 Native SDK. [Download the BlackBerry 10 Native SDK now.](http://developer.blackberry.com/native/download/)
+
+Setting up your signing keys
+----------------------------
+
+Before starting development, you'll need to register for your code signing key and debug token. The signing key allows you to sign your completed app so that you can distribute it through BlackBerry World. The debug token allows you to test an unsigned app on a BlackBerry 10 device. You do not need to create and install the debug token yourself; if you supply the keystore password, the build script will create and install the debug token for you.
+
+- [Register for your code signing key now.](https://www.blackberry.com/SignedKeys/codesigning.html)
+- [Set your computer up for code signing. ](http://developer.blackberry.com/html5/documentation/set_up_for_signing.html)
+- [Learn more about debug tokens.](http://developer.blackberry.com/html5/documentation/running_your_bb10_app_2008471_11.html)
-## Requirements and Support
+Creating your project
+-------------------------
-The development environment is available on Windows XP (32-bit),
-Windows 7 (32-bit or 64-bit), or Mac OS X 10.6.4+.
+To create a new project, you use the `create` command to set up the folder structure for your app.
-Developers should use the `cordova` utility in conjunction with the
-Blackberry 10 SDK. See The Command-line Interface for information how
-to install it, add projects, then build and deploy a project.
+1. On the command line, navigate to the folder where you extracted Cordova.
+2. Run the `create` command using the following syntax:
+ ```
+ bin/create <path-to-project>
+ ```
-You can use the Cordova CLI to develop Blackberry 10 projects. For
-previous versions of Blackberry, you need to use a different set of
-command-line tools, described in BlackBerry Platform Guide.
+This command creates the folder structure for your project at the specified location. All of your project resource files should be stored in the *<path-to-project>*/www folder, or in a subfolder within it.
-## Install the SDK
+Adding and managing targets
+---------------------------
-The BlackBerry 10 Native SDK is available from
-[developer.blackberry.com](http://developer.blackberry.com/native/download/).
-If you wish to run a device emulator, it is available on the same
-page. The device image is bundled with a _controller_ application that
-modifies hardware status, such as location and battery strength.
-(On Mac, the emulator runs as a VMware Fusion image.)
+A target refers to a BlackBerry device or emulator that you will use to test your app. Targets are added directly to your project; you can add multiple targets to your project, each with a unique name. Then, when you want to deploy your app to a particular target, you can simply refer to that target by name when you run your script.
-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 BlackBerry World. The debug token allows you to test unsigned
-apps on a BlackBerry 10 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 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:
+###Add a target
-* [Register for your code signing key.](https://www.blackberry.com/SignedKeys/codesigning.html)
+To add a target, on the command line, type the following command:
-* [Set up your computer for code signing.](http://developer.blackberry.com/html5/documentation/set_up_for_signing.html)
+ <path-to-project>/cordova/target add <name> <ip-address> [-t <device | simulator>] [-p | --password <password>] [--pin <device-pin>]
-* [Learn more about debug tokens.](http://developer.blackberry.com/html5/documentation/running_your_bb10_app_2008471_11.html)
+where
-* [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)
+- `<name>` specifies a unique name for the target.
+- `<ip-address>` specifies the ip address of the BlackBerry device or emulator.
+- `-t <device | simulator>` specifies the target type. If not provided, the default value is device.
+- `-p|--password <password>` specifies the password for the device or emulator. This is required only if the device or emulator is password protected.
+- `--pin <device-pin>` specifies the PIN of the BlackBerry device, which identifies that device as a valid host for the debug token. This argument is required only if you are creating a debug token.
-## Create a Project
+###Remove a target
-Use the `cordova` utility to set up a new project, as described in The
-Cordova The Command-line Interface. For example, in a source-code
-directory:
+To remove a target, on the command line, type the following command:
- $ cordova create hello com.example.hello "Hello World"
- $ cd hello
- $ cordova platform add blackberry
- $ cordova build
+ <path-to-project>/cordova/target remove <name>
-## Deploy to Emulator
+###Set a target as the default
-Before testing an app on either on 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.
+To specify a specific target as the default, on the command line, type the following command:
-Launch the emulator image, then choose __Settings__ from the home
-screen:
+ <path-to-project>/cordova/target default <name>
-
+Building your app
+-----------------
-Navigate to the __Security and Privacy → Development Mode__
-section, enable the option, and obtain the emulator's IP address from
-the screen:
+To build your app, run the build script. You can build the app in either release mode or in debug mode.
-
+- When you build the app in release mode, you are preparing it for distribution through BlackBerry World. The script packages your app resources and plugins together in a .bar file, then signs the app.
+- When you build the app in debug mode, you are preparing it to be tested. The script packages your app resources and plugins together in a .bar file, but does not sign it. The script can also deploy the app onto a previously defined target. If you have not already created and installed a debug token, you can supply the keystore password, and the build script will create and install the debug token for you as well.
-An additional set of command-line utilities are included when you set
-up the Blackberry platform for your project. The following commands,
-in this case invoked from the project's top-level directory,
-associates a target named _emu_ with the IP address displayed above,
-and makes that target the default. The `add` command's `-t` option
-specifies the `simulator` target _type_, another word for _emulator_:
+ Debug mode also enables Web Inspector for the app, which allows you to remotely inspect the source code. A prompt displays the URL that you can use to connect to and inspect your app. For more information on using Web Inspector, see [Debugging using Web Inspector](http://developer.blackberry.com/html5/documentation/web_inspector_overview_1553586_11.html).
- $ platforms/blackberry/cordova/target add emu 169.254.0.1 -t simulator
- $ platforms/blackberry/cordova/target default emu
+###Build your app in release mode
-Then, run the `emulate` command to view the app:
+To build your app in release mode, on the command line, type the following command:
- $ cordova emulate blackberry
+ <path-to-project>/cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-file>]
-The first time you run the command, you may be prompted for
-information on the intended target, and the keystore password you
-initially set up.
+where
-<!--  -->
+- `-k|--keystorepass <password>` specifies the password you defined when you configured your computer to sign applications.
+- `-b|--buildId <number>` specifies the build version number of your application. Typically, this number should be incremented from the previous signed version. This argument is optional.
+- `-p|--params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools. This argument is optional.
-## Deploy to Device
+###Build your app in debug mode
-To deploy to a device, make sure it is plugged into your computer, and
-obtain the IP address using the same procedure as described above.
-Then run a variation of the `target` command such as this:
+To build your app in release mode, on the command line, type the following command:
- $ platforms/blackberry/cordova/target add handset 169.254.0.1 -t device -p 123456 --pin unlockme
+ <path-to-project>/cordova/build debug [<target>] [-k|--keystorepass <password>] [-p|--params <params-JSON-file>] [-ll|--loglevel <error|warn|verbose>]
-The `-p` option refers to whatever password you set up when requesting
-a signing key, as described above. The `--pin` option refers to
-whatever local password locks the device itself. To view the PIN,
-open the __Settings__ app and choose __About__, then choose
-__Hardware__ from the __Category__ menu:
+where
-
+- `<target>` specifies the name of a previously added target. If `<target>` is not specified, the default target is used, if one has been created. This argument is only required if you want the script to deploy your app to a BlackBerry device or emulator and you have not created a default target. Additionally, if `<target>` is a device, then that device must be connected to your computer by USB connection or be connected to the same Wi-Fi network as your computer.
+- `-k|--keystorepass <password>` specifies the password you defined when you configured your computer to sign applications. This password is also used to create your debug token. This argument is only required if you want the script to create and install the debug token for you.
+- `-p|--params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools.
+- `-ll|--loglevel <level>` specifies the log level. The log level may be one of `error`, `warn`, or `verbose`.
-Here is the full syntax for `target add`:
+Note that all of these parameters are optional. If you have previously defined a default target (and installed a debug token, if that target is a BlackBerry device), you can run the script with no arguments, and the script will package your app and deploy it to the default target. For example:
- $ cordova/target add <name> <ip-address> [-t <device | simulator>] [-p | --password <password>] [--pin <device-pin>]
+ <path-to-project>/cordova/build debug
-where:
+Deploying an app
+-------------------------
-* `<name>` specifies a unique name for the target.
+You can test your app using either a BlackBerry device or an emulator. Before deploying your app, you must first create a target for the device or emulator you want to deploy your app to.
-* `<ip-address>` specifies the ip address of the BlackBerry device or
- simulator.
+The run script will first build your app. If you intend to deploy an app to a physical device for testing, you must first install a debug token on that device. If you specify the `--keystorepass <password>` argument when running the run script, the script will create and install the debug token for you. You do not need a debug token to test your app on an emulator, even if that app is unsigned.
-* `-t <device | simulator>` specifies the target type. The default
- value is `device`.
+To deploy your app to a device or emulator, on a command line type the following command:
-* `-p|--password <password>` specifies the password for the device or
- simulator, which only applies if either is password-protected.
+ <path-to-project>/cordova/run <target> [--no-build]
-* `--pin <device-pin>` specifies the PIN of the BlackBerry device,
- which identifies it as a valid host for the debug token. This
- argument is required only if you create a debug token.
+where
+- `<target>` specifies the name of a previously added target. If `<target>` is a device, then that device must be connected to your computer by USB connection or be connected to the same Wi-Fi network as your computer.
-To remove a target:
+- `-no--build` will use the most recently built version of the application rather than re-building. This is useful to test an application in release mode.
- $ cordova/target remove <name>
+Adding and managing plugins
+---------------------------
-To set a target as the default:
+To add additional functionality that is outside of the core features of Cordova, you'll need to add plugins. A plugin represents a set of APIs that provide access to additional features of the platform.
- $ cordova/target default <name>
+In order to use a plugin, you must first add it into your project. Once added into your project, the plugin will be bundled with your project during the build process, to ensure that your app has access to all the APIs it needs.
-When debugging on the device or a simulator, you may run a Web
-Inspector 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 on using Web Inspector, see
-[Debugging using Web Inspector](http://developer.blackberry.com/html5/documentation/web_inspector_overview_1553586_11.html).
+###Add a plugin
-## Building a Release Version
+To add a plugin, on the command line, type the following command:
-By default, running the `cordova build` command creates an unsigned
-_.bar_ package file suitable for testing in 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, also available within `platforms/blackberry`, uses the
-following syntax:
+ <path-to-project>/cordova/plugin add <path to plugin>
- $ cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-file>]
+###Remove a plugin
-where:
+To remove a plugin, on the command line, type the following command:
-* `-k|--keystorepass <password>` specifies the password you defined
- when you configured your computer to sign applications.
+ <path-to-project>/cordova/plugin rm <name>
-* `-b|--buildId <number>` specifies the build version number of your
- application, which you typically increment from the previously
- submitted signed version. This argument is optional.
+###View a list of installed plugins
-* `-p|--params <params-JSON-file>` specifies a JSON file containing
- additional parameters to pass to downstream tools. This argument is
- optional.
+To view a list of installed plugins, on the command line, type the following command:
+ <path-to-project>/cordova/plugin ls
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/blackberry10/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry10/plugin.md b/docs/en/edge/guide/platforms/blackberry10/plugin.md
index a51d2ab..aceb335 100644
--- a/docs/en/edge/guide/platforms/blackberry10/plugin.md
+++ b/docs/en/edge/guide/platforms/blackberry10/plugin.md
@@ -29,7 +29,6 @@ This is a continuation of the Plugin Development Guide for Cordova. Once you hav
A native BlackBerry 10 plugin for Cordova contains JavaScript code and may also contain native code. The Echo plugin example demonstrates how to invoke native functionality from JavaScript. The native and JavaScript code communicate with each other through a framework provided by JNEXT. Every plugin must also include a plugin.xml file.
-
## Creating the native part of your plugin ##
To create the native portion of your plugin, open the BlackBerry 10 NDK IDE and select File > New > BlackBerry Project > Native Extension > BlackBerry WebWorks. Enter your desired project name / location and click finish.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/blackberry10/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry10/tools.md b/docs/en/edge/guide/platforms/blackberry10/tools.md
index 87ec400..627400c 100644
--- a/docs/en/edge/guide/platforms/blackberry10/tools.md
+++ b/docs/en/edge/guide/platforms/blackberry10/tools.md
@@ -39,7 +39,11 @@ arguments.
The 'create' command creates a new project:
+<<<<<<< HEAD
bin/create <path-to-project>
+=======
+ bin/create <path-to-project>
+>>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
## target
@@ -49,7 +53,11 @@ target, or set a target as the default target.
### Add a target
+<<<<<<< HEAD
<path-to-project>/cordova/target add <name> <ip-address> <device | simulator> [-p | --password <password>] [--pin <device-pin>]
+=======
+ <path-to-project>/cordova/target add <name> <ip-address> <device | simulator> [-p | --password <password>] [--pin <device-pin>]
+>>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
where
@@ -69,11 +77,19 @@ where
### Remove a target
+<<<<<<< HEAD
<path-to-project>/cordova/target remove <name>
### Set a target as the default
<path-to-project>/cordova/target default <name>
+=======
+ <path-to-project>/cordova/target remove <name>
+
+### Set a target as the default
+
+ <path-to-project>/cordova/target default <name>
+>>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
## build
@@ -83,9 +99,14 @@ in debug mode (which produces an unsigned .bar file).
### Build your project in release mode
+<<<<<<< HEAD
<path-to-project>/cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-file>]
where:
+=======
+ <path-to-project>/cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-file>]
+where
+>>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
- `-k|--keystorepass <password>` specifies the password you defined when you configured your computer to sign applications.
- `-b|--buildId <number>` specifies the build version number of your application. Typically, this number should be incremented from the previous signed version. This argument is optional.
@@ -93,7 +114,11 @@ where:
### Build your project in debug mode
+<<<<<<< HEAD
<path-to-project>/cordova/build debug [<target>] [-k|--keystorepass <password>] [-p|--params <params-JSON-file>] [-ll|--loglevel <error|warn|verbose>]
+=======
+ <path-to-project>/cordova/build debug [<target>] [-k|--keystorepass <password>] [-p|--params <params-JSON-file>] [-ll|--loglevel <error|warn|verbose>]
+>>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
where
@@ -123,7 +148,11 @@ installed a debug token, if that target is a BlackBerry device), you
can run the script with no arguments, and the script will package your
app and deploy it to the default target. For example:
+<<<<<<< HEAD
<path-to-project>/cordova/build debug
+=======
+ <path-to-project>/cordova/build debug
+>>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
## run
@@ -132,7 +161,11 @@ or an emulator. Before deploying your app, you must first create a
target for the device or emulator you want to deploy your app to. The
deploy script will deploy the most recent build of your app.
+<<<<<<< HEAD
<path-to-project>/cordova/run <target>
+=======
+ <path-to-project>/cordova/run <target>
+>>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
where
@@ -147,6 +180,7 @@ The `target` command allows you to add and remove plugins
### Fetch a locally hosted plugin
+<<<<<<< HEAD
<path-to-project>/cordova/plugin fetch <path-to-plugin>
### View a list of installed plugins
@@ -161,3 +195,18 @@ The `target` command allows you to add and remove plugins
<path-to-project>/cordova/plugin rm <name>
+=======
+ <path-to-project>/cordova/plugin fetch <path-to-plugin>
+
+### View a list of installed plugins
+
+ <path-to-project>/cordova/plugin ls
+
+### Add a plugin
+
+ <path-to-project>/cordova/plugin add <name>
+
+### Remove a plugin
+
+ <path-to-project>/cordova/plugin rm <name>
+>>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/ios/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/ios/config.md b/docs/en/edge/guide/platforms/ios/config.md
index ccb0ec4..38fd333 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -39,7 +39,7 @@ Various preferences (as **<preference>** tags) default on not breaking exi
5. **AutoHideSplashScreen (boolean, defaults to true)** - set to false to control when the splashscreen is hidden through a JavaScript API
-6. **FadeSplashScreen (boolean, defaults to true)** - set to false to prevent the splash-screen to fade in and out when showing/hiding it.
+6. **FadeSplashScreen (boolean, defaults to true)** - set to false to prevent the splash-screen to fade in and out when showing or hiding it.
7. **FadeSplashScreenDuration (float, defaults to 2)** - The splash-screen Fade duration in seconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/ios/index.md b/docs/en/edge/guide/platforms/ios/index.md
index 6c605ff..9107443 100644
--- a/docs/en/edge/guide/platforms/ios/index.md
+++ b/docs/en/edge/guide/platforms/ios/index.md
@@ -70,7 +70,7 @@ Cordova The Command-line Interface. For example, in a source-code directory:
$ cordova prepare # or "cordova build"
Once created, you can open it from within Xcode. Double-click to open
-the _hello/platforms/ios/hello.xcodeproj_ file. The screen should
+the `hello/platforms/ios/hello.xcodeproj` file. The screen should
look like this:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/ios/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/ios/plugin.md b/docs/en/edge/guide/platforms/ios/plugin.md
index 77d7ca3..7256de1 100644
--- a/docs/en/edge/guide/platforms/ios/plugin.md
+++ b/docs/en/edge/guide/platforms/ios/plugin.md
@@ -95,7 +95,7 @@ callback does not fire.
* `messageAsArrayBuffer` expects `NSData*` and converts to an `ArrayBuffer` for your JavaScript callback (and `ArrayBuffers` sent to a plugin from JavaScript are converted to `NSData*`).
* `messageAsMultipart` expects an `NSArray*` containing any of the other supported types, and sends the whole array as the `arguments` to your JavaScript callback.
- * Quirk: this is not just syntactic sugar (though it is sweet). This way, all of the arguments are serialized/deserialized as necessary. e.g. it is safe to return `NSData*` as multipart, but not as `Array`/`Dictionary`.
+ * Quirk: this is not just syntactic sugar (though it is sweet). This way, all of the arguments are serialized or deserialized as necessary. e.g. it is safe to return `NSData*` as multipart, but not as `Array`/`Dictionary`.
## Echo Plugin iOS Plugin
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/ios/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/ios/upgrading.md b/docs/en/edge/guide/platforms/ios/upgrading.md
index 150fb26..c116e1a 100644
--- a/docs/en/edge/guide/platforms/ios/upgrading.md
+++ b/docs/en/edge/guide/platforms/ios/upgrading.md
@@ -75,7 +75,6 @@ Please note that **Xcode 4.5 is required**. To submit to the Apple App Store, yo
8. In your **config.xml** file, [remove this line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=537705d76a5ef6bc5e57a8ebfcab78c02bb4110b;hp=8889726d9a8f8c530fe1371c56d858c34552992a;hb=064239b7b5fa9a867144cf1ee8b2fb798ce1f988;hpb=c9f233250d4b800f3412eeded811daaafb17b2cc).
9. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder
-
## Upgrading 2.5.0 projects to 2.6.0 ##
1. **Download and extract the Cordova 2.6.0 source** to a **permanent folder location** on your hard drive (say to `~/Documents/Cordova-2.6.0`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/tizen/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/tizen/index.md b/docs/en/edge/guide/platforms/tizen/index.md
index 2e3ac04..9ec823f 100644
--- a/docs/en/edge/guide/platforms/tizen/index.md
+++ b/docs/en/edge/guide/platforms/tizen/index.md
@@ -61,7 +61,6 @@ Download the Tizen SDK from
-->
-
## Open a Project in the SDK
1. Launch the Tizen Eclipse IDE.
@@ -81,7 +80,6 @@ Download the Tizen SDK from
-
To rebuild the project, right-click in the __Project Explorer__ view
and Select __Build Project__:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/win8/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/win8/upgrading.md b/docs/en/edge/guide/platforms/win8/upgrading.md
index f5c3bea..2f4949b 100644
--- a/docs/en/edge/guide/platforms/win8/upgrading.md
+++ b/docs/en/edge/guide/platforms/win8/upgrading.md
@@ -26,14 +26,14 @@ This document is for people who need to upgrade their Cordova versions from an o
The following commands should be done from within Visual Studio to be sure that the any project references are updated/deleted.
-1. Remove cordova-2.8.0.js from the www directory in your project.
-2. Add cordova.js file from the source to the www directory in your project. ( note that the file no longer contains a version number in the file name )
+1. Remove `cordova-2.8.0.js` from the project's `www` directory.
+2. Add cordova.js file from the source to the project's `www` directory. (Note that the file no longer contains a version number in the filename.)
3. Build and test!
## Upgrade to 2.8.0 from 2.7.0 ##
The following commands should be done from within Visual Studio to be sure that the any project references are updated/deleted.
-1. Remove cordova-2.7.0.js from the www directory in your project.
-2. Add cordova.js file from the source to the www directory in your project. ( note that the file no longer contains a version number in the file name )
+1. Remove `cordova-2.7.0.js` from the project's `www` directory.
+2. Add cordova.js file from the source to the project's `www` directory. (Note that the file no longer contains a version number in the filename.)
3. Build and test!
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/wp7/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/wp7/index.md b/docs/en/edge/guide/platforms/wp7/index.md
index dbc775f..4676878 100644
--- a/docs/en/edge/guide/platforms/wp7/index.md
+++ b/docs/en/edge/guide/platforms/wp7/index.md
@@ -30,11 +30,10 @@ This guide describes how to set up your development environment for Cordova and
- The 64-bit version (x64) of Windows is required for the SDK.
- The Pro version is recommended for running a device emulator.
-- Register and pay for a [Windows Phone Dev Center](http://dev.windowsphone.com/en-us/publish) account if you want to install your app on a real device and/or submit it to Market Place.
+- Register and pay for a [Windows Phone Dev Center](http://dev.windowsphone.com/en-us/publish) account if you want to install your app on a real device or submit it to Market Place.
__NOTE:__ Running the SDK in Virtual Machine might present some challenges. You can read this blog post that gives insight on the solutions to develop for [Windows Phone on a Mac](http://aka.ms/BuildaWP8apponaMac).
-
2. Install SDK + Cordova
----------------------------
@@ -69,7 +68,7 @@ Run the script :
4. Review the project structure
-------------------------------
-- The 'www' folder contains your Cordova html/js/css and any other resources included in your app.
+- The `www` folder contains your Cordova `html/js/css` and any other resources included in your app.
- Any content that you add here needs to be a part of the Visual Studio project, and it must be set as content.
- Note: This screen capture was from the wp8 cordova-2.3.0 download, your listing will vary based on the actual version installed.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/wp8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/wp8/index.md b/docs/en/edge/guide/platforms/wp8/index.md
index 4fc2a2e..f526afa 100644
--- a/docs/en/edge/guide/platforms/wp8/index.md
+++ b/docs/en/edge/guide/platforms/wp8/index.md
@@ -47,7 +47,7 @@ __NOTE:__ Applications built with Apache Cordova for Windows Phone 8 (wp8) run o
- SDK + IDE ( Visual Studio )
- Visual Studio 2012 Professional, Premium, or Ultimate. Note that Visual Studio Express for Windows Phone (included in the SDK) is not recommended because you can not build the template (see below) with VS Express, as it does not have the __Export Template__ functionality, which is only in VS Pro or higher.
-- Register and pay for a [Windows Phone Dev Center](http://dev.windowsphone.com/en-us/publish) account if you want to install your app on a real device and/or submit it to Market Place.
+- Register and pay for a [Windows Phone Dev Center](http://dev.windowsphone.com/en-us/publish) account if you want to install your app on a real device or submit it to Market Place.
__NOTE:__ Running the SDK in Virtual Machine might present some challenges. You can read this blog post that gives insight on the solutions to develop for [Windows Phone on a Mac](http://aka.ms/BuildaWP8apponaMac).
@@ -87,7 +87,7 @@ Run the script :
4. Review the project structure
-------------------------------
-- The 'www' folder contains your Cordova html/js/css and any other resources included in your app.
+- The `www` folder contains your Cordova `html/js/css` and any other resources included in your app.
- Any content that you add here needs to be a part of the Visual Studio project, and it must be set as content.
- Note: This screen capture was from the cordova-2.3.0 download, your listing will vary based on the actual version installed.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2d175336/docs/en/edge/guide/platforms/wp8/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/wp8/tools.md b/docs/en/edge/guide/platforms/wp8/tools.md
index adfbba4..2d96064 100644
--- a/docs/en/edge/guide/platforms/wp8/tools.md
+++ b/docs/en/edge/guide/platforms/wp8/tools.md
@@ -45,7 +45,6 @@ There are 2 ways to go about creating a new Apache Cordova WP7 or WP8 applicatio
### Run the batch file to create and install the templates.
-
- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where x.x.x is the current version number) To easily use these files in Visual Studio, copy them to
"My Documents\Visual Studio 2012\Templates\ProjectTemplates\" You will then be able to create new Apache Cordova Windows Phone apps from the Visual Studio File->New Project menu.
- If you run the batch file from the command line, you can also call with a parameter to install automatically
@@ -75,7 +74,6 @@ name. Here is the syntax for both Windows Phone 7 and 8:
Built and Run it
-
## Building your project (cleans then builds)
* Debug