You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/06/12 19:50:41 UTC
[06/46] docs commit: many copy edits; nonlinear search/destroy edits;
needs a more controlled pass
many copy edits; nonlinear search/destroy edits; needs a more controlled pass
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/726c9630
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/726c9630
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/726c9630
Branch: refs/heads/master
Commit: 726c9630c3665e6a608e240c1a5ca35bc268379e
Parents: d33b887
Author: Mike Sierra <le...@gmail.com>
Authored: Mon Apr 29 11:19:25 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon Apr 29 11:19:25 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/command-line/index.md | 41 ++---
docs/en/edge/guide/cordova-webview/android.md | 54 +++---
docs/en/edge/guide/cordova-webview/index.md | 4 +-
docs/en/edge/guide/cordova-webview/ios.md | 34 ++--
.../edge/guide/getting-started/android/index.md | 52 +++---
.../en/edge/guide/getting-started/bada/index.md | 32 ++--
.../guide/getting-started/blackberry/index.md | 30 ++--
docs/en/edge/guide/getting-started/index.md | 4 +-
docs/en/edge/guide/getting-started/ios/index.md | 166 ++++++++++---------
.../edge/guide/getting-started/symbian/index.md | 12 +-
.../edge/guide/getting-started/tizen/index.md | 4 +-
.../edge/guide/getting-started/webos/index.md | 13 +-
.../guide/getting-started/windows-8/index.md | 26 +--
.../getting-started/windows-phone-7/index.md | 54 +++---
.../getting-started/windows-phone-8/index.md | 78 +++++----
.../guide/plugin-development/android/index.md | 72 ++++----
.../edge/guide/plugin-development/bada/index.md | 14 +-
.../plugin-development/blackberry/index.md | 113 +++++++------
docs/en/edge/guide/plugin-development/index.md | 50 +++---
.../edge/guide/plugin-development/ios/index.md | 85 +++++++---
.../plugin-development/windows-phone/index.md | 35 ++--
.../edge/guide/project-settings/bada/index.md | 2 +-
.../guide/project-settings/blackberry/index.md | 8 +-
.../guide/project-settings/firefoxos/index.md | 2 +-
docs/en/edge/guide/project-settings/index.md | 19 ++-
.../en/edge/guide/project-settings/ios/index.md | 2 +-
.../edge/guide/project-settings/webos/index.md | 4 +-
.../guide/project-settings/windows8/index.md | 2 +-
.../en/edge/guide/project-settings/wp7/index.md | 4 +-
docs/en/edge/guide/upgrading/bada/index.md | 11 +-
docs/en/edge/guide/upgrading/ios/index.md | 72 ++++----
docs/en/edge/guide/upgrading/webos/index.md | 6 +-
docs/en/edge/guide/whitelist/index.md | 35 ++--
33 files changed, 631 insertions(+), 509 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/command-line/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/command-line/index.md b/docs/en/edge/guide/command-line/index.md
index b235cf2..29ee41d 100644
--- a/docs/en/edge/guide/command-line/index.md
+++ b/docs/en/edge/guide/command-line/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
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
@@ -37,7 +37,7 @@ Cordova projects.
## Windows Phone 8
-The Windows Phone 8 command line tools support creating new projects.
+The Windows Phone 8 command-line tools support creating new projects.
### Create a project
@@ -123,8 +123,9 @@ or, on **Windows**
$ /path/to/my_new_cordova_project/cordova/run.bat
-Make sure you have created at least one Android Virtual Device. If you did not it will ask you to create one with the `android` command.
-If you have multiple AVDs, it will prompt you to select an AVD.
+Make sure you create at least one Android Virtual Device, otherwise
+you're prompted to do so with the `android` command. If you have
+multiple AVDs, you're prompted to select one.
### Logging
@@ -171,18 +172,20 @@ or, on **Windows**
$ /path/to/cordova-blackberry-webworks/bin/create.bat /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
-Note: the package name placeholder (com.example.cordova_project_name) is ignored on the Blackberry platform, but is required for use of the crossplatform tools
+__NOTE:__ The Blackberry platform ignores the package name placeholder
+(`com.example.cordova_project_name`), but it's still required for use by
+cross-platform tools.
### Build a project
For BlackBerry projects, please make sure you customize the
-`project.properties` file in the root of your Cordova project folder.
-This is necessary for things like supplying your BlackBerry signing key
-password, location of the BlackBerry WebWorks SDK, and location of
-BlackBerry simulator executables.
+`project.properties` file in your Cordova project's root directory.
+You need to do so to supply your BlackBerry signing key password, and
+specify locations for the BlackBerry WebWorks SDK and BlackBerry
+simulator executables.
$ /path/to/my_new_cordova_project/cordova/build <platform>
-
+
or, on **Windows**
$ /path/to/my_new_cordova_project/cordova/build.bat <platform>
@@ -191,24 +194,24 @@ or, on **Windows**
For BlackBerry projects, please make sure you customize the
`project.properties` file in the root of your Cordova project folder.
-This is necessary for things like supplying your BlackBerry signing key
-password, location of the BlackBerry WebWorks SDK, and location of
-BlackBerry simulator executables.
+You need to do so to supply your BlackBerry signing key password, and
+specify locations for the BlackBerry WebWorks SDK and BlackBerry
+simulator executables.
$ /path/to/my_new_cordova_project/cordova/run <platform>
-
-and then choose 'no' when prompted with:
+
+and then choose 'no' when prompted with:
Do you have a BlackBerry device connected to your computer? (y/n)
-
+
or, on **Windows**
$ /path/to/my_new_cordova_project/cordova/run <platform>
-and then choose 'no' when prompted with:
+and then choose 'no' when prompted with:
Do you have a BlackBerry device connected to your computer? (y/n)
-
+
### Logging
Unfortunately streaming logs directly from the device is not
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/cordova-webview/android.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/android.md b/docs/en/edge/guide/cordova-webview/android.md
index 6dfeafe..dd94819 100644
--- a/docs/en/edge/guide/cordova-webview/android.md
+++ b/docs/en/edge/guide/cordova-webview/android.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
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
@@ -20,13 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Embedding Cordova WebView on Android
====================================
-Beginning in Cordova 1.9, with the assistance of the `CordovaActivity`, you can use Cordova as a component in a larger native Android application. This component is known in Android
-as the `CordovaWebView`. New Cordova-based applications from 1.9 onwards will be using the `CordovaWebView` as its main view, whether the legacy `DroidGap` approach is
-used or not.
+Beginning in Cordova 1.9, with the assistance of the
+`CordovaActivity`, you can use Cordova as a component in a larger
+native Android application. Android refers to this component as the
+`CordovaWebView`. New Cordova-based applications from 1.9 onwards use
+the `CordovaWebView` as its main view, regardless of whether the
+legacy `DroidGap` approach is used.
-The prerequisites are the same as the prerequisites for Android application development. It is assumed that you are familiar with Android development. If not, please
-look at the Getting Started guide to developing a Cordova Application and start there before continuing with this approach. This is not the main approach used
-to author Android Cordova applications. Thus the instructions are currently manual. In the future, we may try to further automate project generation via this method.
+If you're unfamiliar with Android application development, please read
+the Getting Started guide to developing a Cordova Application before
+attempting to include a WebView. It's not the main way to author
+Android Cordova applications. These instructions are currently manual,
+but may be eventually be automated.
Prerequisites
-------------
@@ -37,19 +42,17 @@ Prerequisites
Guide to using CordovaWebView in an Android Project
---------------------------------------------------
-1. Use `bin/create` to fetch the commons-codec-1.6.jar
-2. `cd` into `/framework` and run `ant jar` to build the cordova jar (it
- will create the .jar file in the form `cordova-x.x.x.jar` in the
- `/framework` folder)
-3. Copy the cordova jar into your Android project's `/libs` directory
-4. Edit your application's `main.xml` file (under `/res/xml`) to look similar the following. The `layout_height`, `layout_width` and `id` can be modified to suit your application
+1. Use `bin/create` to fetch the `commons-codec-1.6.jar` file.
+2. `cd` into `/framework` and run `ant jar` to build the cordova jar. It creates the .jar file formed as `cordova-x.x.x.jar` in the `/framework` folder.
+3. Copy the cordova jar into your Android project's `/libs` directory.
+4. Edit your application's `main.xml` file (under `/res/xml`) to look like the following, with the `layout_height`, `layout_width` and `id` modified to suit your application:
<org.apache.cordova.CordovaWebView
android:id="@+id/tutorialView"
android:layout_width="match_parent"
android:layout_height="match_parent" />
-5. Modify your activity so that it implements the `CordovaInterface`. It is recommended that you implement the methods that are included. You may wish to copy the methods from `/framework/src/org/apache/cordova/DroidGap.java`, or you may wish to implement your own methods. Below is a fragment of code from a basic application that uses the interface (note how the view id referenced matches the `id` attribute specified in the above XML fragment from step 4):
+5. Modify your activity so that it implements the `CordovaInterface`. You should implement the included methods. You may wish to copy them from `/framework/src/org/apache/cordova/DroidGap.java`, or implement them on your own. The code fragment below shows a basic application that uses the interface. Note how the referenced view id matches the `id` attribute specified in the XML fragment shown above:
public class CordovaViewTestActivity extends Activity implements CordovaInterface {
CordovaWebView cwv;
@@ -63,15 +66,15 @@ Guide to using CordovaWebView in an Android Project
cwv.loadUrl(Config.getStartUrl());
}
-In addition to this, if you are using camera, you will want to implement this as well:
+ If you use the camera, you should also implement this:
@Override
public void setActivityResultCallback(CordovaPlugin plugin) {
- this.activityResultCallback = plugin;
+ this.activityResultCallback = plugin;
}
/**
- * Launch an activity for which you would like a result when it finished. When this activity exits,
- * your onActivityResult() method will be called.
+ * Launch an activity for which you would like a result when it finished. When this activity exits,
+ * your onActivityResult() method is called.
*
* @param command The command object
* @param intent The intent to start
@@ -80,16 +83,16 @@ In addition to this, if you are using camera, you will want to implement this as
public void startActivityForResult(CordovaPlugin command, Intent intent, int requestCode) {
this.activityResultCallback = command;
this.activityResultKeepRunning = this.keepRunning;
-
+
// If multitasking turned on, then disable it for activities that return results
if (command != null) {
this.keepRunning = false;
}
-
+
// Start activity
super.startActivityForResult(intent, requestCode);
}
-
+
@Override
/**
* Called when an activity you launched exits, giving you the requestCode you started it with,
@@ -108,13 +111,12 @@ In addition to this, if you are using camera, you will want to implement this as
}
}
-Finally, remember to add the thread pool, otherwise the plugins will have no threads to run on.
-
+ Finally, remember to add the thread pool, otherwise the plugins have no threads to run on:
@Override
public ExecutorService getThreadPool() {
return threadPool;
}
-6. Copy your application's HTML and JavaScript used to the `/assets/www` directory of your Android project
-7. Copy `cordova.xml` and `plugins.xml` from `/framework/res/xml` to the `/res/xml` folder in your project
+6. Copy your application's HTML and JavaScript files to your Android project's `/assets/www` directory.
+7. Copy `cordova.xml` and `plugins.xml` from `/framework/res/xml` to your project's `/res/xml` folder.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/cordova-webview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/index.md b/docs/en/edge/guide/cordova-webview/index.md
index d3e2e72..f7b58ba 100644
--- a/docs/en/edge/guide/cordova-webview/index.md
+++ b/docs/en/edge/guide/cordova-webview/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/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 5d9ba71..a4ca2d5 100644
--- a/docs/en/edge/guide/cordova-webview/ios.md
+++ b/docs/en/edge/guide/cordova-webview/ios.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
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
@@ -20,11 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Embedding Cordova WebView on iOS
================================
-Beginning with Cordova 1.4, you can use Cordova as a component in your iOS applications. This component is code-named "Cleaver".
+Beginning with Cordova 1.4, you can use Cordova as a component in your
+iOS applications. This component is code-named "Cleaver".
-New Cordova-based applications created using the Xcode template provided in Cordova 1.4 or greater use Cleaver, and this template is considered the reference implementation for Cleaver.
+New Cordova-based applications created using the Xcode template
+provided in Cordova 1.4 or greater use Cleaver. (The template is
+Cleaver's reference implementation.)
-Beginning with Cordova 2.0.0 and greater, we only support the sub-project based Cleaver implementation from now on.
+Cordova 2.0.0 and subsequent versions only support the sub-project
+based Cleaver implementation.
Prerequisites
-------------
@@ -37,7 +41,7 @@ Prerequisites
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)
+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. **Copy** the `config.xml` file into your project folder on disk (see **Prerequisites** above)
@@ -45,12 +49,12 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
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**
+9. Type the **Option-Command-1** key combination 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"**
+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
@@ -74,13 +78,13 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
22. 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)"
- 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.
-
+ 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.
+
Using CDVViewController in your code
------------------------------------
@@ -88,7 +92,7 @@ Using CDVViewController in your code
#import <Cordova/CDVViewController.h>
-2. Instantiate a **new** `CDVViewController`, and **retain it somewhere** (e.g. to a property in your class):
+2. Instantiate a **new** `CDVViewController`, and **retain it somewhere** (e.g. to a property in your class):
CDVViewController* viewController = [CDVViewController new];
@@ -127,7 +131,7 @@ Adding your HTML, CSS and JavaScript assets
/*
if you created a folder called 'myfolder' and
- you want the file 'mypage.html' in it to be
+ you want the file 'mypage.html' in it to be
the startPage
*/
viewController.wwwFolderName = @"myfolder";
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/android/index.md b/docs/en/edge/guide/getting-started/android/index.md
index ab34d8e..7298c48 100644
--- a/docs/en/edge/guide/getting-started/android/index.md
+++ b/docs/en/edge/guide/getting-started/android/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
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
@@ -34,36 +34,38 @@ This guide describes how to set up your development environment for Cordova and
- Android 3.x (Deprecated May 2013)
- Android 4.x
-We currently do not support Android 1.x, and we plan to deprecate platforms in the future as they are updated and dip below 5% on the [distribution dashboard](http://developer.android.com/about/dashboards/index.html) provided by Google.
+Android 1.x is currently not supported. In general, superseded
+platforms are deprecated as they dip below 5% on Google's
+[distribution dashboard](http://developer.android.com/about/dashboards/index.html).
2. Install SDK + Cordova
------------------------
- Download and install [Android SDK](http://developer.android.com/sdk/index.html)
-- Download the latest copy of [Cordova](http://cordova.apache.org/#download) and extract its contents. We will be working with the Android directory.
+- Download and extract the latest copy of [Cordova](http://cordova.apache.org/#download). You will be working in the `android` directory.
-3A. Setup your PATH environment variable on Mac OS
+
+3A. Set up your PATH environment variable on Mac OS
---------------------------------------
-- Open the Terminal program (this is in your Applications/Utilites folder by default).
-- Run the following command
+- Open the Terminal program, by default in your `Applications/Utilities` folder.
+- Run the following command to open the file with your default text editor:
`touch ~/.bash_profile; open ~/.bash_profile`
-- This will open the file in the your default text editor.
-- You need to add the path to your Android SDK platform-tools and tools directory. In my example I will use "/Development/android-sdk-macosx" as the directory the SDK is installed in. Add the following line:
+- You need to add the path to your Android SDK platform-tools and tools directory. This example uses "/Development/android-sdk-macosx" as the SDK's install directory. Add the following line:
-`export PATH=${PATH}:/Development/android-sdk-macosx/platform-tools:/Development/android-sdk-macosx/tools`
+`export PATH=${PATH}:/Development/android-sdk-macosx/platform-tools:/Development/android-sdk-macosx/tools`
- Save the file and quit the text editor.
-- Execute your .bash_profile to update your PATH.
+- Execute your .bash_profile to update your PATH.
`source ~/.bash_profile`
-- Now everytime you open the Terminal program you PATH will included the Android SDK.
+- Your PATH now includes the Android SDK, available each time open the Terminal program.
-3B. Setup your PATH environment variable on Windows
+3B. Set up your PATH environment variable on Windows
---------------------------------------
- From the Desktop, right-click My Computer and click Properties.
@@ -71,28 +73,28 @@ We currently do not support Android 1.x, and we plan to deprecate platforms in t
- In the System Properties window click the Environment Variables button.
- Select the PATH variable from the System variables section.
- Select the Edit button.
-- You need to add the path to your Android SDK platform-tools and tools directory. In my example I will use "C:\Development\android-sdk-windows" as the directory the SDK is installed in. Append the following text into the text box:
+- You need to add the path to your Android SDK platform-tools and tools directory. This example uses `C:\Development\android-sdk-windows` as the SDK's install directory. Append the following into the text box:
`;C:\Development\android-sdk-windows\platform-tools;C:\Development\android-sdk-windows\tools`
-- Save your edit. Close the Environment Variables dialog.
-- Additionally, you may need to include `%JAVA_HOME%\bin` to your PATH as well. To check to see if this is required, run a command prompt and type `java`. If the program can not be found add `%JAVA_HOME%\bin` to the PATH. You may need to specify the full path instead of using the `%JAVA_HOME%` environment variable.
-- Finally, you may need to include `%ANT_HOME%\bin` to your PATH as well. To check to see if this is required, run a command prompt and type `ant`. If the program can not be found add `%ANT_HOME%\bin` to the PATH. You may need to specify the full path instead of using the `%ANT_HOME%` environment variable.
+- Save your edit and close the Environment Variables dialog.
+- You may also need to include `%JAVA_HOME%\bin` to your PATH. To check if this is required, open a command prompt and type `java`. Add `%JAVA_HOME%\bin` to the PATH if the program can't be found. You may need to specify the full path instead of the `%JAVA_HOME%` environment variable.
+- Finally, you may also need to include `%ANT_HOME%\bin` to your PATH. To check if this is required, open a command prompt and type `ant`. Add `%ANT_HOME%\bin` to the PATH if the program can't be found. You may need to specify the full path instead of the `%ANT_HOME%` environment variable.
-4. Setup New Project
+4. Set up New Project
--------------------
-- In a terminal window, navigate to the `bin` directory within the `android` subfolder of the Cordova distribution.
-- Type in `./create <project_folder_path> <package_name> <project_name>` then press **"Enter"**
+- In a terminal window, navigate to the Cordova distribution `android/bin` directory.
+- Type `./create <project_folder_path> <package_name> <project_name>`, then press **Enter**
<project_folder_path> is the path to your new Cordova Android project
<package_name> is the package name, e.g. com.YourCompany.YourAppName
<project_name> is the project name, e.g. YourApp (Must not contain spaces and dashes)
-
+
- If you're getting an 'An unexpected error occurred" error, try the command again prefixed with `sudo`
-- Launch Eclipse, and select menu item **New Project**
+- Launch Eclipse, and select menu item **New Project**:
- Select the directory you used for `<project_folder_path>`
- Click Finish.
@@ -110,11 +112,11 @@ If your project has a red X indicating there is a problem follow these additiona
----------------------
- Right click the project and go to **Run As > Android Application**
-- Eclipse will ask you to select an appropriate AVD. If there isn't one, then you'll need to create it.
+- Eclipse asks you to select an appropriate AVD. If there isn't one, then you'll need to create it.
-**Note: For a faster experience, use an Intel-based emulator image:**
+__NOTE:__ For a faster experience, use an Intel-based emulator image.
-- Open the Android SDK Manager
+- Open the Android SDK Manager:
- Install one or more `Intel x86 Atom` System Images as well as the `Intel Hardware Accelerated Execution Manager` (under Extras).
- Run the Intel installer, which has been downloaded to: `extras/intel/Hardware_Accelerated_Execution_Manager` within your Android SDK
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/bada/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/bada/index.md b/docs/en/edge/guide/getting-started/bada/index.md
index d02291d..0a4934d 100644
--- a/docs/en/edge/guide/getting-started/bada/index.md
+++ b/docs/en/edge/guide/getting-started/bada/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
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
@@ -31,44 +31,44 @@ This guide describes how to set up your development environment for Cordova and
2. Install SDK + Cordova
-------------------------
-- Download and install the [Bada SDK](http://developer.bada.com) (Windows only).
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the bada directory.
+- Download and install the [Bada SDK](http://developer.bada.com) (Windows only).
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `bada` directory.
-3. Setup New Project
+3. Set up New Project
--------------------
-- In Bada IDE, select _File_ -> Import project -> Bada C++ / Flash Project.
- - Note: Bada 1.2 select "Bada Application Project"
-
+- In Bada IDE, select _File_ -> Import project -> Bada C++ / Flash Project.
+ - __NOTE:__ Bada 1.2 select "Bada Application Project"
+
-- Make sure "Select root directory is checked" and then click Browse
+- Make sure "Select root directory" is checked and then click Browse
- Browse to Cordova bada project folder (bada for 1.2 and bada-wac for 2.x) and select it. Make sure "Copy projects into workspace is checked"
-
+
- Click "Finish"
-
+
4. Hello World
--------------
-**Bada 2.x**: Your HTML/CSS/Javascript code lives under the Res/ folder. Make sure your index.html contains the following two lines in the <head> section.
+**Bada 2.x**: Your HTML/CSS/JavaScript code lives under the Res/ folder. Make sure your index.html contains the following two lines in the <head> section.
<link href="osp://webapp/css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="osp://webapp/js/webapp_core.js"></script>
-**Bada 1.2**: Your HTML/CSS/Javascript code lives under the Res/ folder. Make sure your index.html contains the following line.
+**Bada 1.2**: Your HTML/CSS/JavaScript code lives under the Res/ folder. Make sure your index.html contains the following line.
<script type="text/javascript" src="cordova/cordova.js"> </script>
5A. Deploy to Simulator
-----------------------
-- **Bada 2.x**: Right click on your project s folder and select Run As -> bada Emulator Web Application
-
+- **Bada 2.x**: Right click on your project s folder and select Run As -> bada Emulator Web Application
+
- **Bada 1.2**: Right click on your project' folder and select Build configurations -> Set Active -> Simulator-Debug
@@ -80,7 +80,7 @@ This guide describes how to set up your development environment for Cordova and
5B. Deploy to Device
--------------------
-- Make sure your device is properly configured
+- Make sure your device is properly configured
**Bada 2.x**: Right click on your project's folder and select Run As -> bada Target Web Application
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/blackberry/index.md b/docs/en/edge/guide/getting-started/blackberry/index.md
index 5d61bce..57840b6 100644
--- a/docs/en/edge/guide/getting-started/blackberry/index.md
+++ b/docs/en/edge/guide/getting-started/blackberry/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
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
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Getting Started with BlackBerry
============================
-Cordova for BlackBerry makes use of the [BlackBerry WebWorks framework](https://bdsc.webapps.blackberry.com/html5). BlackBerry WebWorks tooling is available for Windows or Mac environments.
+Cordova for BlackBerry makes use of the [BlackBerry WebWorks framework](https://bdsc.webapps.blackberry.com/html5). BlackBerry WebWorks tooling is available for Windows or Mac environments.
WebWorks applications can ONLY be deployed to the following BlackBerry platforms:
@@ -52,7 +52,7 @@ Download and install the appropriate WebWorks SDKs for your development. BlackBe
3. Register for Signing Keys
-------------------------
-If you wish to publish your application on BlackBerry App World, or deploy on an actual device you’ll need to register for a set of free Code Signing Keys.
+If you wish to publish your application on BlackBerry App World, or deploy on an actual device you’ll need to register for a set of free Code Signing Keys.
To register for Signing Keys visit, and complete the [BlackBerry Keys Order Form](https://www.blackberry.com/SignedKeys).
@@ -62,10 +62,10 @@ Once you receive your Signing Keys, they'll need to be setup. To learn how to se
4. Install Cordova
-------------------------
-Download the latest copy of [Cordova](http://cordova.apache.org/#download) and extract its contents to your local machine.
+Download and extract the latest copy of [Cordova](http://cordova.apache.org/#download).
-5. Setup New Project
+5. Set up New Project
--------------------
- Open up a command prompt/terminal and navigate to where you extracted Cordova.
@@ -110,21 +110,21 @@ For instructions on installing simulators, please visit the following link(s):
- [BlackBerry Smartphone](https://developer.blackberry.com/html5/documentation/run_your_app_on_smartphone_sim_1876976_11.html)
- Open the project.properties file with your favorite editor and customize the following properties.
-
+
BlackBerry 10
- `qnx.sim.ip`
- `qnx.sim.password`
-- Note: IP address of simulator obtained when placing the simulator in developer mode through simulator security settings. Simulator password can be set through simulator security settings.
+- __NOTE:__ IP address of simulator obtained when placing the simulator in developer mode through simulator security settings. Simulator password can be set through simulator security settings.
Playbook
-- `playbook.sim.ip` :
+- `playbook.sim.ip` :
- `playbook.sim.password`
-- Note: IP address of simulator obtained when placing the simulator in developer mode through simulator security settings. Simulator password can be set through simulator security settings.
+- __NOTE:__ IP address of simulator obtained when placing the simulator in developer mode through simulator security settings. Simulator password can be set through simulator security settings.
Smartphone (Optional)
-- `blackberry.sim.dir`
+- `blackberry.sim.dir`
- `blackberry.sim.bin`
-- Note: On windows file separator '\' must be escaped when specifying directories. For example `C:\\Program Files\\BlackBerry\\Simulator`.
+- __NOTE:__ On windows file separator '\' must be escaped when specifying directories. For example `C:\\Program Files\\BlackBerry\\Simulator`.
While in your project directory, in command prompt/terminal type `./cordova/run <target>`. Replace `<target>` with either `qnx`, `playbook`, or `blackberry`. Note, for BlackBerry 10 and PlayBook, the simulator virtual image must already be started. For example...
@@ -137,9 +137,9 @@ BlackBerry PlayBook
BlackBerry Smartphone (OS5-7)
- `./cordova/run blackberry`
-Answer 'n' when prompted "Do you have a BlackBerry device connected to your computer? (y/n)"
+Answer "n" when prompted "Do you have a BlackBerry device connected to your computer? (y/n)"
-The application will be installed to the home screen of the simulator. Note, on BlackBerry OS 5 the application is installed in the Downloads folder.
+The application is installed to the simulator's home screen. Note that on BlackBerry OS 5, it is installed in the `Downloads` folder.
7B. Deploy to Device (Windows and Mac)
@@ -177,7 +177,7 @@ BlackBerry Smartphone (OS5-7)
Answer "y" when prompted "Do you have a BlackBerry device connected to your computer? (y/n)"
-The application will be installed to the home screen of the device. Note, on BlackBerry OS 5 the application is installed in the Downloads folder.
+The application is installed to the device's home screen. Note, on BlackBerry OS 5 the application is installed in the Downloads folder.
Additional Information
----------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/index.md b/docs/en/edge/guide/getting-started/index.md
index d937608..e8906f7 100644
--- a/docs/en/edge/guide/getting-started/index.md
+++ b/docs/en/edge/guide/getting-started/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/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 f894b93..8241736 100644
--- a/docs/en/edge/guide/getting-started/ios/index.md
+++ b/docs/en/edge/guide/getting-started/ios/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
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
@@ -27,67 +27,66 @@ Apache Cordova is a library used to create native mobile applications using Web
### Requirements ###
-- **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.
+- **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**
-
To submit apps to the Apple App Store℠, you must be using 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.
+ 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.
+ 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 will download and install copies of the core command line tools and system headers into system folders on your computer.
+ 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 that is installed with the iOS SDK and Xcode, but you will need an actual device to fully test all of the device features used in your applications before submitting to the App Store. The device must have at least iOS 5.x installed - this is 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.
In addition, to install apps onto a device, you must be a member of the [iOS Developer Program](https://developer.apple.com/programs/ios/) from Apple. The program costs $99 per year. This Getting Started guide documents deploying the application to the iOS simulator so registration with the developer program is not required.
+ 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.
## 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.Y.Z-src.zip to download to your machine. The X, Y and Z represent the version number of Cordova, for example x.x.x. The download includes the code for all of the Apache Cordova supported platforms.
+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.Y.Z-src.zip to download to your machine. The X, Y and Z represent the version number of Cordova, for example x.x.x. The download includes the code for all of the Apache Cordova supported platforms.
### Extract Cordova
-To access the code it will need to be extracted from the archive (.zip) file.
-
+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 cordova-X.Y.Z-src.zip file.
- Note: The file names change with each new version of Cordova. The file name will be different if you are using an updated or newer version of Cordova.
+1. Navigate to the folder where you downloaded the code. Find the cordova-X.Y.Z-src.zip file.
+ __NOTE:__ The filenames change with each incremental version of Cordova.
-2. Using the Finder® app, double click the file to extract. This will create a directory named, cordova-X.Y.Z.
+2. Using the Finder® app, double-click the file to extract. This creates a directory named `cordova-X.Y.Z`.
-3. Expand this folder and locate the cordova-ios.zip file and double click to extract it.
+3. Expand this folder and locate the cordova-ios.zip file and double-click to extract it.
4. The code for iOS is within the cordova-ios directory structure.
## 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.
+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
-Determine where on your system you will locate the Xcode project files for your application. For this tutorial I created a CordovaXY directory under my Documents folder: ~/Documents/CordovaXY where the X and Y refer the to Cordova version #.
+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 Finder navigate to the Documents Directory.
+1. In the Finder, navigate to the `Documents` directory.
-2. Create a directory called CordovaXY within the Documents directory 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 will need to remember this directory location and name for subsequent steps.
+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. In Finder, navigate to the Applications Folder. Find and expand the Utilities Folder.
+1. Open the Terminal application, located by default in the `Applications/Utilities` folder.
-2. Locate the Terminal app and double click to open it.
-
-3. In Finder, navigate to the cordova-ios directory from the downloaded and extracted Cordova code and expand it if necessary. Highlight the bin directory as shown:
+3. Use the Finder to navigate to the `cordova-ios` directory from the downloaded and extracted Cordova code. Highlight the `bin` subdirectory as shown:
- **Note:** This screen capture was from the Cordova-2.3.0 download, your listing will vary based on the actual Cordova version installed.
+ __NOTE:__ Your listing varies depending on Cordova's version number.
-4. Drag this directory to the open Terminal icon in the dock. This will open up a default terminal window with the path set to the bin directory.
+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.
### Create New Project
@@ -95,21 +94,23 @@ Determine where on your system you will locate the Xcode project files for your
1. Determine Required Parameters
- There are 3 ordered, required parameters for creating a Cordova project from the command line:
+ Three parameters are required to creating a Cordova project from the command line, in this order:
+
1. **project location**
- This is the directory where the Xcode project and files for the application will be located. This tutorial is using ~/Documents/CordovaXY as the base location and the application name as the project directory. Thus the location for our project will be
~/Documents/CordovaXY/HelloWorld, where HelloWorld is the project name (note that the X and Y represent the Cordova version, for example 22 for version 2.2). The final directory, HelloWorld in this example, must not already exist as it will be created during execution of the command.
+
+ 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.
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 will not be submitting this sample app, this tutorial uses org.apache.Cordova plus the app name, HelloWorld:
org.apache.cordova.HelloWorld
+ 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 make the project name and the application name the same. In this example the project name is HelloWorld.
+ 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
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`
+ `./create ~/Documents/CordovaXY/HelloWorld org.apache.cordova.HelloWorld HelloWorld`
@@ -117,9 +118,9 @@ Determine where on your system you will locate the Xcode project files for your
**No Developer Directory Found**
- 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:
+ 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:
- sudo /usr/bin/xcode-select -switch /Applications/Xcode.app/Contents/Developer
+ sudo /usr/bin/xcode-select -switch /Applications/Xcode.app/Contents/Developer
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.
@@ -127,59 +128,59 @@ Determine where on your system you will locate the Xcode project files for your
- **Additional Parameters**
- The default create script copies the necessary common library files from the Cordova distribution directory into your Xcode project directory. These files will appear within the CordovaLib directory of your project structure. Some development organizations prefer to have developers reference the common Cordova library files from a fixed location. A common location helps to insure that all developers are using the exact same copy of the CordovaLib code. This is accomplished by adding the --shared parameter to the create command. The following command will create a project that references the CordovaLib directory from the iOS directory location where the create script is executed:
+ 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:
- ./create --shared ~/Documents/CordovaXY/HelloWorld org.apache.cordova.HelloWorld HelloWorld
-
The Xcode project is still created in the ~/Documents/CordovaXY/HelloWorld directory, but it references the CordovaLib files from the fixed location of the Cordova distribution rather than a copy of these files within the project directory.
+ ./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,
+ 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
+ ./update_cordova_subproject path/to/your/project
- Most users will be 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:
+ 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:
- ./update_cordova_subproject ~/Documents/CordovaXY/HelloWorld
+ ./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.
+ 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.
+ __NOTE:__ this screen capture shows a project that was created with the name as HelloWorld23.
### Deploy to the Simulator
- 1. In the upper left hand corner of Xcode, click on the Scheme drop down 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:
+ 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.
+ 3. Click the **Run** button in your project window's toolbar to build, deploy and run the application in the simulator.
### Deploy to the Device
#### Requirements
- There are several requirements to deploy to a device. Since this information is not related directly to Cordova, please refer to the Apple Configuring Development and Distribution Assets section of the [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) documentation for complete details.
+ 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
+ - 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.
+ - 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.
+ - 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.
+ 1. Plug your device into your Mac via the USB Cable.
2. Select the Target and device
- 1. In the upper left hand corner of Xcode, click the Scheme drop down 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.
+ 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.
+ 3. Click the **run** button to build, deploy and run the application on your device.
## Results
@@ -191,11 +192,22 @@ Determine where on your system you will locate the Xcode project files for your
### Deprecation Warnings
- When an application programming interface (API) has been changed or replaced by another API, it is marked as “deprecated.” The API will still work in the near term but will be removed in a future version of the code library. Apache Cordova contains some of these deprecated interfaces. When you build and deploy an application, Xcode will issue warnings about these deprecated APIs. The ‘invokeString’ method that Xcode is warning about represents functionality to invoke the app from a custom URL. The process for loading from a custom URL has changed but this code is included to provide backwards functionality for apps created with older versions of Cordova. The sample app does not use this functionality so the references to the items causing the warnings can be ignored.
-
- If you wish to remove the warnings you can remove the code that is referencing the invokeString deprecated API.
-
- 1. Navigate to the MainViewController.m file in the Classes folder.
+When an application programming interface (API) is changed or replaced
+by another API, it is marked as "deprecated." The API still works in
+the near term, but is eventually removed. Some of these deprecated
+interfaces are reflected in Apache Cordova, and Xcode issues warnings
+about them when you build and deploy an application. The Xcode
+warning about the ‘invokeString’ method concerns functionality that
+launches the app from a custom URL. While the mechanism to load from a
+custom URL has changed, this code is included to provide backwards
+functionality for apps created with older versions of Cordova. The
+sample app does not use this functionality, so these warnings can be
+ignored.
+
+If you wish to remove the warnings you can remove the code that
+references the deprecated invokeString API:
+
+ 1. Edit the `Classes/MainViewController.m` file.
2. Find and comment out the following code by surrounding it with the begin, /*, and end, */, comment characters as highlighted in the code snippet below.
(void)webViewDidFinishLoad:(UIWebView*)theWebView
@@ -211,27 +223,27 @@ Determine where on your system you will locate the Xcode project files for your
*/
// Black base color for background matches the native apps
theWebView.backgroundColor = [UIColor blackColor];
-
+
return [super webViewDidFinishLoad:theWebView];
}
-
- 3. Press Command s to save the file.
+
+ 3. Press Command s to save the file.
4. Navigate to the AppViewDelegate.m file in the Classes Folder.
- 5. Comment out the following line by placing a double slash at the beginning of line 73 as shown below:
+ 5. Comment out the following line by placing a double slash at the beginning of line 73 as shown below:
- //self.viewController.invokeString = invokeString;
+ //self.viewController.invokeString = invokeString;
6. Press Command-s to save the file.
- 7. Press Command-b to rebuild the project and eliminate the warnings.
+ 7. Press Command-b to rebuild the project and eliminate the warnings.
### Missing Headers
- 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.
+ 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**.
- 2. In the Derived Data section click the Advanced button and select Unique as the Build Location as shown:
+ 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 have been set differently if you upgraded from an older version of Xcode.
@@ -249,7 +261,7 @@ Determine where on your system you will locate the Xcode project files for your
<script type="text/javascript">
app.initialize();
</script>
-
+
**Wait for deviceReady Event**
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.
@@ -301,23 +313,23 @@ Determine where on your system you will locate the Xcode project files for your
### Apple
- Some of these references are within the Apple iOS Developer Reference and require an iOS Developer License.
+ 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)
+ - [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
The [Apache Cordova home page](http://cordova.apache.org/) contains all of the links below and more.
- - Cordova API documentation is available at [http://docs.cordova.io](http://docs.cordova.io)
- - [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.
+ - Cordova API documentation is available at [http://docs.cordova.io](http://docs.cordova.io)
+ - [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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/symbian/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/symbian/index.md b/docs/en/edge/guide/getting-started/symbian/index.md
index d73ad92..525fb88 100644
--- a/docs/en/edge/guide/getting-started/symbian/index.md
+++ b/docs/en/edge/guide/getting-started/symbian/index.md
@@ -40,27 +40,27 @@ There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGa
-------------------------
- Download and install [cygwin](http://www.cygwin.com/setup.exe) (Windows only). Make sure you select "make" as it is not included by default
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the Android directory.
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the Android directory.
-3. Setup New Project
+3. Set up New Project
--------------------
- In cygwin, navigate to where you extracted Cordova and go into the Symbian directory</li>
-
+
4. Hello World
--------------
-- Open up index.html located in phonegap/symbian/framework/www with your favourite editor.
+- Open up index.html located in phonegap/symbian/framework/www with your favourite editor.
- In the `body` tag, remove the line `"Build your phonegap app here! Dude!"` and add the line `<h1>Hello World</h1>`
-- In cygwin/terminal, type make. This will produce phonegap-symbian.wrt/app.wgz.
+- In cygwin/terminal, type `make`. This produces a `phonegap-symbian.wrt/app.wgz` file.
5A. Deploy to Simulator
-----------------------
-- For Mac or Linux you should install [Aptana Studio](http://www.aptana.org/products/studio2/download) and [Nokia WRT Plug-in for Aptana Studio](http://www.forum.nokia.com/info/sw.nokia.com/id/00d62bd8-4214-4c86-b608-5f11b94dad54/Nokia_WRT_Plug_in_for_Aptana_Studio.html). This has a browser-based javascript emulator
+- For Mac or Linux you should install [Aptana Studio](http://www.aptana.org/products/studio2/download) and [Nokia WRT Plug-in for Aptana Studio](http://www.forum.nokia.com/info/sw.nokia.com/id/00d62bd8-4214-4c86-b608-5f11b94dad54/Nokia_WRT_Plug_in_for_Aptana_Studio.html). This has a browser-based JavaScript emulator
- For Windows you can download the [S60 SDK](http://www.forum.nokia.com/info/sw.nokia.com/id/ec866fab-4b76-49f6-b5a5-af0631419e9c/S60_All_in_One_SDKs.html) which includes the S60 Emulator
- Load the phonegap-symbian.wrt/app.wgz file into the emulator.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/tizen/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/tizen/index.md b/docs/en/edge/guide/getting-started/tizen/index.md
index a45895e..4271a3e 100644
--- a/docs/en/edge/guide/getting-started/tizen/index.md
+++ b/docs/en/edge/guide/getting-started/tizen/index.md
@@ -31,10 +31,10 @@ This guide describes how to set up your development environment for Cordova and
-------------------------
- Download and install the [Tizen SDK](https://developer.tizen.org/sdk).
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the tizen directory.
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `tizen` directory.
- (optional) Install Tizen Cordova template projects: copy the `/templates` directory content into you Tizen Eclipse IDE web templates directory (e.g: `/home/my_username/tizen-sdk/IDE/Templates/web`).
-3. Setup New Project
+3. Set up New Project
--------------------
- **Method #1: Import a Cordova Tizen project sample**
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/webos/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/webos/index.md b/docs/en/edge/guide/getting-started/webos/index.md
index 37ab244..7d5635c 100644
--- a/docs/en/edge/guide/getting-started/webos/index.md
+++ b/docs/en/edge/guide/getting-started/webos/index.md
@@ -41,12 +41,12 @@ Video Tutorials:
- Download and install [Virtual Box](http://www.virtualbox.org/)
- Download and install [WebOS SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321/)
- Download and install [cygwin SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321) (Windows only). Make sure you select "make" as it is not included by default
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the webOS directory.
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `webOS` directory.
- Download and install XCode from the [Mac App Store](http://itunes.apple.com/ca/app/xcode/id497799835?mt=12) (OSX only)
- Download and install Command Line Tools for XCode (OSX only); this can be done by going to XCode's Preferences -> Downloads -> Components and then click install on Command Line Tools
-
-3. Setup New Project
+
+3. Set up New Project
--------------------
- Open up terminal/cygwin and navigate to where you extracted your Cordova Download. Go into the webOS directory.
@@ -55,7 +55,7 @@ Video Tutorials:
4. Hello World
--------------
-In phonegap/webOS/framework/www, open up index.html with your favourite editor. After the body tag add `<h1>Hello World</h1>`
+Edit `phonegap/webOS/framework/www/index.html`, adding `<h1>Hello World</h1>` after the `<body>` tag.
5A. Deploy to Simulator
@@ -70,10 +70,11 @@ In phonegap/webOS/framework/www, open up index.html with your favourite editor.
- Make sure your device is in [Developer Mode and plug it in.](http://developer.palm.com/index.php?option=com_content&view=article&id=1552&Itemid=59#dev_mode)
- Type `make` in your terminal/cygwin while in the webOS directory.
-
+
Done!
-----
-You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/16494781/Getting-Started-with-PhoneGap-webOS).
+A more detailed version of this guide is available
+[here](http://wiki.phonegap.com/w/page/16494781/Getting-Started-with-PhoneGap-webOS).
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/windows-8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/windows-8/index.md b/docs/en/edge/guide/getting-started/windows-8/index.md
index bddc976..fad87a2 100644
--- a/docs/en/edge/guide/getting-started/windows-8/index.md
+++ b/docs/en/edge/guide/getting-started/windows-8/index.md
@@ -20,9 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Getting Started with Windows 8
==================================
-This guide describes how to set up your development environment for Cordova and run a sample application. Note that Cordova used to be called PhoneGap, so some of the sites still use the old PhoneGap name.
+This guide describes how to set up your Cordova development
+environment and run a sample application. Note that Cordova used to
+be called PhoneGap, so some of the sites still use the old PhoneGap
+name.
-During development of Windows 8 and Windows RT, Microsoft deprecated the name "Metro-style apps". On MSDN, this type of app is now called a "Windows Store" app. That's the name that we'll use in this guide. Also in this guide whenever we refer to Windows 8, you should take that to mean both Windows 8 and Windows RT.
+Microsoft deprecated the name "Metro-style apps" in Windows 8 and
+Windows RT. MSDN now refers to this type of app as a "Windows Store"
+app, and this guide follows that convention. Also, in this guide
+"Windows 8" signifies both Windows 8 and Windows RT.
1. Requirements
---------------
@@ -36,24 +42,24 @@ Follow the instructions [here](http://www.windowsstore.com/) to submit your apps
2. Install SDK + Cordova
----------------------------
-- Setup your preferred variant of Visual Studio 2012. All of the paid versions of the product (Professional, etc) let you build Windows Store apps. To build Windows Store apps using the [Express editions](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-products), you will need **Express for Windows 8**.
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the subfolder **lib\windows-8**.
+- Set up your preferred variant of Visual Studio 2012. All of the product's paid versions (Professional, etc.) let you build Windows Store apps. You need **Express for Windows 8** to build Windows Store apps using the [Express editions](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-products).
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-8` subfolder.
-3. Setup New Project
+3. Set up New Project
--------------------
You can already build Windows 8 apps using the "HTML/JavaScript track" available in Windows Store apps. The purpose of Cordova in Windows Store apps is to expose the same APIs used on all the other Cordova platforms.
- Open Visual Studio 2012 and choose **New Project**.
-- Select **Installed - Template - Other Languages - JavaScript - Windows Store** from the tree, and then **Blank App** from the projects list. Enter whatever project name you like. We're using **CordovaWin8Foo** in this guide.
+- Select **Installed - Template - Other Languages - JavaScript - Windows Store** from the tree, and then **Blank App** from the projects list. Enter whatever project name you like, such as **CordovaWin8Foo** in this example.
-- Microsoft continues to use **default.html** as the default page for use in websites, whereas most "open web" developers use **index.html**. (Plus it's likely that in the other platform variants of your project you are using **index.html** as the name of your default page.) To fix this, in Solution Explorer rename the **default.html** file to **index.html**. Then double-click the **package.appxmanifest** file and change the **Start page** value to **index.html**.
+- Microsoft continues to use `default.html` as the default home page, but most web developers use `index.html`. (Plus it's likely that in the other platform variants of your project you are using `index.html` as the name of your default page.) To fix this, in Solution Explorer rename the `default.html` file to `index.html`. Then double-click the **package.appxmanifest** file and change the **Start page** value to **index.html**.
-- To include **cordova.js** in your project, right-click on the **js** folder in Solution Explorer and select **Add - New Item**. Locate the **cordova.js** file in the **lib\windows-8** folder that we called out previously.
+- To include **cordova.js** in your project, right-click on the **js** folder in Solution Explorer and select **Add - New Item**. Locate the **cordova.js** file in the **lib\windows-8** folder noted above.
- Edit the code for **index.html**. Add a reference to **cordova.js**. You can do this manually, or by dragging the file from Solution Explorer.
@@ -70,7 +76,7 @@ You can already build Windows 8 apps using the "HTML/JavaScript track" available
<link href="/css/default.css" rel="stylesheet" />
<script src="/js/default.js"></script>
-- Next we want to add some code that will demonstrate that Cordova is working.
+- Next, add some code that demonstrates Cordova is working.
### Adding a 'deviceready' handler...
<body>
@@ -93,7 +99,7 @@ You can already build Windows 8 apps using the "HTML/JavaScript track" available
5. Test the Project
-------------------------------
-- Run the project from Visual Studio. You'll see the message box appear.
+- Run the project from Visual Studio. You'll see the message box appear:
