Updated Branches: refs/heads/master 77755253d -> a85a9d6fb
[CB-4312] added blackberry10 2.9.0 to 3.0.0 upgrade guide Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/a85a9d6f Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/a85a9d6f Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/a85a9d6f Branch: refs/heads/master Commit: a85a9d6fb3ae3995723792f76cd9a1a2805c50ff Parents: 7775525 Author: lorinbeer <[email protected]> Authored: Thu Jul 18 12:52:21 2013 -0700 Committer: lorinbeer <[email protected]> Committed: Thu Jul 18 12:55:02 2013 -0700 ---------------------------------------------------------------------- .../guide/platforms/blackberry10/upgrading.md | 329 +++++++++++++++++++ 1 file changed, 329 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/a85a9d6f/docs/en/edge/guide/platforms/blackberry10/upgrading.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/blackberry10/upgrading.md b/docs/en/edge/guide/platforms/blackberry10/upgrading.md new file mode 100644 index 0000000..da9a58c --- /dev/null +++ b/docs/en/edge/guide/platforms/blackberry10/upgrading.md @@ -0,0 +1,329 @@ +--- +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. +--- + +# Upgrading BlackBerry + +This guide shows how to modify BlackBerry 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 +version of the CLI. + + +Please note that the CLI supports the BlackBerry10 platform exclusively. For PlayBook and BBOS, please see Cordova version 2.9.0 and below. + +## 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. +2. **Add your platforms the the cordova project**, for example: `cordova + platform add blackberry10`. +3. **Copy the contents of the original project's `www` folder** to the `www` folder + at the root of the cordova project you just created. +4. **Copy or overwrite any native assets from your original project** + (`Resources`, etc.) +5. **Copy your config.xml into the www folder, and remove any plugin definitions**. You will modify settings here instead of the platform folder. +6. **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. +7. **Build and test.** + +## Upgrading 2.8.0 projects to 2.9.0 ## + +BlackBerry 10: + +1. **Download and extract the Cordova 2.9.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.9.0) +2. **Quit any running SDK tools**: Eclipse, Momentics and the like. +3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc. +4. **Create a new project**, as described in BlackBerry Command-line Tools. This becomes the home of your updated project. +5. **Copy** your projects source from the old project's /www folder to the new project's /www folder +6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file + +### BlackBerryOS/Playbook ### + +1. **Download and extract the Cordova 2.9.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.9.0) +2. **Quit any running SDK tools**: Eclipse, Momentics and the like. +3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc. +4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project. +5. **Copy** the **www/cordova.js** file from the new project into your **www** folder, and delete your **www/cordova.js** file +6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file +7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder +8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder +9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder + +## Upgrading 2.7.0 projects to 2.8.0 ## + +BlackBerry 10: + +BlackBerry 10 uses the new CLI tooling and manages core APIs as plugins. The instructions migrate your project to a new project, rather than updating an existing project, due to the complexity of updating an old project. +Also note that the cordova js script file is now called 'cordova.js' and no longer contains a version string. + +1. **Download and extract the Cordova 2.8.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.8.0) +2. **Quit any running SDK tools**: Eclipse, Momentics and the like. +3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc. +4. **Create a new project**, as described in BlackBerry Command-line Tools. This becomes the home of your updated project. +5. **Copy** your projects source from the old project's /www folder to the new project's /www folder +6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file + +BlackBerryOS/Playbook: + +1. **Download and extract the Cordova 2.8.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.8.0) +2. **Quit any running SDK tools**: Eclipse, Momentics and the like. +3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc. +4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project. +5. **Copy** the **www/cordova.js** file from the new project into your **www** folder, and delete your **www/cordova.js** file +6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file +7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder +8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder +9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder + +## Upgrading 2.6.0 projects to 2.7.0 ## + +1. **Download and extract the Cordova 2.7.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.7.0) +2. **Quit any running SDK tools**: Eclipse, Momentics and the like. +3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc. +4. **Create a new project**, as described in BlackBerry Command-line Tools. You need the assets from this new project. +5. **Copy** the **www/cordova-2.7.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.6.0.js** file +6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova-2.7.0.js** file +7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder +8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder +9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder + +## Upgrade to 2.6.0 from 2.5.0 ## + +Updating the PhoneGap download folder: + +It is recommended that you download a fresh copy of the entire folder. + +However, here are the new parts needed for the piecemeal update: +1. Update the cordova.blackberry.js file in the âPhonegap-2.6.0/lib/blackberry/javascriptâ folder +2. Update the âextâ, âext-airâ, and âext-qnxâ in the âPhonegap-2.6.0/lib/blackberry/frameworkâ folder +3. Update the âbuild.xmlâ file in the âPhonegap-2.6.0/lib/blackberryâ folder +4. Update the âPhonegap-2.6.0/lib/blackberry/binâ folder +5. Update the âVERSIONâ file in the âPhonegap-2.6.0/lib/blackberryâ folder + +Updating the example/ folder or migrating an existing project: + +1. Open your `www/` folder, which contains your app. +2. Remove and update the .jar file in the `ext/` folder. +3. Update the contents of the `ext-air/` folder. +4. Update the contents of the `ext-qnx/` folder. +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. + +## Upgrade to 2.5.0 from 2.4.0 ## + +Updating the PhoneGap download folder: + +It is recommended that you download a fresh copy of the entire folder. + +However, here are the new parts needed for the piecemeal update: +1. Update the cordova.blackberry.js file in the âPhonegap-2.5.0/lib/blackberry/javascriptâ folder +2. Update the âextâ, âext-airâ, and âext-qnxâ in the âPhonegap-2.5.0/lib/blackberry/frameworkâ folder +3. Update the âbuild.xmlâ file in the âPhonegap-2.5.0/lib/blackberryâ folder +4. Update the âPhonegap-2.5.0/lib/blackberry/binâ folder +5. Update the âVERSIONâ file in the âPhonegap-2.5.0/lib/blackberryâ folder + +Updating the example/ folder or migrating an existing project: + +1. Open your `www/` folder, which contains your app. +2. Remove and update the .jar file in the `ext/` folder. +3. Update the contents of the `ext-air/` folder. +4. Update the contents of the `ext-qnx/` folder. +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. + +## Upgrade to 2.4.0 from 2.3.0 ## + +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. +3. Update the contents of the `ext-air/` folder. +4. Copy the new `cordova-2.4.0.js` into your project. + - If playbook, then update the .js file in the `playbook/` folder. + - If BlackBerry 10, 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. +2. Update the .jar file in the `cordova.2.3.0/ext/` folder. +3. Update the contents of the `cordova.2.3.0/ext-air/` folder. +4. Update the contents of the `cordova.2.3.0/ext-qnx/` folder. +5. Update the .js file in the `cordova.2.3.0/javascript/` folder. +6. Open the `sample/lib/` folder and rename the `cordova.2.3.0/` folder to `cordova.2.4.0/`. +7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova. +8. Open the `www/` folder and update your HTML to use the new `cordova-2.4.0.js` file + +## Upgrade to 2.3.0 from 2.2.0 ## + +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. +3. Update the contents of the `ext-air/` folder. +4. Copy the new `cordova-2.3.0.js` into your project. + - If playbook, then update the .js file in the `playbook/` folder. + - If BlackBerry 10, 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. +2. Update the .jar file in the `cordova.2.2.0/ext/` folder. +3. Update the contents of the `cordova.2.2.0/ext-air/` folder. +4. Update the contents of the `cordova.2.2.0/ext-qnx/` folder. +5. Update the .js file in the `cordova.2.2.0/javascript/` folder. +6. Open the `sample/lib/` folder and rename the `cordova.2.2.0/` folder to `cordova.2.3.0/`. +7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova. +8. Open the `www/` folder and update your HTML to use the new `cordova-2.3.0.js` file + +## Upgrade to 2.2.0 from 2.1.0 ## + +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. +3. Update the contents of the `ext-air/` folder. +4. Copy the new `cordova-2.2.0.js` into your project. + - If playbook, then update the .js file in the `playbook/` folder. + - If BlackBerry 10, 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. +2. Update the .jar file in the `cordova.2.1.0/ext/` folder. +3. Update the contents of the `cordova.2.1.0/ext-air/` folder. +4. Update the contents of the `cordova.2.1.0/ext-qnx/` folder. +5. Update the .js file in the `cordova.2.1.0/javascript/` folder. +6. Open the `sample/lib/` folder and rename the `cordova.2.1.0/` folder to `cordova.2.2.0/`. +7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova. +8. Open the `www/` folder and update your HTML to use the new `cordova-2.2.0.js` file. + +## Upgrade to 2.1.0 from 2.0.0 ## + +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. +3. Update the contents of the `ext-air/` folder. +4. Copy the new `cordova-2.1.0.js` into your project. + - 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. +2. Update the .jar file in the `cordova.2.0.0/ext/` folder. +3. Update the contents of the `cordova.2.0.0/ext-air/` folder. +4. Update the .js file in the `cordova.2.0.0/javascript/` folder. +5. Open the `sample/lib/` folder and rename the `cordova.2.0.0/` folder to `cordova.2.1.0/`. +6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova. +7. Open the `www/` folder and update your HTML to use the new `cordova-2.1.0.js` file. + +## Upgrade to 2.0.0 from 1.9.0 ## + +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. +3. Update the contents of the `ext-air/` folder. +4. Copy the new `cordova-2.0.0.js` into your project. + - If playbook, then update the .js file in the `playbook/` folder. +5. Update your HTML to use the new `cordova-2.0.0.js` file. +6. Update your `www/plugins.xml` file. Two plugins changed their + namespace/service label. Change the old entries for the Capture and + Contact plugins from: + + <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/> + <plugin name="Contact" value="org.apache.cordova.pim.Contact"/> + + To: + + <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/> + <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/> + +Updating the sample folder (ie, updating using the ant tools): + +1. Open the `sample/lib/` folder. +2. Update the .jar file in the `cordova.1.9.0/ext/` folder. +3. Update the contents of the `cordova.1.9.0/ext-air/` folder. +4. Update the .js file in the `cordova.1.9.0/javascript/` folder. +5. Open the `sample/lib/` folder and rename the `cordova.1.9.0/` folder to `cordova.2.0.0/`. +6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova. +7. Open the `www/` folder and update your HTML to use the new `cordova-2.0.0.js` file. +8. Open the `www/` folder and update the `plugins.xml` file. Two plugins + changed their namespace/service label. Change the old entries for the + Capture and Contact plugins from: + + <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/> + <plugin name="Contact" value="org.apache.cordova.pim.Contact"/> + + To: + + <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/> + <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/> + +- To upgrade to 1.8.0, please go from 1.7.0 + +## Upgrade to 1.8.0 from 1.7.0 ## + +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. +3. Update the contents of the `ext-air/` folder. +4. Copy the new `cordova-1.8.0.js` into your project. + - If playbook, then update the .js file in the `playbook/` folder. +5. Update your HTML to use the new `cordova-1.8.0.js` file. +6. Update your `www/plugins.xml` file. Two plugins changed their + namespace/service label. Change the old entries for the Capture and + Contact plugins from: + + <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/> + <plugin name="Contact" value="org.apache.cordova.pim.Contact"/> + + To: + + <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/> + <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/> + +Updating the sample folder (ie, updating using the ant tools): + +1. Open the `sample/lib/` folder. +2. Update the .jar file in the `cordova.1.7.0/ext/` folder. +3. Update the contents of the `cordova.1.7.0/ext-air/` folder. +4. Update the .js file in the `cordova.1.7.0/javascript/` folder. +5. Open the `sample/lib/` folder and rename the `cordova.1.7.0/` folder to `cordova.1.8.0/`. +6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova. +7. Open the `www/` folder and update your HTML to use the new `cordova-1.8.0.js` file. +8. Open the `www/` folder and update the `plugins.xml` file. Two plugins + changed their namespace/service label. Change the old entries for the + Capture and Contact plugins from: + + <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/> + <plugin name="Contact" value="org.apache.cordova.pim.Contact"/> + + To: + + <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/> + <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/> +
