You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by sh...@apache.org on 2012/08/27 22:08:19 UTC
docs commit: Updated iOS docs for 2.1.0
Updated Branches:
refs/heads/master 936e51347 -> 4143c446e
Updated iOS docs for 2.1.0
Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/commit/4143c446
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/4143c446
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/4143c446
Branch: refs/heads/master
Commit: 4143c446e3d7f65ddddd014378b7787567157de8
Parents: 936e513
Author: Shazron Abdullah <sh...@apache.org>
Authored: Mon Aug 27 13:08:14 2012 -0700
Committer: Shazron Abdullah <sh...@apache.org>
Committed: Mon Aug 27 13:08:14 2012 -0700
----------------------------------------------------------------------
docs/en/2.1.0rc1/guide/cordova-webview/ios.md | 39 +++++++--------
.../en/2.1.0rc1/guide/getting-started/ios/index.md | 14 ++----
docs/en/2.1.0rc1/guide/upgrading/ios/index.md | 10 +++-
docs/en/edge/guide/cordova-webview/ios.md | 39 +++++++--------
docs/en/edge/guide/getting-started/ios/index.md | 14 ++----
docs/en/edge/guide/upgrading/ios/index.md | 10 +++-
6 files changed, 62 insertions(+), 64 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/4143c446/docs/en/2.1.0rc1/guide/cordova-webview/ios.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/guide/cordova-webview/ios.md b/docs/en/2.1.0rc1/guide/cordova-webview/ios.md
index 30f1509..78197b6 100644
--- a/docs/en/2.1.0rc1/guide/cordova-webview/ios.md
+++ b/docs/en/2.1.0rc1/guide/cordova-webview/ios.md
@@ -40,19 +40,18 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
1. **Download and extract the Cordova source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova)
2. **Quit Xcode** if it is running.
3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-4. Type **make** and press **Enter**. This will update the $(CORDOVALIB) build setting in Xcode to point to the CordovaLib in the permanent folder location above.
-5. **Copy** the `Cordova.plist` file into your project folder on disk (see **Prerequisites** above)
-6. **Drag and drop** the `Cordova.plist` file into the Project Navigator of Xcode
-7. **Choose** the radio-button **"Create groups for any added folders"**, select the **Finish** button
-8. **Drag and drop** the `CordovaLib.xcodeproj` file into the Project Navigator of Xcode (from the permanent folder location above, and it should be in the CordovaLib sub-folder)
-9. Select `CordovaLib.xcodeproj` in the Project Navigator
-10. Press the key combination **Option-Command-1** to show the **File Inspector**
-11. Choose **"Relative to CORDOVALIB"** in the **File Inspector** for the drop-down menu for **Location**
-12. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
-13. Add `-all_load` and `-Obj-C` - for the **"Other Linker Flags"** value
-14. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Phases"** tab
-15. Expand **"Link Binaries with Libraries"**
-16. Select the **"+" button**, and add these **frameworks** (and optionally in the Project Navigator, **move** them under the Frameworks group):
+4. **Copy** the `Cordova.plist` file into your project folder on disk (see **Prerequisites** above)
+5. **Drag and drop** the `Cordova.plist` file into the Project Navigator of Xcode
+6. **Choose** the radio-button **"Create groups for any added folders"**, select the **Finish** button
+7. **Drag and drop** the `CordovaLib.xcodeproj` file into the Project Navigator of Xcode (from the permanent folder location above, and it should be in the CordovaLib sub-folder)
+8. Select `CordovaLib.xcodeproj` in the Project Navigator
+9. Press the key combination **Option-Command-1** to show the **File Inspector**
+10. Choose **"Relative to Group"** in the **File Inspector** for the drop-down menu for **Location**
+11. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
+12. Add `-all_load` and `-Obj-C` - for the **"Other Linker Flags"** value
+13. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Phases"** tab
+14. Expand **"Link Binaries with Libraries"**
+15. Select the **"+" button**, and add these **frameworks** (and optionally in the Project Navigator, **move** them under the Frameworks group):
AddressBook.framework
AddressBookUI.framework
@@ -65,14 +64,14 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
MobileCoreServices.framework
CoreMedia.framework
-17. Expand **"Target Dependencies"** - the top box labeled like this if you have multiple boxes!
-18. Select the **"+" button**, and add the `CordovaLib` build product
-19. Expand **"Link Binaries with Libraries"** - the top box labeled like
+16. Expand **"Target Dependencies"** - the top box labeled like this if you have multiple boxes!
+17. Select the **"+" button**, and add the `CordovaLib` build product
+18. Expand **"Link Binaries with Libraries"** - the top box labeled like
this if you have multiple boxes!
-20. Select the **"+" button**, and add `libCordova.a`
-21. Set the Xcode preference **"Xcode Preferences -> Locations -> Derived Data -> Advanced…"** to **"Unique"**
-22. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
-23. Search for **"Header Search Paths"**. For that setting, add these three values below (with quotes):
+19. Select the **"+" button**, and add `libCordova.a`
+20. Set the Xcode preference **"Xcode Preferences -> Locations -> Derived Data -> Advanced…"** to **"Unique"**
+21. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
+22. Search for **"Header Search Paths"**. For that setting, add these three values below (with quotes):
"$(TARGET_BUILD_DIR)/usr/local/lib/include"
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/4143c446/docs/en/2.1.0rc1/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/guide/getting-started/ios/index.md b/docs/en/2.1.0rc1/guide/getting-started/ios/index.md
index 4a0fba8..21cc987 100644
--- a/docs/en/2.1.0rc1/guide/getting-started/ios/index.md
+++ b/docs/en/2.1.0rc1/guide/getting-started/ios/index.md
@@ -44,19 +44,15 @@ Install the iOS SDK and Apache Cordova
Install CordovaLib
------------------
-1. **Download and extract the Cordova source** to a **permanent folder location** on your hard drive (for example, to ~/Documents/Cordova)
-2. **Quit Xcode** if it is running
-3. Launch **Terminal.app**
-4. Drag the permanent folder location of Cordova (from above) to the **Terminal.app** icon in your Dock, it should launch a new Terminal window
-4. Type in `make` then press **"Enter"**. This will update the **$(CORDOVALIB)** build setting in Xcode to point to the CordovaLib in the permanent folder location above, for Cordova projects to find the CordovaLib project
-
- 
+1. **Download** the Cordova source
+2. **Extract** to source to their final permanent location on your hard drive (for example, to ~/Documents/CordovaLib-2.X.X)
+3. There is no step 3
Create a New Project
--------------------
- Launch **Terminal.app**
-- Drag the **bin** folder (located in the permanent folder location of Cordova, from the **"Install Cordova"** section above) to the **Terminal.app** icon in your Dock, it should launch a new Terminal window
+- Drag the **bin** folder (located in the permanent folder location of Cordova, from the **"Install CordovaLib"** section above) to the **Terminal.app** icon in your Dock, it should launch a new Terminal window
- Type in `./create <project_folder_path> <package_name> <project_name>` then press **"Enter"**
<project_folder_path> is the path to your new Cordova iOS project (it must be empty if it exists)
@@ -104,8 +100,6 @@ Problems in Xcode
----------------
If you have compilation problems related to missing headers, the build products should **build into the same build directory**. You may need to set the preference **"Xcode Preferences -> Locations -> Derived Data -> Advanced…"** to **"Unique"**. This is the default setting for Xcode on a fresh new install, if you upgraded from older versions of Xcode, you might have a legacy preference in there that you need to update.
-Also, when installing **Cordova-2.0.0.pkg**, you must ensure Xcode is not running, if not certain Xcode variables won't be set.
-
Build Your App
--------------
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/4143c446/docs/en/2.1.0rc1/guide/upgrading/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.1.0rc1/guide/upgrading/ios/index.md b/docs/en/2.1.0rc1/guide/upgrading/ios/index.md
index 8ef3897..0edf6f9 100644
--- a/docs/en/2.1.0rc1/guide/upgrading/ios/index.md
+++ b/docs/en/2.1.0rc1/guide/upgrading/ios/index.md
@@ -24,17 +24,23 @@ Please note that **Xcode 4 is required**. To submit to the Apple App Store, you
## 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**.
-4. Type **make** and press **Enter**. This will update the **$(CORDOVALIB)** build setting in Xcode to point to the CordovaLib in the permanent folder location above.
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. 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)**
9. Remove the **VERSION** file reference from your **project** (**NOT** the one in CordovaLib)
+10. 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`
- 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.
## Upgrading Cordova 1.9.0 projects to 2.0.0 ##
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/4143c446/docs/en/edge/guide/cordova-webview/ios.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/ios.md b/docs/en/edge/guide/cordova-webview/ios.md
index 30f1509..78197b6 100644
--- a/docs/en/edge/guide/cordova-webview/ios.md
+++ b/docs/en/edge/guide/cordova-webview/ios.md
@@ -40,19 +40,18 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
1. **Download and extract the Cordova source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova)
2. **Quit Xcode** if it is running.
3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-4. Type **make** and press **Enter**. This will update the $(CORDOVALIB) build setting in Xcode to point to the CordovaLib in the permanent folder location above.
-5. **Copy** the `Cordova.plist` file into your project folder on disk (see **Prerequisites** above)
-6. **Drag and drop** the `Cordova.plist` file into the Project Navigator of Xcode
-7. **Choose** the radio-button **"Create groups for any added folders"**, select the **Finish** button
-8. **Drag and drop** the `CordovaLib.xcodeproj` file into the Project Navigator of Xcode (from the permanent folder location above, and it should be in the CordovaLib sub-folder)
-9. Select `CordovaLib.xcodeproj` in the Project Navigator
-10. Press the key combination **Option-Command-1** to show the **File Inspector**
-11. Choose **"Relative to CORDOVALIB"** in the **File Inspector** for the drop-down menu for **Location**
-12. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
-13. Add `-all_load` and `-Obj-C` - for the **"Other Linker Flags"** value
-14. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Phases"** tab
-15. Expand **"Link Binaries with Libraries"**
-16. Select the **"+" button**, and add these **frameworks** (and optionally in the Project Navigator, **move** them under the Frameworks group):
+4. **Copy** the `Cordova.plist` file into your project folder on disk (see **Prerequisites** above)
+5. **Drag and drop** the `Cordova.plist` file into the Project Navigator of Xcode
+6. **Choose** the radio-button **"Create groups for any added folders"**, select the **Finish** button
+7. **Drag and drop** the `CordovaLib.xcodeproj` file into the Project Navigator of Xcode (from the permanent folder location above, and it should be in the CordovaLib sub-folder)
+8. Select `CordovaLib.xcodeproj` in the Project Navigator
+9. Press the key combination **Option-Command-1** to show the **File Inspector**
+10. Choose **"Relative to Group"** in the **File Inspector** for the drop-down menu for **Location**
+11. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
+12. Add `-all_load` and `-Obj-C` - for the **"Other Linker Flags"** value
+13. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Phases"** tab
+14. Expand **"Link Binaries with Libraries"**
+15. Select the **"+" button**, and add these **frameworks** (and optionally in the Project Navigator, **move** them under the Frameworks group):
AddressBook.framework
AddressBookUI.framework
@@ -65,14 +64,14 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
MobileCoreServices.framework
CoreMedia.framework
-17. Expand **"Target Dependencies"** - the top box labeled like this if you have multiple boxes!
-18. Select the **"+" button**, and add the `CordovaLib` build product
-19. Expand **"Link Binaries with Libraries"** - the top box labeled like
+16. Expand **"Target Dependencies"** - the top box labeled like this if you have multiple boxes!
+17. Select the **"+" button**, and add the `CordovaLib` build product
+18. Expand **"Link Binaries with Libraries"** - the top box labeled like
this if you have multiple boxes!
-20. Select the **"+" button**, and add `libCordova.a`
-21. Set the Xcode preference **"Xcode Preferences -> Locations -> Derived Data -> Advanced…"** to **"Unique"**
-22. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
-23. Search for **"Header Search Paths"**. For that setting, add these three values below (with quotes):
+19. Select the **"+" button**, and add `libCordova.a`
+20. Set the Xcode preference **"Xcode Preferences -> Locations -> Derived Data -> Advanced…"** to **"Unique"**
+21. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
+22. Search for **"Header Search Paths"**. For that setting, add these three values below (with quotes):
"$(TARGET_BUILD_DIR)/usr/local/lib/include"
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/4143c446/docs/en/edge/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/ios/index.md b/docs/en/edge/guide/getting-started/ios/index.md
index 4a0fba8..21cc987 100644
--- a/docs/en/edge/guide/getting-started/ios/index.md
+++ b/docs/en/edge/guide/getting-started/ios/index.md
@@ -44,19 +44,15 @@ Install the iOS SDK and Apache Cordova
Install CordovaLib
------------------
-1. **Download and extract the Cordova source** to a **permanent folder location** on your hard drive (for example, to ~/Documents/Cordova)
-2. **Quit Xcode** if it is running
-3. Launch **Terminal.app**
-4. Drag the permanent folder location of Cordova (from above) to the **Terminal.app** icon in your Dock, it should launch a new Terminal window
-4. Type in `make` then press **"Enter"**. This will update the **$(CORDOVALIB)** build setting in Xcode to point to the CordovaLib in the permanent folder location above, for Cordova projects to find the CordovaLib project
-
- 
+1. **Download** the Cordova source
+2. **Extract** to source to their final permanent location on your hard drive (for example, to ~/Documents/CordovaLib-2.X.X)
+3. There is no step 3
Create a New Project
--------------------
- Launch **Terminal.app**
-- Drag the **bin** folder (located in the permanent folder location of Cordova, from the **"Install Cordova"** section above) to the **Terminal.app** icon in your Dock, it should launch a new Terminal window
+- Drag the **bin** folder (located in the permanent folder location of Cordova, from the **"Install CordovaLib"** section above) to the **Terminal.app** icon in your Dock, it should launch a new Terminal window
- Type in `./create <project_folder_path> <package_name> <project_name>` then press **"Enter"**
<project_folder_path> is the path to your new Cordova iOS project (it must be empty if it exists)
@@ -104,8 +100,6 @@ Problems in Xcode
----------------
If you have compilation problems related to missing headers, the build products should **build into the same build directory**. You may need to set the preference **"Xcode Preferences -> Locations -> Derived Data -> Advanced…"** to **"Unique"**. This is the default setting for Xcode on a fresh new install, if you upgraded from older versions of Xcode, you might have a legacy preference in there that you need to update.
-Also, when installing **Cordova-2.0.0.pkg**, you must ensure Xcode is not running, if not certain Xcode variables won't be set.
-
Build Your App
--------------
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/4143c446/docs/en/edge/guide/upgrading/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/ios/index.md b/docs/en/edge/guide/upgrading/ios/index.md
index 8ef3897..0edf6f9 100644
--- a/docs/en/edge/guide/upgrading/ios/index.md
+++ b/docs/en/edge/guide/upgrading/ios/index.md
@@ -24,17 +24,23 @@ Please note that **Xcode 4 is required**. To submit to the Apple App Store, you
## 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**.
-4. Type **make** and press **Enter**. This will update the **$(CORDOVALIB)** build setting in Xcode to point to the CordovaLib in the permanent folder location above.
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. 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)**
9. Remove the **VERSION** file reference from your **project** (**NOT** the one in CordovaLib)
+10. 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`
- 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.
## Upgrading Cordova 1.9.0 projects to 2.0.0 ##