Updated Branches:
refs/heads/master 7e38ea0a4 -> a778e4675
[CB-3822] Update iOS Getting Started guide.
Conflicts:
docs/en/edge/guide/getting-started/ios/index.md
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/ad38b118
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/ad38b118
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/ad38b118
Branch: refs/heads/master
Commit: ad38b11867375dec2b318731085a8a2ed245416c
Parents: 7e38ea0
Author: Mike Sierra <[email protected]>
Authored: Fri Jun 21 13:38:10 2013 -0400
Committer: Michael Brooks <[email protected]>
Committed: Tue Jul 2 14:22:40 2013 -0700
----------------------------------------------------------------------
docs/en/edge/guide/getting-started/ios/index.md | 254 +++++++------------
1 file changed, 86 insertions(+), 168 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/ad38b118/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 0ad73b2..758c46b 100644
--- a/docs/en/edge/guide/getting-started/ios/index.md
+++ b/docs/en/edge/guide/getting-started/ios/index.md
@@ -20,171 +20,133 @@ license: Licensed to the Apache Software Foundation (ASF)
under one
iOS Platform Guide
========================
-## Introduction ##
+## Requirements and Support
-Apache Cordova is a library used to create native mobile applications using
Web technologies. The application is created using HTML, CSS and JavaScript
and compiled for each specific platform using the platform native tools.
Cordova provides a standard set of JavaScript APIs to access device features on
all supported platforms. This document describes how to get started using
Apache Cordova for the iOS platform.
-### Requirements ###
-
-- **Intel-based Computer with Mac® OS X® Lion or greater (10.7.4+)**
+- __Intel-based Computer with Mac® OS X® Lion or greater (10.7.4+)__
The Apple® tools required for building iOS applications run only on the
OS X operating system. The version of the development environment required,
Xcode® 4.5, runs only on Mac OS X version 10.7 (Lion) or greater.
-- **Xcode 4.5 and iOS 6 SDK**
+- __Xcode 4.5 and iOS 6 SDK__
To submit apps to the Apple App Storeâ , you must use the latest
versions of the Apple tools. Currently the latest versions are Xcode 4.5.2 and
the iOS 6 SDK (Software Development Kit). The download of Xcode 4.5.2 includes
the iOS 6 SDK.
- - Download from the [App
Store](https://itunes.apple.com/us/app/xcode/id497799835?mt=12)
(https://itunes.apple.com/us/app/xcode/id497799835?mt=12).
- - Download from [Apple Developer
Downloads](https://developer.apple.com/downloads/index.action)
(https://developer.apple.com/downloads/index.action). __NOTE:__ This link
requires Apple Developer registration.
-
-- **Xcode Command Line Tools**
-
- Cordova uses the command line to create a new application project. To
access the Xcode tools from the command line an additional download is
required. The tools are downloaded from within Xcode.
- 1. Open Xcode
- 2. Select the following via the Xcode Menus: **Xcode Preferences>
Downloads>Command Line Tools**. This downloads and installs copies of the core
command-line tools and system headers into your computer's system folders.
-
-- **iOS Device**
-
- You can test many of the Cordova features using the iOS simulator
installed with the iOS SDK and Xcode, but you need an actual device to fully
test all of the device features your applications use before submitting to the
App Store. The device must have at least iOS 5.x installed, the minimum iOS
version supported as of Cordova 2.3. Devices that support at least iOS 5
include all iPad® models, iPhone® 3GS and above, and iPod® Touch 3rd
Generation or later. To install apps onto a device, you must also be a member
of Apple's [iOS Developer Program](https://developer.apple.com/programs/ios/).
The program costs $99 per year. This platform guide shows how to deploy the
application to the iOS simulator, in which case developer program registration
is not required.
-
-## Install Cordova
-
-### Download Cordova
-
-Download the latest version of [Apache
Cordova](http://www.apache.org/dist/cordova/) from
http://www.apache.org/dist/cordova/. Click on the Download icon and select
cordova-x.x.x-src.zip to download to your machine. The download includes the
code for all of the Apache Cordova supported platforms.
-### Extract Cordova
-
-To access the code, it needs to be extracted from the archive (.zip) file:
-
-1. Navigate to the folder where you downloaded the code. Find the
version-specific cordova-x.x.x-src.zip file.
-
-2. Using the Finder® app, double-click the file to extract. This creates a
directory named `cordova-x.x.x`.
-3. Expand this folder and locate the cordova-ios.zip file and double-click to
extract it.
+- __iOS Device__
-4. The code for iOS is within the cordova-ios directory structure.
+You can test many of the Cordova features using the iOS simulator
+installed with the iOS SDK and Xcode, but you need an actual device to
+fully test all of the device features your applications use before
+submitting to the App Store. The device must have at least iOS 5.x
+installed, the minimum iOS version supported as of Cordova 2.3.
+Devices that support at least iOS 5 include all iPad® models, iPhone®
+3GS and above, and iPod® Touch 3rd Generation or later. To install
+apps onto a device, you must also be a member of Apple's [iOS
+Developer Program](https://developer.apple.com/programs/ios/). The
+program costs $99 per year. This Getting Started guide shows how to
+deploy the application to the iOS simulator, in which case developer
+program registration is not required.
-## Project Creation
-Xcode projects for Cordova are created by invoking a script file via the
command line. The following steps explain how to create the necessary directory
structure, open and use the Terminal application to create a new project, and
execute the create script.
-### Determine Project Location
+## Install the SDK
-Determine where on your system to place your application's Xcode
-project files. This tutorial uses `~/Documents/CordovaXY`, where the
-'X' and 'Y' refer the to Cordova version number.
-
-1. In the Finder, navigate to the `Documents` directory.
-
-2. Create a subdirectory within `Documents` called `CordovaXY`, where the 'X'
and 'Y' represent the Cordova version number (23, for example). You can use a
different directory name or location if you wish, but you need to remember it
for subsequent steps.
-
-### Open Terminal
-
-1. Open the Terminal application, located by default in the
`Applications/Utilities` folder.
-
-3. Use the Finder to navigate to the `cordova-ios` directory from the
downloaded and extracted Cordova code. Highlight the `bin` subdirectory as
shown:
+ - Download from the [App
Store](https://itunes.apple.com/us/app/xcode/id497799835?mt=12)
(https://itunes.apple.com/us/app/xcode/id497799835?mt=12).
+ - Download from [Apple Developer
Downloads](https://developer.apple.com/downloads/index.action)
(https://developer.apple.com/downloads/index.action). __NOTE:__ This link
requires Apple Developer registration.
- 
+- __Xcode Command Line Tools__
- __NOTE:__ Your listing varies depending on Cordova's version number.
+ Cordova uses the command line to create a new application project. To
access the Xcode tools from the command line an additional download is
required. The tools are downloaded from within Xcode.
+ 1. Open Xcode
+ 2. Select the following via the Xcode Menus: __Xcode Preferences →
Downloads →Command Line Tools__. This downloads and installs copies of
the core command-line tools and system headers into your computer's system
folders.
-4. Drag this directory to the open the Terminal icon in the dock. This opens
up a default terminal window with the path set to the `bin` directory.
+## Open a Project in the SDK
-### Create New Project
+Using the Finder app, navigate to the location where you created the
+project. This guide uses `~/Documents/CordovaXY/HelloWorld`.
+Double-click the `HelloWorld.xcodeproj` file to open the project in
+Xcode.
-#### Command Line Syntax
+Your screen should look similar to:
- 1. Determine Required Parameters
+
- Three parameters are required to creating a Cordova project from the command
line, in this order:
+## Deploy to Emulator
- 1. **project location**
+ 1. In the upper-left corner of Xcode, click on the Scheme drop-down list and
select the project name, HelloWorld, as the target.
+ 2. Click the device section and select an iOS Simulator such as iPhone 6.0
Simulator as shown:
+
- This directory is where the Xcode project and application files are to
be located. This tutorial uses `~/Documents/CordovaXY` as the base location
(with 'X' and 'Y' representing the Cordova version number) and the `HelloWorld`
application name as the project directory. Since the command creates the final
`HelloWorld` directory, it must not already exist.
+ 3. Click the __Run__ button in your project window's toolbar to build,
deploy and run the application in the simulator.
- 2. **package name**
- When submitting apps to the App Store, this must be the reverse domain
name App ID that is created via the Apple Provisioning Portal (described in the
Deploy to Device section). The Provisioning Portal is accessible once you have
paid for and signed into your iOS Developer Account. Since you don't need to
submit this sample app, this tutorial uses `org.apache.Cordova` plus the
`HelloWorld` app name: `org.apache.cordova.HelloWorld`
- 3. **project name**
- This is the name of the actual project. Most developers match the
project name with the application name, so in this example it's `HelloWorld`.
- 2. Execute the Command
+## Deploy to Device
- In the terminal app with bin as the current directory, enter the 3 pieces of
information via the following command:
- `./create ~/Documents/CordovaXY/HelloWorld org.apache.cordova.HelloWorld
HelloWorld`
+ There are several requirements to deploy to a device. Since this information
is not related directly to Cordova, please refer to the _Configuring
Development and Distribution Assets_ section of Apple's [Tools Workflow Guide
for
iOS](http://developer.apple.com/library/ios/#documentation/Xcode/Conceptual/ios_development_workflow/00-About_the_iOS_Application_Development_Workflow/introduction.html#//apple_ref/doc/uid/TP40007959).
- 
+ - Join the Apple iOS Developer Program
- 3. Fix Common Problems
+ - Create a Provisioning Profile within the [iOS Provisioning
Portal](https://developer.apple.com/ios/manage/overview/index.action). You
can use the Development Provisioning Assistant within the Provisioning Portal
to create and install the profile and certificate for use within Xcode.
- **No Developer Directory Found**
+ - Verify that the Code Signing Identity in the Code Signing sections of the
Hello World Xcode project settings has been set with your provisioning profile
name.
- The âError: No developer directory found at /Developerâ message is
displayed if the create script can not find the location of the command-line
tools within Xcode. This can occur if more than one version of Xcode is
installed on the system or when upgrading from older versions of Xcode. The
solution is to run the xcode-select command to set the location. If you have
installed Xcode in the default location the command to execute is:
+ Deployment Steps:
- sudo /usr/bin/xcode-select -switch
/Applications/Xcode.app/Contents/Developer
+ 1. Plug your device into your Mac via the USB Cable.
+ 2. Select the Target and device
- See
[http://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/xcode-select.1.html](http://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/xcode-select.1.html)
for more information on the xcode-select command if you have installed Xcode
in a different location.
+ 1. In the upper-left corner of the Xcode window, click the Scheme
drop-down list and select the project name, HelloWorld, as the target.
+ 2. Click the device section and select your device from the list. If your
device is plugged in via the USB but not visible in the device list, click the
__Organizer__ button to determine any errors.
-#### Optional Features
+ 3. Click the __run__ button to build, deploy and run the application on your
device.
- - **Additional Parameters**
+## Results
- The default create script copies the necessary common library files from the
Cordova distribution directory into your Xcode project directory. These files
appear within the project's `CordovaLib` directory. Some development
organizations prefer that developers reference the common Cordova library files
from a fixed location, which helps ensure that all developers use the exact
same copy of the CordovaLib code. To do this, add the `--shared` parameter to
the `create` command. The following command creates a project that references
the CordovaLib directory from the iOS directory location in which you run the
`create` script:
+ The running HelloWorld app is shown below. The Device is Ready line should
be slowly pulsating.
- ./create --shared ~/Documents/CordovaXY/HelloWorld
org.apache.cordova.HelloWorld HelloWorld
- The Xcode project files are still in the
`~/Documents/CordovaXY/HelloWorld` directory, but the CordovaLib files are
referenced from the Cordova distribution directory.
- - **Additional Scripts**
+ 
- Within the cordova-ios/bin directory there is an additional script that
changes the location of the CordovaLib directory to refer to a shared location
after the project has been created,
- ./update_cordova_subproject path/to/your/project
+## Common Problems
- Most users are satisfied with the default project creation procedure and do
not need this additional script. This script uses the location of CordovaLib
directory at the same directory level as the bin directory from which it is run
as the shared location for CordovaLib. To modify the newly created HelloWorld
project to use a shared location for CordovaLib, execute the following command
from the `bin` directory:
+ - [Start Developing iOS Apps
Today](http://developer.apple.com/library/ios/#referencelibrary/GettingStarted/RoadMapiOS/index.html#//apple_ref/doc/uid/TP40011343)
provides a quick overview of steps for developing iOS Apps.
+ - [Member Center home
page](https://developer.apple.com/membercenter/index.action) provides links to
several iOS technical resources including technical resources, the provisioning
portal, distribution guides and community forums.
+ - [Tools Workflow Guide for
iOS](http://developer.apple.com/library/ios/#documentation/Xcode/Conceptual/ios_development_workflow/00-About_the_iOS_Application_Development_Workflow/introduction.html#//apple_ref/doc/uid/TP40007959)
+ - [Xcode 4 User
Guide](http://developer.apple.com/library/ios/#documentation/ToolsLanguages/Conceptual/Xcode4UserGuide/000-About_Xcode/about.html#//apple_ref/doc/uid/TP40010215)
+ - [Session Videos](https://developer.apple.com/videos/wwdc/2012/) from the
Apple World Wide Developer Conference 2012 (WWDC2012)
- ./update_cordova_subproject ~/Documents/CordovaXY/HelloWorld
+~~~
-## Running the Application
-### Open the Project
- Using the Finder app, navigate to the location where you created the
project. This guide uses `~/Documents/CordovaXY/HelloWorld`. Double-click the
`HelloWorld.xcodeproj` file to open the project in Xcode.
- Your screen should look similar to:
-
- __NOTE:__ this screen capture shows a project that was created with the name
as HelloWorld23.
-### Deploy to the Simulator
- 1. In the upper-left corner of Xcode, click on the Scheme drop-down list and
select the project name, HelloWorld, as the target.
- 2. Click the device section and select an iOS Simulator such as iPhone 6.0
Simulator as shown:
-
- 3. Click the **Run** button in your project window's toolbar to build,
deploy and run the application in the simulator.
+### Building Your Own Applications
-### Deploy to the Device
+ __Include Cordova__
-#### Requirements
+ All of the code for the sample application is contained within the
+ Xcode project's `www` directory, where the starting page is named
+ `index.html`. Any page that invokes Cordova APIs must reference the
+ version-specific `cordova-x.x.x.js` file, as shown in the sample
+ `HelloWorld` application's `index.html`:
- There are several requirements to deploy to a device. Since this information
is not related directly to Cordova, please refer to the _Configuring
Development and Distribution Assets_ section of Apple's [Tools Workflow Guide
for
iOS](http://developer.apple.com/library/ios/#documentation/Xcode/Conceptual/ios_development_workflow/00-About_the_iOS_Application_Development_Workflow/introduction.html#//apple_ref/doc/uid/TP40007959).
+ <script type="text/javascript" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" src="js/index.js"></script>
+ <script type="text/javascript">
+ app.initialize();
+ </script>
- - Join the Apple iOS Developer Program
- - Create a Provisioning Profile within the [iOS Provisioning
Portal](https://developer.apple.com/ios/manage/overview/index.action). You
can use the Development Provisioning Assistant within the Provisioning Portal
to create and install the profile and certificate for use within Xcode.
- - Verify that the Code Signing Identity in the Code Signing sections of the
Hello World Xcode project settings has been set with your provisioning profile
name.
-#### Deployment Steps
- 1. Plug your device into your Mac via the USB Cable.
- 2. Select the Target and device
-
- 1. In the upper-left corner of the Xcode window, click the Scheme
drop-down list and select the project name, HelloWorld, as the target.
- 2. Click the device section and select your device from the list. If your
device is plugged in via the USB but not visible in the device list, click the
**Organizer** button to determine any errors.
- 3. Click the **run** button to build, deploy and run the application on your
device.
+### Credits
-## Results
+ Mac®, OS X®, Apple®, Xcode®, App Storeâ , iPad®, iPhone®, iPod® and
Finder® are Trademarks of Apple Inc.
- The running HelloWorld app is shown below. The Device is Ready line should
be slowly pulsating.
+## Common Problems
- 
-## Common Problems
### Deprecation Warnings
@@ -238,86 +200,45 @@ references the deprecated invokeString API:
Some users have encountered compilation errors relating to missing headers.
This refers to a problem in the build location and is fixed via Xcode
preferences.
- 1. Within the Xcode menus select **Xcode → Preferences →
Locations**.
+ 1. Within the Xcode menus select __Xcode → Preferences →
Locations__.
2. In the __Derived Data__ section click the __Advanced__ button and select
__Unique__ as the __Build Location_ as shown:
This is the default setting for a new Xcode install, but it may be set
differently if you upgraded from an older version of Xcode.
-## Next Steps
-### Building Your Own Applications
- **Include Cordova**
- All of the code for the sample application is contained within the
- Xcode project's `www` directory, where the starting page is named
- `index.html`. Any page that invokes Cordova APIs must reference the
- version-specific `cordova-x.x.x.js` file, as shown in the sample
- `HelloWorld` application's `index.html`:
+ 3. Fix Common Problems
- <script type="text/javascript" src="cordova-x.x.x.js"></script>
- <script type="text/javascript" src="js/index.js"></script>
- <script type="text/javascript">
- app.initialize();
- </script>
+ __No Developer Directory Found__
- **Wait for deviceReady Event**
+ The âError: No developer directory found at /Developerâ message is
displayed if the create script can not find the location of the command-line
tools within Xcode. This can occur if more than one version of Xcode is
installed on the system or when upgrading from older versions of Xcode. The
solution is to run the xcode-select command to set the location. If you have
installed Xcode in the default location the command to execute is:
- When loading a page, Cordovaâs `deviceReady` event must fire before you
can access any of the platform features via the Cordova JavaScript APIs.
Within the sample application this is set up within the app object found within
the js/index.js file. The app.initialze() call at the bottom of the
`index.html` file (visible in the previous code example) sets in motion the
binding of events to receive and respond to the `deviceReady` event.
+ sudo /usr/bin/xcode-select -switch
/Applications/Xcode.app/Contents/Developer
- Another common way to initialize a page is to add a `deviceReady` event
listener from the body's `onload` event handler as shown below:
+ See
[http://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/xcode-select.1.html](http://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/xcode-select.1.html)
for more information on the xcode-select command if you have installed Xcode
in a different location.
- <head>
- <script type="text/javascript" src="cordova-x.x.x.js"></script>
- <script>
- function onLoad() {
- document.addEventListener(
- âdevicereadyâ, onDeviceReady, false);
- }
- function onDeviceReady() {
- // do Something!
- // example: display a Cordova Alert
- // see docs.cordova.io for full details
- navigator.notification.alert(
- 'Cordova is ready!', Â // message
- function() {//do something}, Â // callback
- 'Congratulations', Â Â Â Â Â Â // title
- 'Done' Â Â Â Â Â Â Â Â Â // buttonName
- );
- }
- </script>
- </head>
- <body onload=âonLoad();â>
- .....
-###Code Your Application
- Replace the sample code in the `www` directory of a new project with the
HTML, JavaScript and CSS code for your application. The name of the initial
file to load when the app is launched should be `index.html` (advanced users
can change this if necessary). As demonstrated in the HelloWorld sample
application, subdirectories within the `www` directory are permitted. Note
that the `www` directory is readonly, you can not write information to this
directory during app execution. If you need to store information use the
Cordova File or Storage APIs.
- You can use many mobile JavaScript frameworks with Cordova to create the UI
and page navigation of your application. Popular ones include:
+ - __Additional Parameters__
- - JQuery Mobile
- - Dojo Mobile
- - Sencha Touch
+ The default create script copies the necessary common library files from the
Cordova distribution directory into your Xcode project directory. These files
appear within the project's `CordovaLib` directory. Some development
organizations prefer that developers reference the common Cordova library files
from a fixed location, which helps ensure that all developers use the exact
same copy of the CordovaLib code. To do this, add the `--shared` parameter to
the `create` command. The following command creates a project that references
the CordovaLib directory from the iOS directory location in which you run the
`create` script:
-### Modify Project Settings
+ ./create --shared ~/Documents/CordovaXY/HelloWorld
org.apache.cordova.HelloWorld HelloWorld
+ The Xcode project files are still in the
`~/Documents/CordovaXY/HelloWorld` directory, but the CordovaLib files are
referenced from the Cordova distribution directory.
+ - __Additional Scripts__
- There are many additional considerations to make your application unique.
The sample HelloWorld application is set up to run in all iOS environments,
iPhone, iPod, and iPad. You can design an app for a single device type by
modifying the build settings within Xcode.
+ Within the cordova-ios/bin directory there is an additional script that
changes the location of the CordovaLib directory to refer to a shared location
after the project has been created,
- You should customize the application with your own icons and splash screens.
The sample application includes Cordova specific images in the Apple required
sizes and resolutions as examples. The Cordova Specific settings are located
in the config.xml file and documented in the Cordova Project Settings Guide.
Refer to the Resources section for more Apple specific information about
building iOS Apps.
+ ./update_cordova_subproject path/to/your/project
-## Resources
+ Most users are satisfied with the default project creation procedure and do
not need this additional script. This script uses the location of CordovaLib
directory at the same directory level as the bin directory from which it is run
as the shared location for CordovaLib. To modify the newly created HelloWorld
project to use a shared location for CordovaLib, execute the following command
from the `bin` directory:
-### Apple
+ ./update_cordova_subproject ~/Documents/CordovaXY/HelloWorld
- Some of these references are within the Apple iOS Developer Reference and
require an iOS Developer License.
- - [Start Developing iOS Apps
Today](http://developer.apple.com/library/ios/#referencelibrary/GettingStarted/RoadMapiOS/index.html#//apple_ref/doc/uid/TP40011343)
provides a quick overview of steps for developing iOS Apps.
- - [Member Center home
page](https://developer.apple.com/membercenter/index.action) provides links to
several iOS technical resources including technical resources, the provisioning
portal, distribution guides and community forums.
- - [Tools Workflow Guide for
iOS](http://developer.apple.com/library/ios/#documentation/Xcode/Conceptual/ios_development_workflow/00-About_the_iOS_Application_Development_Workflow/introduction.html#//apple_ref/doc/uid/TP40007959)
- - [Xcode 4 User
Guide](http://developer.apple.com/library/ios/#documentation/ToolsLanguages/Conceptual/Xcode4UserGuide/000-About_Xcode/about.html#//apple_ref/doc/uid/TP40010215)
- - [Session Videos](https://developer.apple.com/videos/wwdc/2012/) from the
Apple World Wide Developer Conference 2012 (WWDC2012)
### Apache Cordova
@@ -327,6 +248,3 @@ references the deprecated invokeString API:
- [PhoneGap google
group](https://groups.google.com/forum/?fromgroups=%23!forum/phonegap) to
discuss and ask questions about Cordova. This forum is monitored by Cordova
developers as well as users. When posting please include the platform, device
type, Cordova version and as many details as possible about the error or
problem.
- File Cordova bugs at
[https://issues.apache.org/jira/browse/CB](https://issues.apache.org/jira/browse/CB)
-### Credits
-
- Mac®, OS X®, Apple®, Xcode®, App Storeâ , iPad®, iPhone®, iPod® and
Finder® are Trademarks of Apple Inc.
