Return-Path: X-Original-To: apmail-cordova-commits-archive@www.apache.org Delivered-To: apmail-cordova-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 0CFB9101A0 for ; Fri, 7 Jun 2013 18:38:26 +0000 (UTC) Received: (qmail 6456 invoked by uid 500); 7 Jun 2013 18:38:25 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 6437 invoked by uid 500); 7 Jun 2013 18:38:25 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cordova.apache.org Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 6428 invoked by uid 99); 7 Jun 2013 18:38:25 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 07 Jun 2013 18:38:25 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 8EED38A05BE; Fri, 7 Jun 2013 18:38:25 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: steven@apache.org To: commits@cordova.apache.org Date: Fri, 07 Jun 2013 18:38:25 -0000 Message-Id: X-Mailer: ASF-Git Admin Mailer Subject: [01/11] Added 2.8.0 Updated Branches: refs/heads/2.8.x 7d44907ce -> db65dd69c http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/db65dd69/docs/en/2.8.0/guide/upgrading/ios/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.8.0/guide/upgrading/ios/index.md b/docs/en/2.8.0/guide/upgrading/ios/index.md new file mode 100644 index 0000000..4ea993b --- /dev/null +++ b/docs/en/2.8.0/guide/upgrading/ios/index.md @@ -0,0 +1,425 @@ +--- +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 Cordova iOS +===================== + +Please note that **Xcode 4.5 is required**. To submit to the Apple App Store, you must use the latest shipped version of the iOS SDK, which is iOS 6. The iOS 6 SDK requires Xcode 4.5. + +## Upgrading Cordova 2.7.0 projects to 2.8.0 ## + +1. **Download and extract the Cordova 2.8.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.8.0) +2. **Quit Xcode** if it is running. +3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**. +4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project +5. **Copy** the **www/cordova.js** (note that it does not have a version suffix anymore, the version is in the file itself in the header) file from the new project into your **www** folder, and delete your **www/cordova-2.7.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.js** file +7. Update any <plugin> tags that are in your **config.xml** to <feature> tags. Note that existing <plugin> tags will still work, but are deprecated. You can copy this information in the **config.xml** for a new project. For example: + + + + + + + + + + + + +8. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder + +## Upgrading Cordova 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 ~/Documents/Cordova-2.7.0) +2. **Quit Xcode** if it is running. +3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**. +4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab 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. Update (or replace, if you never changed the file) your **AppDelegate.m** file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=5c05ac80e056753c0e8736f887ba9f28d5b0774c;hp=623ad8ec3c46f656ea18c6c3a190d650dd64e479;hb=c6e71147386d4ad94b07428952d1aae0a9cbf3f5;hpb=c017fda8af00375a453cf27cfc488647972e9a23)) +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 Cordova 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) +2. **Quit Xcode** if it is running. +3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**. +4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project +5. **Copy** the **www/cordova-2.6.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.5.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.6.0.js** file +7. Update (or replace, if you never changed the file) your **AppDelegate.m** file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=124a56bb4f361e95616f44d6d6f5a96ffa439b60;hp=318f79326176be8f16ebc93bad85dd745f4205b6;hb=a28c7712810a63396e9f32fa4eb94fe3f8b93985;hpb=36acdf55e4cab52802d73764c8a4b5b42cf18ef9)) +8. In your **config.xml** file, [add this new line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=1555b5e81de326a07efe0bccaa5f5e2326b07a9a;hp=0652d60f8d35ac13c825c572dca6ed01fea4a540;hb=95f16a6dc252db0299b8e2bb53797995b1e39aa1;hpb=a2de90b8f5f5f68bd9520bcbbb9afa3ac409b96d). +9. In your **config.xml** file, [add this new line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=d307827b7e67301171a913417fb10003d43ce39d;hp=04260aa9786d6d74ab20a07c86d7e8b34e31968c;hb=97b89edfae3527828c0ca6bb2f6d58d9ded95188;hpb=942d33c8e7174a5766029ea1232ba2e0df745c3f). +10. In your **config.xml** file, [UIWebViewBounce has ben changed to DisallowOverscroll - and default values are different](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=8889726d9a8f8c530fe1371c56d858c34552992a;hp=d307827b7e67301171a913417fb10003d43ce39d;hb=57982de638a4dce6ae130a26662591741b065f00;hpb=ec411f18309d577b4debefd9a2f085ba719701d5). +10. In your **config.xml** file, the **EnableLocation** preference has been **deprecated**. +11. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder + +## Upgrading Cordova 2.4.0 projects to 2.5.0 ## + +1. **Download and extract the Cordova 2.5.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.5.0) +2. **Quit Xcode** if it is running. +3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**. +4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project +5. **Copy** the **www/cordova-2.5.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.4.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.5.0.js** file +7. Update (or replace, if you never changed the file) your **AppDelegate.m** file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=318f79326176be8f16ebc93bad85dd745f4205b6;hp=6dc7bfc84f0ecede4cc43d2a3256ef7c5383b9fe;hb=4001ae13fcb1fcbe73168327630fbc0ce44703d0;hpb=299a324e8c30065fc4511c1fe59c6515d4842f09)) +8. In your **config.xml** file, [add these new lines](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=903944c4b1e58575295c820e154be2f5f09e6314;hp=721c734120b13004a4a543ee25f4287e541f34be;hb=ae467249b4a256bd31ee89aea7a06f4f2316b8ac;hpb=9e39f7ef8096fb15b38121ab0e245a3a958d9cbb). +9. In your **config.xml** file, [edit the root element, change it from cordova to widget](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=64e71636f5dd79fa0978a97b9ff5aa3860a493f5;hp=d8579352dfb21c14e5748e09b2cf3f4396450163;hb=0e711f8d09377a7ac10ff6be4ec17d22cdbee88d;hpb=57c3c082ed9be41c0588d0d63a1d2bfcd2ed878c). +10. In your **config.xml** file, [remove the OpenAllWhitelistURLsInWebView preference](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=721c734120b13004a4a543ee25f4287e541f34be;hp=7d67508b70914aa921a16e79f79c00512502a8b6;hb=187bf21b308551bfb4b98b1a5e11edf04f699791;hpb=03b8854bdf039bcefbe0212db937abd81ac675e4). +11. Delete your **"cordova"** folder, and copy the **"cordova"** folder from the new project into your project's root folder **(in 2.5.0, this has updated scripts)** +12. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder + +## Upgrading Cordova 2.3.0 projects to 2.4.0 ## + +1. **Download and extract the Cordova 2.4.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.4.0) +2. **Quit Xcode** if it is running. +3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**. +4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project +5. **Copy** the **www/cordova-2.4.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.3.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.4.0.js** file +7. Update (or replace, if you never changed the files) your **MainViewController.m** file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/MainViewController.m;h=5f9eeac15c2437cd02a6eb5835b48374e9b94100;hp=89da1082d06ba5e5d0dffc5b2e75a3a06d5c2aa6;hb=b4a2e4ae0445ba7aec788090dce9b822d67edfd8;hpb=a484850f4610e73c7b20cd429a7794ba829ec997)). +8. Update (or replace, if you never changed the file) your **AppDelegate.m** file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=6dc7bfc84f0ecede4cc43d2a3256ef7c5383b9fe;hp=1ca3dafeb354c4442b7e149da4f281675aa6b740;hb=6749c17640c5fed8a7d3a0b9cca204b89a855baa;hpb=deabeeb6fcb35bac9360b053c8bf902b45e6de4d)) +9. In your **config.xml** file, [add this new line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=7d67508b70914aa921a16e79f79c00512502a8b6;hp=337d38da6f40c7432b0bce05aa3281d797eec40a;hb=6749c17640c5fed8a7d3a0b9cca204b89a855baa;hpb=deabeeb6fcb35bac9360b053c8bf902b45e6de4d). +10. Delete your **"cordova"** folder, and copy the **"cordova"** folder from the new project into your project's root folder **(in 2.4.0, this has fixed scripts)** +11. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder +12. Add AssetsLibrary.framework as a resource to your project. (Go [here](https://developer.apple.com/library/ios/#recipes/xcode_help-project_editor/Articles/AddingaLibrarytoaTarget.html) for instructions on how to do so.) + +## Upgrading Cordova 2.2.0 projects to 2.3.0 ## + +1. **Download and extract the Cordova 2.3.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.3.0) +2. **Quit Xcode** if it is running. +3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**. +4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project +5. **Copy** the **www/cordova-2.3.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.2.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.3.0.js** file +7. Update (or replace, if you never changed the file) your **MainViewController.m** according to the one from the new project. +8. Delete your **"cordova"** folder, and copy the **"cordova"** folder from the new project into your project's root folder **(in 2.3.0, this has new scripts)** +9. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder +10. Convert your **Cordova.plist** file to **config.xml**, by running the script **bin/cordova\_plist\_to\_config\_xml** on your project file. +11. Add the InAppBrowser plugin to your **config.xml**, by adding this tag under **<cordova><plugins>**: + + +12. Note that Objective-C plugins are **not** whitelisted anymore. To whitelist your connections with the app whitelist, you will need to set the “User-Agent” header of the connection to the same user-agent as the main Cordova WebView. +You can get this by accessing the **userAgent** property off the main view-controller. The main view-controller (CDVViewController) also has a **URLisAllowed** method for you to check whether a URL will pass the whitelist. +13. Device API changes: + * For iOS, device.platform used to return “iPhone”, “iPad” or “iPod Touch” — now it returns (correctly) “iOS”. + * For iOS, device.name (now deprecated for all platforms) used to return the name of the user’s device (e.g ‘Shazron’s iPhone 5′) — now it returns what device.platform used to return: ”iPhone”, “iPad” or “iPod Touch”. + * For all platforms, there is a new property called device.model — this returns the specific device model, e.g “iPad2,5″ (for other platforms, this returns what device.name used to return). + +## Upgrading Cordova 2.1.0 projects to 2.2.0 ## + +1. **Download and extract the Cordova 2.2.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.2.0) +2. **Quit Xcode** if it is running. +3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**. +4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project +5. **Copy** the **www/cordova-2.2.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.1.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.2.0.js** file +7. Update (or replace, if you never changed the file) your **MainViewController.m** according to the one from the new project: + - Updated -> viewWillAppear +8. Copy the **"cordova"** folder from the new project into your project's root folder **(in 2.2.0, this has an updated 'emulate' script)** +9. Next, update your CordovaLib sub-project reference. Beginning with Cordova 2.1.0, we are not using the CORDOVALIB Xcode variable anymore when referencing where CordovaLib resides, the reference is an absolute file reference now. + 1. Launch **Terminal.app** + 2. Go to the location where you installed Cordova **(see Step 1)**, in the **bin** sub-folder + 3. Run the script below where the first parameter is the path to your project's **.xcodeproj** file: + + `update_cordova_subproject path/to/your/project/xcodeproj` + +**Note** that in 2.2.0, the **bin/create** script will copy in the CordovaLib sub-project into your project now. To have the same kind of setup, just copy in the right CordovaLib into your project folder, and update the CordovaLib sub-project location (relative to the project) in the Xcode File Inspector. + +## Upgrading Cordova 2.0.0 projects to 2.1.0 ## + +With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit -> Refactor -> Convert to Objective-C ARC…**, **de-select libCordova.a**, then run the wizard to completion. + +1. **Download and extract the Cordova 2.1.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.1.0) +2. **Quit Xcode** if it is running. +3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**. +5. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project +6. **Copy** the **www/cordova-2.1.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.0.0.js** file +7. **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.1.0.js** file +8. Update (or replace, if you never changed the file) your **AppDelegate.m** according to the one from the new project: + - Edited -> application:didFinishLaunchingWithOptions: + - Added -> application:supportedInterfaceOrientationsForWindow: +9. Update (or replace, if you never changed the file) your **MainViewController.m** according to the one from the new project: + - Added -> viewWillAppear +10. Copy the **"cordova"** folder from the new project into your project's root folder **(in 2.1.0, this has the updated scripts to support paths with spaces)** +11. Remove the **VERSION** file reference from your **project** (**NOT** the one in CordovaLib) +12. Next, update your CordovaLib sub-project reference. Beginning with Cordova 2.1.0, we are not using the CORDOVALIB Xcode variable anymore when referencing where CordovaLib resides, the reference is an absolute file reference now. + 1. Launch **Terminal.app** + 2. Go to the location where you installed Cordova **(see Step 1)**, in the **bin** sub-folder + 3. Run the script below where the first parameter is the path to your project's **.xcodeproj** file: + + `update_cordova_subproject path/to/your/project/xcodeproj` + + +## Upgrading Cordova 1.9.0 projects to 2.0.0 ## + +1. **Install** Cordova 2.0.0 +2. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project +3. **Copy** the **www/cordova-2.0.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.9.0.js** file +4. **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.0.0.js** file +5. Copy the **"cordova"** folder from the new project into your project's root folder (if you want the project command-line tools) +6. **Add** a new entry under **Plugins** in your **Cordova.plist** file (under the **Supporting Files** group) - the key is **Device** and the value is **CDVDevice** +7. Remove **Cordova.framework** +8. Remove **verify.sh** from the **Supporting Files** group +9. Select the **project icon** in the Project Navigator, select your project **Target**, then select the **"Build Settings"** tab +10. Search for **"Preprocessor Macros"**, then remove all **"CORDOVA_FRAMEWORK=1"** values +11. Locate the **CordovaLib** folder that was installed in your hard-drive under your home folder's **Documents** sub-folder. +12. Locate the **CordovaLib.xcodeproj** file in the **CordovaLib** folder, then **drag and drop** the file into your project - it should appear as a **sub-project**. +13. **Build** your project, you should get some **errors** relating to **#import** directives +14. For the **#import errors**, change any **quote-based** imports in this style: + + #import "CDV.h" + + to this **brackets-based** style: + + #import + + and remove any **#ifdef** wrappers around any Cordova imports, they are not needed anymore (the imports are **unified** now) +15. **Build** your project again, and it should not have any **#import** errors. +16. Select the **project icon** in the Project Navigator, select your project **Target**, then select the **"Build Phases"** tab +17. Expand the **"Target Dependencies"** phase, then select the **"+"** button +18. Select the **"CordovaLib"** target, then select the **"Add"** button +19. Expand the **first** **"Link Binary with Libraries"** phase (it should already contain a bunch of frameworks), then select the **"+"** button +20. Select the **libCordova.a** static library, then select the **"Add"** button +21. Delete the **"Run Script"** phase. +22. Select the **project icon** in the Project Navigator, select your project **Target**, then select the **"Build Settings"** tab +23. Search for **"Other Linker Flags"**, and add the values **-all_load** and **-Obj-C** +24. Expand the **"CordovaLib" sub-project** +25. Locate the **"VERSION"** file, drag it into your main project (we want to create a link to it, not a copy) +26. Select the **"Create groups for any added folders"** radiobutton, then select the **"Finish"** button +27. Select the **"VERSION"** file that you just dragged in a previous step +28. Press the key combination **Option-Command-1** to show the **File Inspector** (or menuitem **View -> Utilities -> Show File Inspector**) +29. Choose **"Relative to CORDOVALIB"** in the **File Inspector** for the drop-down menu for **Location** +30. Set the Xcode preference **"Xcode Preferences -> Locations -> Derived Data -> Advanced…"** to **"Unique"** (this is so the unified headers can be found) +31. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab +32. Search for **"Header Search Paths"**. For that setting, add these three values below (with quotes): + + "$(TARGET_BUILD_DIR)/usr/local/lib/include" + + "$(OBJROOT)/UninstalledProducts/include" + + "$(BUILT_PRODUCTS_DIR)" + +33. Search for **"Other Linker Flags"**. For that setting, add this value below: + + -weak_framework CoreFoundation + +34. **Build** your project, it should compile and link with **no issues**. +35. **Select your project** from the **Scheme** drop-down, and then select **"iPhone 5.1 Simulator"** +36. Select the **Run** button + +**NOTE:**
+If your project is **not working** as expected in the Simulator, please **take a note of any errors** in the **console log in Xcode** for clues. + +## Upgrading Cordova 1.8.x projects to 1.9.0 ## + +1. **Install** Cordova 1.9.0 +2. **Create a new project** - you will have to grab assets from this new project +3. **Copy** the **www/cordova-1.9.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.8.x.js** file +4. **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-1.9.0.js** file + +**Note:** + +1.9.0 supports the new **"BackupWebStorage"** boolean setting in Cordova.plist. By default, this setting is turned on, set it to "false" to turn it off - especially for iOS 6 - see [Release Notes - Safari and UIKit Section](https://developer.apple.com/library/prerelease/ios/#releasenotes/General/RN-iOSSDK-6_0/_index.html) + + +## Upgrading Cordova 1.7.0 projects to 1.8.x ## + +1. **Install** Cordova 1.8.0 +2. **Create a new project** - you will have to grab assets from this new project +3. **Copy** the **www/cordova-1.8.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.7.x.js** file +4. **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-1.8.0.js** file + +If you intend on using the **Capture API**, you will need the new **iPad retina-display** assets: + +1. **Copy** the **Resources/Capture.bundle** item from the new project into your project folder, over-writing your existing **Resources/Capture.bundle** item +2. In your project, select the **Capture.bundle** item into Xcode into your Project Navigator, and press the **Delete** key, then select **Remove Reference** from the dialog that pops up. +3. Drag the new **Capture.bundle** from Step 1. above into Xcode into your Project Navigator, and select the **Create groups for any added folders** radio-button + +## Upgrading Cordova 1.6.x projects to 1.7.0 ## + +1. **Install** Cordova 1.7.0 +2. **Create a new project** - you will have to grab assets from this new project +3. **Copy** the **www/cordova-1.7.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.6.0.js** file +4. **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-1.7.0.js** file + +## Upgrading Cordova 1.5.0 projects to 1.6.x ## + +1. **Install** Cordova 1.6.1 +2. **Make a backup** of **AppDelegate.m**, **AppDelegate.h**, **MainViewController.m**, **MainViewController.h**, and **Cordova.plist** in your project +3. **Create a new project** - you will have to grab assets from this new project +4. **Copy** these files from the **new** project into your 1.5.0 based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above): + + AppDelegate.h + AppDelegate.m + MainViewController.h + MainViewController.m + Cordova.plist +5. **Add** all the new **MainViewController** and **AppDelegate** files into your Xcode project +6. **Copy** the **www/cordova-1.6.1.js** file from the new project into your **www** folder, and delete your **www/cordova-1.5.0.js** file +7. **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-1.6.1.js** file +8. **Add** the new **Cordova.plist** file into your project - this is because the core plugin service names needed to be changed to match the ones from Android and Blackberry, for a unified Cordova JavaScript file (cordova-js). +9. **Integrate** any settings, **Plugins** and **ExternalHosts** entries that you had in your **backed-up Cordova.plist** into the new **Cordova.plist** +10. **Integrate** any project specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files. Any **UIWebViewDelegate** or **CDVCommandDelegate** code in **AppDelegate.m** will need to go into MainViewController.m now (see commented out sections in that file) +11. **Integrate** any project specific code that you have in your **backed-up MainViewController.h and MainViewController.m** into the new MainViewController files +12. Click on the **project icon** in the Project Navigator, select your **Project**, then select the **"Build Settings"** tab +13. Enter **"Compiler for C/C++/Objective-C"** in the search field +14. Select the **"Apple LLVM Compiler 3.1"** value + + +## Upgrading Cordova 1.4.x projects to 1.5.0 ## + +1. **Install** Cordova 1.5.0 +2. **Create a new project** and run it once - you will have to grab assets from this new project +3. **Copy** the **www/cordova-1.5.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.4.x.js** file +4. **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 **cordova-1.5.0.js** file +5. Find **"PhoneGap.framework"** in your Project Navigator, select it +6. Press the **Delete** key and delete the **"PhoneGap.framework"** reference in the Project Navigator +7. Press the key combination **Option-Command-A**, which should drop down a sheet to add files to your project (the **"Add Files..." sheet**). Make sure the **"Created groups for any added folders"** radio-button is selected +8. Press the key combination **Shift-Command-G**, which should drop down another sheet for you to go to a folder (the **"Go to the folder:" sheet**) +9. Enter **"/Users/Shared/Cordova/Frameworks/Cordova.framework"** in the **"Go to the folder:" sheet** and then press the **"Go"** button +10. Press the **"Add"** button in the **"Add Files..." sheet** +11. **Select "Cordova.framework"** in the Project Navigator +12. Press the key combination **Option-Command-1** to show the **File Inspector** +13. Choose **"Absolute Path"** in the **File Inspector** for the drop-down menu for **Location** +14. Press the key combination **Option-Command-A**, which should drop down a sheet to add files to your project (the **"Add Files..." sheet**). Make sure the **"Created groups for any added folders"** radio-button is selected +15. Press the key combination **Shift-Command-G**, which should drop down another sheet for you to go to a folder (the **"Go to the folder:" sheet**) +16. Enter **"~/Documents/CordovaLib/Classes/deprecated"** in the **"Go to the folder:" sheet** and then press the **"Go"** button +17. Press the **"Add"** button in the **"Add Files..." sheet** +18. In your **AppDelegate.h, AppDelegate.m, and MainViewController.h** files - replace the whole **#ifdef PHONEGAP_FRAMEWORK** block with: + + #import "CDVDeprecated.h" +19. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab +20. Search for **"Framework Search Paths"** +21. Replace the existing value with **"/Users/Shared/Cordova/Frameworks"** +22. Search for **"Preprocessor Macros"** +23. For the first (combined) value, replace the value with **"CORDOVA_FRAMEWORK=YES"** +24. Select the **"Build Phases"** tab +25. Expand **"Run Script"** +26. Replace any occurrences of **PhoneGap** with **Cordova** +27. Find your **"PhoneGap.plist"** file in the Project Navigator, and click on the filename once to enter name edit mode +28. Rename **"PhoneGap.plist"** to **"Cordova.plist"** +29. Right-click on **"Cordova.plist"** and choose **"Open As" --> "Source Code"** +30. Press **Option-Command-F**, choose **"Replace"** from the drop-down on the top left of the Source window +31. Enter **com.phonegap** for the Find string, and **org.apache.cordova** for the Replace string - then press the **"Replace All"** button +32. Enter **PG** for the Find string, and **CDV** for the Replace string - then press the **"Replace All"** button +33. Press **Command-B** to build, you will still have deprecations that you can get rid of in the future (see **CDVDeprecated.h** - replace classes in your code that use PG* to CDV*, for example) + +## Upgrading Cordova 1.4.0 projects to 1.4.1 ## + +1. **Install** Cordova 1.4.1 +2. **Make a backup** of **MainViewController.m** +3. **Create a new project** - you will have to grab assets from this new project +4. **Copy** the **MainViewController.m** file from the **new** project into your 1.4.0 based project folder on disk, **replacing** the old file (**backup** your files first from step 2 above). +5. **Add** the **MainViewController.m** file into your Xcode project +6. **Integrate** any project specific code that you have in your **backed-up MainViewController.m** into the new file +7. Updating the phonegap-1.4.0.js file is optional, nothing has changed in the JavaScript between 1.4.0 and 1.4.1 + +## Upgrading Cordova 1.3.0 projects to 1.4.0 ## + +1. **Install** Cordova 1.4.0 +2. **Make a backup** of **AppDelegate.m** and **AppDelegate.h** in your project +3. **Create a new project** - you will have to grab assets from this new project +4. **Copy** these files from the **new** project into your 1.3.0 based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above): + + AppDelegate.h + AppDelegate.m + MainViewController.h + MainViewController.m + MainViewController.xib +5. **Add** all the **MainViewController** files into your Xcode project +6. **Copy** the **www/phonegap-1.4.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.3.0.js** file +7. **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 **phonegap-1.4.0.js** file +8. **Add** a new entry under **Plugins** in your **PhoneGap.plist** file - key is **com.phonegap.battery** and the value is **PGBattery** +9. **Integrate** any project specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files + +## Upgrading Cordova 1.2.0 projects to 1.3.0 ## + +1. **Install** Cordova 1.3.0 +2. **Make a backup** of **AppDelegate.m** and **AppDelegate.h** in your project +3. **Create a new project** - you will have to grab assets from this new project +4. **Copy** these files from the **new** project into your 1.2.0 based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above): + + AppDelegate.h + AppDelegate.m + MainViewController.h + MainViewController.m + MainViewController.xib +5. **Add** all the **MainViewController** files into your Xcode project +6. **Copy** the **www/phonegap-1.3.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.2.0.js** file +7. **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 **phonegap-1.3.0.js** file +8. **Add** a new entry under **Plugins** in your **PhoneGap.plist** file - key is **com.phonegap.battery** and the value is **PGBattery** +9. **Integrate** any project specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files + +## Upgrading Cordova 1.1.0 projects to 1.2.0 ## + +1. **Install** Cordova 1.2.0 +2. **Make a backup** of **AppDelegate.m** and **AppDelegate.h** in your project +3. **Create a new project** - you will have to grab assets from this new project +4. **Copy** these files from the **new** project into your 1.1.0 based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above): + + AppDelegate.h + AppDelegate.m + MainViewController.h + MainViewController.m + MainViewController.xib +5. **Add** all the **MainViewController** files into your Xcode project +6. **Copy** the **www/phonegap-1.2.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.1.0.js** file +7. **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 **phonegap-1.2.0.js** file +8. **Add** a new entry under **Plugins** in your **PhoneGap.plist** file - key is **com.phonegap.battery** and the value is **PGBattery** +9. **Integrate** any project specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files + +## Upgrading Cordova 1.0.0 projects to 1.1.0 ## + +1. **Install** Cordova 1.1.0 +2. **Make a backup** of **AppDelegate.m** and **AppDelegate.h** in your project +3. **Create a new project** - you will have to grab assets from this new project +4. **Copy** these files from the **new** project into your 1.0.0 based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above): + + AppDelegate.h + AppDelegate.m + MainViewController.h + MainViewController.m + MainViewController.xib +5. **Add** all the **MainViewController** files into your Xcode project +6. **Copy** the **www/phonegap-1.1.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.0.0.js** file +7. **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 **phonegap-1.1.0.js** file +8. **Add** a new entry under **Plugins** in your **PhoneGap.plist** file - key is **com.phonegap.battery** and the value is **PGBattery** +9. **Integrate** any project specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files + +## Upgrading Cordova 0.9.6 projects to 1.0.0 ## + +1. **Install** Cordova 1.0.0 +2. **Make a backup** of **AppDelegate.m** and **AppDelegate.h** in your project +3. **Create a new project** - you will have to grab assets from this new project +4. **Copy** these files from the **new** project into your 0.9.6 based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above): + + AppDelegate.h + AppDelegate.m + MainViewController.h + MainViewController.m + MainViewController.xib +5. **Add** all the **MainViewController** files into your Xcode project +6. **Copy** the **www/phonegap-1.0.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-0.9.6.js** file +7. **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 **phonegap-1.0.0.js** file +8. **Add** a new entry under **Plugins** in your **PhoneGap.plist** file - key is **com.phonegap.battery** and the value is **PGBattery** +9. **Integrate** any project specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/db65dd69/docs/en/2.8.0/guide/upgrading/symbian/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.8.0/guide/upgrading/symbian/index.md b/docs/en/2.8.0/guide/upgrading/symbian/index.md new file mode 100644 index 0000000..77c3d0e --- /dev/null +++ b/docs/en/2.8.0/guide/upgrading/symbian/index.md @@ -0,0 +1,21 @@ +--- +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 Cordova Symbian +========================= http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/db65dd69/docs/en/2.8.0/guide/upgrading/tizen/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.8.0/guide/upgrading/tizen/index.md b/docs/en/2.8.0/guide/upgrading/tizen/index.md new file mode 100644 index 0000000..e575141 --- /dev/null +++ b/docs/en/2.8.0/guide/upgrading/tizen/index.md @@ -0,0 +1,23 @@ +--- +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 Cordova Tizen +====================== + +This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/db65dd69/docs/en/2.8.0/guide/upgrading/webos/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.8.0/guide/upgrading/webos/index.md b/docs/en/2.8.0/guide/upgrading/webos/index.md new file mode 100644 index 0000000..0307833 --- /dev/null +++ b/docs/en/2.8.0/guide/upgrading/webos/index.md @@ -0,0 +1,38 @@ +--- +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 Cordova webOS +======================= + +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.5.0 from 2.4.0 ## + +1. remove cordova-2.4.0.js from your project + +2. update the following line in your index.html: + + change this: + + + to: + + +3. run the makefile to generate the newest version of the cordova-2.5.0.js file + http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/db65dd69/docs/en/2.8.0/guide/upgrading/windows-8/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.8.0/guide/upgrading/windows-8/index.md b/docs/en/2.8.0/guide/upgrading/windows-8/index.md new file mode 100644 index 0000000..3f87130 --- /dev/null +++ b/docs/en/2.8.0/guide/upgrading/windows-8/index.md @@ -0,0 +1,31 @@ +--- +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 Cordova Windows 8 +=============================== + +This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova. This applies to applications targetting Windows 8 and the Windows Store. + +## 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 ) +3. Build and test! http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/db65dd69/docs/en/2.8.0/guide/upgrading/windows-phone/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.8.0/guide/upgrading/windows-phone/index.md b/docs/en/2.8.0/guide/upgrading/windows-phone/index.md new file mode 100644 index 0000000..a027299 --- /dev/null +++ b/docs/en/2.8.0/guide/upgrading/windows-phone/index.md @@ -0,0 +1,228 @@ +--- +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 Cordova Windows Phone +=============================== + +This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova. This applies to both WP7 and WP8. + +## Upgrade to 2.8.0 from 2.7.0 ## + +### In Visual Studio's Solution Explorer window: +1. Create a new Apache Cordova WP7 or WP8 2.8.0 Project +2. Copy the contents of your 'www' folder to the new project, and be sure these items are added to the VS project. +3. Update your HTML to use the new cordova.js file. ( note that there is no longer a version number in the name ) +4. Copy and overwrite any splash screen, or icon images. +5. Copy over any plugins from the plugins folder to the new project and ensure that they are also added to the VS project. +6. Build and test. + +## Upgrade to 2.7.0 from 2.6.0 ## + +### In Visual Studio's Solution Explorer window: +1. Create a new Apache Cordova WP7 or WP8 2.7.0 Project +2. Copy the contents of your 'www' folder to the new project, and be sure these items are added to the VS project. +3. Update your HTML to use the new cordova-2.7.0.js file. +4. Copy and overwrite any splash screen, or icon images. +5. Copy over any plugins from the plugins folder to the new project and ensure that they are also added to the VS project. +6. Build and test. + +## Upgrade to 2.6.0 from 2.5.0 ## + +### In Visual Studio's Solution Explorer window: +1. Create a new Apache Cordova WP7 or WP8 2.6.0 Project +2. Copy the contents of your 'www' folder to the new project, and be sure these items are added to the VS project. +3. Update your HTML to use the new cordova-2.6.0.js file. +4. Copy and overwrite any splash screen, or icon images. +5. Copy over any plugins from the plugins folder to the new project and ensure that they are also added to the VS project. +6. Build and test. + +## Upgrade to 2.5.0 from 2.4.0 ## + +### In Visual Studio's Solution Explorer window: +1. Create a new Apache Cordova WP7 or WP8 2.5.0 Project +2. Copy the contents of your 'www' folder to the new project, and be sure these items are added to the VS project. +3. Update your HTML to use the new cordova-2.5.0.js file. +4. Copy and overwrite any splash screen, or icon images. +5. Copy over any plugins from the plugins folder to the new project and ensure that they are also added to the VS project. +6. Build and test. + +## Upgrade to 2.4.0 from 2.3.0 ## + +### In Visual Studio's Solution Explorer window: +1. Create a new Apache Cordova WP7 or WP8 2.4.0 Project +2. Copy the contents of your 'www' folder to the new project, and be sure these items are added to the VS project. +3. Update your HTML to use the new cordova-2.4.0.js file. +4. Copy and overwrite any splash screen, or icon images. +5. Copy over any plugins from the plugins folder to the new project and ensure that they are also added to the VS project. +6. Build and test. + +## Upgrade to 2.3.0 from 2.2.0 ## + +### In Visual Studio's Solution Explorer window: +1. Create a new Apache Cordova WP7 2.3.0 Project +2. Copy the contents of your 'www' folder to the new project, and be sure these items are added to the VS project. +3. Update your HTML to use the new cordova-2.3.0.js file. +4. Copy and overwrite any splash screen, or icon images. +5. Copy over any plugins from the plugins folder to the new project and ensure that they are also added to the VS project. +6. Build and test. + +## Upgrade to 2.2.0 from 2.1.0 ## + +### In Visual Studio's Solution Explorer window: +1. Create a new Apache Cordova WP7 2.2.0 Project +2. Copy the contents of your 'www' folder to the new project, and be sure these items are added to the VS project. +3. Update your HTML to use the new cordova-2.2.0.js file. +4. Copy and overwrite any splash screen, or icon images. +5. Copy over any plugins from the plugins folder to the new project and ensure that they are also added to the VS project. +6. Build and test. + +## Upgrade to 2.1.0 from 2.0.0 ## + +### In Visual Studio's Solution Explorer window: +1. Create a new Apache Cordova WP7 2.1.0 Project +2. Copy the contents of your 'www' folder to the new project, and be sure these items are added to the VS project. +3. Update your HTML to use the new cordova-2.1.0.js file. +4. Copy and overwrite any splash screen, or icon images. +5. Copy over any plugins from the plugins folder to the new project and ensure that they are also added to the VS project. +6. Build and test. + + +## Upgrade to 2.0.0 from 1.9.0 ## + +There have been considerable changes to the WP7 project structure in Apache Cordova 2.0.0 which make this upgrade a little more involved that the others. Essentially this is not an upgrade but creation of a new project and copy over of existing source files. + +### In Visual Studio's Solution Explorer window: +1. Create a new Apache Cordova WP7 2.0 Project +2. Copy the contents of your 'www' folder to the new project, and be sure these items are added to the VS project. +3. Update your HTML to use the new cordova-2.0.0.js file. +4. Copy and overwrite any splash screen, or icon images. +5. Copy over any plugins from the plugins folder to the new project and ensure that they are also added to the VS project. +6. Build and test. + + +## Upgrade to 1.9.0 from 1.8.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete the file GapLib/WP7CordovaClassLib.dll from your project. +2. Remove the reference to WP7CordovaClassLib in the References folder. +3. Right-Click on References and Select 'Add Reference' +4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + - note: you can view the version of the DLL by right-clicking on the reference, and selecting Properties. +5. Copy the new cordova-1.9.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.9.0.js file. + + +## Upgrade to 1.8.0 from 1.7.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete the file GapLib/WP7CordovaClassLib.dll from your project. +2. Remove the reference to WP7CordovaClassLib in the References folder. +3. Right-Click on References and Select 'Add Reference' +4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + - note: you can view the version of the DLL by right-clicking on the reference, and selecting Properties. +5. Copy the new cordova-1.8.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.8.0.js file. + +## Upgrade to 1.7.0 from 1.6.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete the file GapLib/WP7CordovaClassLib.dll from your project. +2. Remove the reference to WP7CordovaClassLib in the References folder. +3. Right-Click on References and Select 'Add Reference' +4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + - note: you can view the version of the DLL by right-clicking on the reference, and selecting Properties. +5. Copy the new cordova-1.7.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.7.0.js file. + +## Upgrade to 1.6.1 from 1.6.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete the file GapLib/WP7CordovaClassLib.dll from your project. +2. Remove the reference to WP7CordovaClassLib in the References folder. +3. Right-Click on References and Select 'Add Reference' +4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + - note: you can view the version of the DLL by right-clicking on the reference, and selecting Properties. +5. Copy the new cordova-1.6.1.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.6.1.js file. + +## Upgrade to 1.6.0 from 1.5.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete the file GapLib/WP7CordovaClassLib.dll from your project. +2. Remove the reference to WP7CordovaClassLib in the References folder. +3. Right-Click on References and Select 'Add Reference' +4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + - note: you can view the version of the DLL by right-clicking on the reference, and selecting Properties. +5. Copy the new cordova-1.6.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.6.0.js file. + +## Upgrade to 1.5.0 from 1.4.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete the file GapLib/WP7CordovaClassLib.dll from your project. +2. Remove the reference to WP7CordovaClassLib in the References folder. +3. Right-Click on References and Select 'Add Reference' +4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + - note: you can view the version of the DLL by right-clicking on the reference, and selecting Properties. +5. Copy the new cordova-1.5.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.5.0.js file. + +## Upgrade to 1.4.0 from 1.3.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete the file GapLib/WP7CordovaClassLib.dll from your project. +2. Remove the reference to WP7CordovaClassLib in the References folder. +3. Right-Click on References and Select 'Add Reference' +4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + - note: you can view the version of the DLL by right-clicking on the reference, and selecting Properties. +5. Copy the new cordova-1.4.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.4.0.js file. + +## Upgrade to 1.3.0 from 1.2.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete the file GapLib/WP7CordovaClassLib.dll from your project. +2. Remove the reference to WP7CordovaClassLib in the References folder. +3. Right-Click on References and Select 'Add Reference' +4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + - note: you can view the version of the DLL by right-clicking on the reference, and selecting Properties. +5. Copy the new cordova-1.3.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.3.0.js file. + +## Upgrade to 1.2.0 from 1.1.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete the file GapLib/WP7CordovaClassLib.dll from your project. +2. Remove the reference to WP7CordovaClassLib in the References folder. +3. Right-Click on References and Select 'Add Reference' +4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + - note: you can view the version of the DLL by right-clicking on the reference, and selecting Properties. +5. Copy the new cordova-1.2.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.2.0.js file. + +## Upgrade to 1.1.0 from 1.0.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete the file GapLib/WP7CordovaClassLib.dll from your project. +2. Remove the reference to WP7CordovaClassLib in the References folder. +3. Right-Click on References and Select 'Add Reference' +4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + - note: you can view the version of the DLL by right-clicking on the reference, and selecting Properties. +5. Copy the new cordova-1.1.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.1.0.js file. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/db65dd69/docs/en/2.8.0/guide/whitelist/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.8.0/guide/whitelist/index.md b/docs/en/2.8.0/guide/whitelist/index.md new file mode 100644 index 0000000..3ce1b09 --- /dev/null +++ b/docs/en/2.8.0/guide/whitelist/index.md @@ -0,0 +1,183 @@ +--- +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. +--- + +Domain Whitelist Guide +===================== + +Overview +-------- + +Domain whitelisting in Apache Cordova is a security model that controls access to outside domains, such as `http://google.com`. + +The default security policy is to allow all network access. Before moving your application to production, it is advised to review your application's whitelist. The application developer is encouraged to declare access to specific network domains and subdomains. + +Specification +------------- + +Domain whitelisting lays the ground work for the [W3C Widget Access][1] specification. In the Widget Access specification, the `` element is used to declare access to specific network domains. In the future, Apache Cordova will abstract the platform whitelisting implementations to the W3C Widget Access specification. However, for now each platform must implement it's own domain whitelisting. + +Syntax +------ + +Access to [google.com][2]: + + http://google.com + +Access to the secure [google.com][3] (`https://`): + + https://google.com + +Access to the subdomain [maps.google.com][4]: + + http://maps.google.com + +Access to all the subdomains on [google.com][2] (e.g. [mail.google.com][5] and [docs.google.com][6]): + + http://*.google.com + +Access to all domains (e.g. [google.com][2] and [developer.mozilla.org][7]): + + * + +Android +------- + +### Details + +The whitelisting rules are found in `res/xml/config.xml` and declared with the element ``. + +Android has full support for the whitelisting syntax. + +### Syntax + +Access to [google.com][2]: + + + +Bada +---- + +Domain whitelisting is unsupported on Bada. By default, all domains are accessible. + +BlackBerry +---------- + +### Details + +The whitelisting rules are found in `www/config.xml` and declared with the element ``. + +For a complete reference, see the [BlackBerry WebWorks Access Element documentation][8]. + +### Syntax + +Access to [google.com][2]: + + + +Access to [maps.google.com][4]: + + + +Access to all the subdomains on [google.com][2]: + + + +Access to all domains, including `file://` protocol: + + + +iOS +--- + +### Details + +The whitelisting rules are found in `AppName/config.xml` and declared with the element ``. + +iOS has full support for the whitelisting syntax. + +Note: origins specified without a protocol (i.e. `www.apache.org` instead of `http://www.apache.org`) will default to all of http, https, ftp, and ftps. + + +### Syntax + +Wildcards on iOS (`*`) are more flexible than the [W3C Widget Access][1] specification. + +Access to all subdomains and TLDs (`.com`, `.net`, etc): + + *.google.* + +Symbian +------- + +Domain whitelisting is unsupported on Symbian. By default, all domains are accessible. + +webOS +----- + +Domain whitelisting is unsupported on webOS. By default, all domains are accessible. + +Windows Phone (7 & 8) +--------------------- + +The whitelisting rules are found in `config.xml` and declared with the element ``. + +Android has full support for the whitelisting syntax. + +### Syntax + +Access to [google.com][2]: + + + +Tizen +---------- + +### Details + +The domain whitelisting rules are found in `config.xml` located in your application root directory. +They are declared with the element ``. +For a complete reference, see the [Tizen Accessing External Network Resources documentation][10]. + +### Syntax + +Access to [google.com][2]: + + + +Access to the secure [google.com][3] (`https://`): + + + +Access to all the subdomains on [google.com][2]: + + + +Access to all domains, including `file://` protocol: + + + +[1]: http://www.w3.org/TR/widgets-access/ +[2]: http://google.com +[3]: https://google.com +[4]: http://maps.google.com +[5]: http://mail.google.com +[6]: http://docs.google.com +[7]: http://developer.mozilla.org +[8]: https://developer.blackberry.com/html5/documentation/ww_developing/Access_element_834677_11.html +[9]: https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_4#8814682_CreatingaProject-AccessingExternalNetworkResources http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/db65dd69/docs/en/2.8.0/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.8.0/index.md b/docs/en/2.8.0/index.md new file mode 100644 index 0000000..da1890f --- /dev/null +++ b/docs/en/2.8.0/index.md @@ -0,0 +1,127 @@ +--- +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. +--- + +
+

API Reference

+
    +
  • +

    Accelerometer

    + Tap into the device's motion sensor. +
    • +
  • +

    Camera

    + Capture a photo using the device's camera. +
    • +
  • +

    Capture

    + Capture media files using device's media capture applications. +
    • +
  • +

    Compass

    + Obtain the direction that the device is pointing. +
    • +
  • +

    Connection

    + Quickly check the network state, and cellular network information. +
    • +
  • +

    Contacts

    + Work with the devices contact database. +
    • +
  • +

    Device

    + Gather device specific information. +
    • +
  • +

    Events

    + Hook into native events through JavaScript. +
    • +
  • +

    File

    + Hook into native file system through JavaScript. +
    • +
  • +

    Geolocation

    + Make your application location aware. +
    • +
  • +

    Globalization

    + Enable representation of objects specific to a locale. +
    • +
  • +

    InAppBrowser

    + Launch URLs in another in-app browser instance. +
    • +
  • +

    Media

    + Record and play back audio files. +
    • +
  • +

    Notification

    + Visual, audible, and tactile device notifications. +
    • +
  • +

    Splashscreen

    + Show and hide the applications splash screen. +
    • +
  • +

    Storage

    + Hook into the devices native storage options. +
    • +
+

Guides

+
    +
  • +

    Getting Started Guides

    + Setup each SDK and create your first Cordova app. +
    • +
  • +

    Command-Line Usage

    + Create, build, deploy, and debug from the command-line. +
    • +
  • +

    Privacy Guide

    + Learn about important mobile privacy issues. +
    • +
  • +

    Upgrading Guides

    + Upgrade an application to the latest Cordova release. +
    • +
  • +

    Project Settings

    + Customize the features of your app. +
    • +
  • +

    Plugin Development Guide

    + Develop your first Cordova plugin. +
    • +
  • +

    Domain Whitelist Guide

    + Grant an application access to external domains. +
    • +
  • +

    Embedding WebView

    + Implement the Cordova WebView in your project. +
    • +
  • +

    Keyword Index

    + Full index of the Cordova Documentation. +
    • +
+