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/11 02:11:15 UTC
[4/8] Update documentation with standard STYLESHEET guide.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
index 4cbaf68..5a04a8f 100644
--- a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
+++ b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
@@ -26,13 +26,13 @@ Properties
-------
- __insertId__: the row ID of the row that the SQLResultSet object's SQL statement inserted into the database
-- __rowsAffected__: the number of rows that were changed by the SQL statement. If the statement did not affect any rows then it is set to 0.
+- __rowsAffected__: the number of rows that were changed by the SQL statement. If the statement did not affect any rows then it is set to 0.
- __rows__: a SQLResultSetRowList representing the rows returned. If no rows are returned the object will be empty.
Details
-------
-When you call the SQLTransaction executeSql method its callback methods will be called with a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowsAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.
+When you call the SQLTransaction executeSql method its callback methods is called with a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowsAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.
Supported Platforms
-------------------
@@ -83,7 +83,7 @@ Full Example
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Populate the database
+ // Populate the database
//
function populateDB(tx) {
tx.executeSql('DROP TABLE IF EXISTS DEMO');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
index 351a5d0..74fa5af 100644
--- a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
+++ b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
@@ -83,7 +83,7 @@ Full Example
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Populate the database
+ // Populate the database
//
function populateDB(tx) {
tx.executeSql('DROP TABLE IF EXISTS DEMO');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
index f26d77e..f1348f3 100644
--- a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
+++ b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
@@ -30,7 +30,7 @@ Methods
Details
-------
-When you call a Database objects transaction method it's callback methods will be called with a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
+When you call a Database objects transaction method, its callback methods is called with a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
Supported Platforms
-------------------
@@ -84,7 +84,7 @@ Full Example
db.transaction(populateDB, errorCB, successCB);
}
- // Populate the database
+ // Populate the database
//
function populateDB(tx) {
tx.executeSql('DROP TABLE IF EXISTS DEMO');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/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 4643920..28f885c 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
@@ -39,8 +39,8 @@ Cordova projects.
## Windows Phone
-The Windows Phone command line tools support creating, building and
-running new projects. Commands must be run from a cmd or powershell prompt.
+The Windows Phone command-line tools support creating, building, and
+running new projects. Commands must be run from a cmd or powershell prompt.
### Create a project
@@ -118,7 +118,6 @@ Run the `create` command with the following parameters:
$ /path/to/my_new_cordova_project/cordova/log
-
## Android
The Android command-line tools are built upon shell scripts. You _must_
@@ -178,9 +177,11 @@ Run the 'run' command with the following *optional* parameters
$ C:\path\to\my_new_cordova_project\cordova\run.bat [Target] [Build]
-
-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.
-By default the `run` command will look for a connected device, if no device is found it will look for any started emulators. If you have multiple AVDs, you can specify a target ID.
+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. By default the `run`
+command will detect a connected device. When no device is found,
+it will detect a running emulator.
### Logging
@@ -198,7 +199,6 @@ or, on *Windows*
$ C:\path\to\my_new_cordova_project\cordova\clean.bat
-
## BlackBerry
The BlackBerry command-line tools are built upon shell scripts.
@@ -219,15 +219,17 @@ 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>
@@ -239,9 +241,9 @@ 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>
@@ -259,22 +261,20 @@ and then choose 'no' when prompted with:
### Logging
-Unfortunately streaming logs directly from the device is not
-supported at this time. However, BlackBerry offers built-in Web
-Inspector support for Playbook and BlackBerry smartphone devices running
-BlackBerry OS 7.0 and above. Additionally, you can access your
-application's logs (including any calls to `console.log`) on your device
-by holding down the ALT key from the home screen and hitting "lglg"
-keys.
+Unfortunately, streaming logs directly from the device is currently
+unsupported. However, BlackBerry offers built-in Web Inspector support
+for Playbook and BlackBerry smartphone devices running BlackBerry OS
+7.0 and above. You can also access your application's logs (including
+any calls to `console.log`) on your device by holding down the ''ALT''
+key from the home screen and typing ''lglg'' keys.
-
-##BlackBerry 10
+## BlackBerry 10
Command-line tools are based on shell scripts. If you need help with a command, type the command with the `-h` or `-help` arguments, which are supported by all commands and which will provide descriptions for each of the available arguments.
The following commands are available:
-##create
+## create
The 'create' command creates a new project:
@@ -282,11 +282,11 @@ The 'create' command creates a new project:
bin/create <path-to-project>
```
-##target
+## target
The `target` command allows you to manage the BlackBerry device(s) or simulator that you will use to test your app. You can add or remove a target, or set a target as the default target.
-###Add a target
+### Add a target
```
<path-to-project>/cordova/target add <name> <ip-address> <device | simulator> [-p | --password <password>] [--pin <device-pin>]
@@ -299,23 +299,23 @@ where
- `-p|--password <password>` specifies the password for the device or simulator. This is required only if the device or simulator is password protected.
- `--pin <device-pin>` specifies the PIN of the BlackBerry device, which identifies that device as a valid host for the debug token. This argument is required only if you are creating a debug token.
-###Remove a target
+### Remove a target
```
<path-to-project>/cordova/target remove <name>
```
-###Set a target as the default
+### Set a target as the default
```
<path-to-project>/cordova/target default <name>
```
-##build
+## build
The `build` command builds the project as a .bar file. You can build your app in either release mode (which produces a signed .bar file) or in debug mode (which produces an unsigned .bar file).
-###Build your project in release mode
+### Build your project in release mode
```
<path-to-project>/cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-file>]
@@ -326,7 +326,7 @@ where
- `-b|--buildId <number>` specifies the build version number of your application. Typically, this number should be incremented from the previous signed version. This argument is optional.
- `-p|--params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools. This argument is optional.
-###Build your project in debug mode
+### Build your project in debug mode
```
<path-to-project>/cordova/build debug [<target>] [-k|--keystorepass <password>] [-p|--params <params-JSON-file>] [-ll|--loglevel <error|warn|verbose>]
@@ -345,7 +345,7 @@ If you have previously defined a default target (and previously installed a debu
<path-to-project>/cordova/build debug
```
-##run
+## run
The `run` command deploys the app on the specified BlackBerry device or a simulator. Before deploying your app, you must first create a target for the device or simulator you want to deploy your app to. The deploy script will deploy the most recent build of your app.
@@ -356,30 +356,30 @@ The `run` command deploys the app on the specified BlackBerry device or a simula
where
- `<target> `specifies the name of a previously added target. If `<target> `is a device, then that device must be connected to your computer by USB connection or be connected to the same Wi-Fi network as your computer.
-##plugin
+## plugin
The `target` command allows you to add and remove plugins
-###Fetch a locally-hosted plugin
+### Fetch a locally-hosted plugin
```
<path-to-project>/cordova/plugin fetch <path-to-plugin>
```
-###View a list of installed plugins
+### View a list of installed plugins
```
<path-to-project>/cordova/plugin ls
```
-###Add a plugin
+### Add a plugin
```
<path-to-project>/cordova/plugin add <name>
```
-###Remove a plugin
+### Remove a plugin
```
<path-to-project>/cordova/plugin rm <name>
@@ -397,4 +397,3 @@ Run the `create` command with the following parameters:
* Path to your new Cordova Windows 8 project
* Package Name, following reverse-domain style convention ( this becomes the default Namespace )
* Project name
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/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/39353f45/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/39353f45/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..cd945ab 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
-------------
@@ -33,25 +37,24 @@ Prerequisites
2. **Xcode 4.5** or greater
3. `config.xml` file (from a [newly created](guide_command-line_index.md.html#Command-Line%20Usage_ios) Cordova project)
-
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)
5. **Drag and drop** the `config.xml` file into the Project Navigator of Xcode
-6. **Choose** the radio-button **"Create groups for any added folders"**, select the **Finish** button
+6. **Choose** the **Create groups for any added folders** radio button and press **Finish**
7. **Drag and drop** the `CordovaLib.xcodeproj` file into the Project Navigator of Xcode (from the permanent folder location above, and it should be in the CordovaLib sub-folder)
8. Select `CordovaLib.xcodeproj` in the Project Navigator
-9. Press the key combination **Option-Command-1** to show the **File Inspector**
-10. Choose **"Relative to Group"** in the **File Inspector** for the drop-down menu for **Location**
-11. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
-12. Add `-all_load` and `-Obj-C` - for the **"Other Linker Flags"** value
-13. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Phases"** tab
-14. Expand **"Link Binaries with Libraries"**
-15. Select the **"+" button**, and add these **frameworks** (and optionally in the Project Navigator, **move** them under the Frameworks group):
+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**
+15. Select the **+** button, and add these **frameworks** (and optionally in the Project Navigator, **move** them under the Frameworks group):
AddressBook.framework
AddressBookUI.framework
@@ -64,23 +67,23 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
MobileCoreServices.framework
CoreMedia.framework
-16. Expand **"Target Dependencies"** - the top box labeled like this if you have multiple boxes!
-17. Select the **"+" button**, and add the `CordovaLib` build product
-18. Expand **"Link Binaries with Libraries"** - the top box labeled like
+16. Expand **Target Dependencies** - the top box labeled like this if you have multiple boxes!
+17. Select the **+** button, and add the `CordovaLib` build product
+18. Expand **Link Binaries with Libraries** - the top box labeled like
this if you have multiple boxes!
-19. Select the **"+" button**, and add `libCordova.a`
-20. Set the Xcode preference **"Xcode Preferences -> Locations -> Derived Data -> Advanced…"** to **"Unique"**
-21. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
-22. Search for **"Header Search Paths"**. For that setting, add these three values below (with quotes):
+19. Select the **+** button, and add `libCordova.a`
+20. Set the Xcode preference **Xcode Preferences → Locations → Derived Data → Advanced...** to **Unique**
+21. Select the **project icon** in the Project Navigator, select your **Target**, then select the **Build Settings** tab
+22. Search for **Header Search Paths**. For that setting, add these three values below (with quotes):
"$(TARGET_BUILD_DIR)/usr/local/lib/include"
-
+
"$(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,11 +91,11 @@ 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];
-3. (_OPTIONAL_) Set the `wwwFolderName` property (defaults to `"www"`):
+3. (_OPTIONAL_) Set the `wwwFolderName` property (defaults to `www`):
viewController.wwwFolderName = @"myfolder";
@@ -119,15 +122,15 @@ Using CDVViewController in your code
Adding your HTML, CSS and JavaScript assets
-------------------------------------------
-1. Create a **new folder** in your project **on disk**, for example, name it `www`
-2. Put your **HTML, CSS and JavaScript assets** into this folder
-3. **Drag and drop** the folder into the Project Navigator of Xcode
-4. **Choose** the radio-button **"Create folder references for any added folders"**
+1. Create a **new folder** in your project **on disk**, `www` for example.
+2. Put your **HTML, CSS and JavaScript** assets into this folder.
+3. **Drag and drop** the folder into the Project Navigator of Xcode.
+4. **Choose** the **Create folder references for any added folders** radio button.
5. **Set the appropriate `wwwFolderName` and `startPage` properties** for the folder you created in **(1)** or use the defaults (see previous section) when you instantiate the `CDVViewController`.
/*
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/39353f45/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..d652ab4 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,97 +34,96 @@ 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.
-- Click Advanced System Settings link in the left column.
-- In the System Properties window click the Environment Variables button.
+- From the Desktop, right-click __My Computer__ and click __Properties__.
+- Click the __Advanced System Settings__ link in the left column.
+- 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:
+- Select the __Edit__ button.
+- 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**
+- If you get an __An unexpected error occurred__ error, try the command again prefixed with `sudo`
+
+- Launch Eclipse, and select menu item **New Project**:
- Select the directory you used for `<project_folder_path>`
- Click Finish.
-If your project has a red X indicating there is a problem follow these additional steps:
+If your project has a red __X__ indicating there is a problem follow
+these additional steps:
-- Right click on the project folder.
-- In the Properties dialog that is displayed select Android from the navigation pane.
-- For the project build target select the highest Android API level you have installed.
-- Click OK
-- Then from the Project menu bar item select Clean.
-- This should correct all the errors in the project.
+- Right-click on the project folder.
+- In the resulting __Properties__ dialog, select __Android__ from the navigation pane.
+- For the project build target, select the highest Android API level you have installed.
+- Click __OK__
+- Select __Clean__ from the __Project__ menu. This should correct all the errors in the project.
5A. Deploy to Emulator
----------------------
-- 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.
+- Right-click the project and go to **Run As > Android Application**
+- 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
- Create a new AVD with the Target set to an Intel image.
- When starting the emulator, ensure there are no error messages about the HAX module failing to load.
-
5B. Deploy to Device
--------------------
- Make sure USB debugging is enabled on your device and plug it into your system. Information can be found on the [Android Developer Site](http://developer.android.com/tools/device.html)
-- Right click the project and go to **Run As > Android Application**
+- Right-click the project and go to **Run As > Android Application**
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/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..44bf15f 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
@@ -26,68 +26,65 @@ This guide describes how to set up your development environment for Cordova and
---------------
- Windows
-- You need the bada 1.2 SDK to use cordova-bada (which is no longer available on Samsung's website)
+- You need the bada 1.2 SDK to use cordova-bada (which is no longer available on Samsung's website)
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:__ In Bada 1.2 select __Bada Application Project__
+
-- 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"
-
+- Make sure __Select root directory__ is checked, then click __Browse__
+- Browse to the 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"
+- 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
+- **Bada 1.2**: Right-click on your project' folder and select __Build configurations → Set Active → Simulator-Debug--__
-- Right click on your project's folder and select Run As -> bada Simulator Application. You need to close the emulator every time you update your app!
+- Right-click on your project's folder and select __Run As → bada Simulator Application__. Note that you need to close the emulator every time you update your app.
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
+**Bada 2.x**: Right-click on your project's folder and select __Run As → bada Target Web Application__
**Bada 1.2**:
-- Right click on your project's folder and select Build configurations -> Set Active -> Target-Debug
-- Right click on your project's folder and select Run As -> bada Target Application. You need to close the emulator every time you update your app!
-
+- Right-click on your project's folder and select __Build configurations → Set Active → Target-Debug__
+- Right-click on your project's folder and select __Run As → bada Target Application__. You need to close the emulator every time you update your app!
Done!
-----
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/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..401b0ac 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:
@@ -28,7 +28,6 @@ WebWorks applications can ONLY be deployed to the following BlackBerry platforms
* BlackBerry PlayBook
* BlackBerry 10 (QNX)
-
1. Requirements
---------------
@@ -40,7 +39,6 @@ WebWorks applications can ONLY be deployed to the following BlackBerry platforms
- Windows: [Apache Ant](http://ant.apache.org/bindownload.cgi).
- Mac OS X: Apache Ant is bundled with Java install.
-
2. Install the WebWorks SDK
-------------------------
Download and install the appropriate WebWorks SDKs for your development. BlackBerry 10, BlackBerry PlayBook, and BlackBerry Smartphone WebWorks SDKs can all be downloaded from the following locations. Please note that BlackBerry PlayBook development requires the Adobe Air SDK as well.
@@ -49,23 +47,20 @@ Download and install the appropriate WebWorks SDKs for your development. BlackBe
- [BlackBerry PlayBook SDK] (https://developer.blackberry.com/html5/download/#playbook) & [Adobe Air SDK](http://www.adobe.com/devnet/air/air-sdk-download.html)
- [BlackBerry Smartphones SDK] (https://developer.blackberry.com/html5/download/#smartphones)
-
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).
Once you receive your Signing Keys, they'll need to be setup. To learn how to setup your Signing Keys visit the [BlackBerry HTML5/WebWorks website](https://developer.blackberry.com/html5/documentation/signing_setup_bb10_apps_2008396_11.html).
-
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.
@@ -83,7 +78,6 @@ BlackBerry PlayBook
BlackBerry Smartphone (OS5-7)
- `blackberry.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks Packager`
-
6. Hello World
--------------
@@ -98,7 +92,6 @@ BlackBerry PlayBook
BlackBerry Smartphone (OS5-7)
- `./cordova/build blackberry`
-
7A. Deploy to Simulator
--------------------------------------
@@ -110,21 +103,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,15 +130,14 @@ 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)"
-
-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.
+When prompted __Do you have a BlackBerry device connected to your computer? (y/n)__, answer __n__.
+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)
--------------------------------------
-To deploy your app to a device you must have registered for, and setup BlackBerry Code Signing Keys. See section 3 for details. Also, to deploy apps on BlackBerry 10 or PlayBook, the device must be set to Development Mode which can be enabled from the Settings > Security menu.
+To deploy your app to a device you must have registered for, and setup BlackBerry Code Signing Keys. See section 3 for details. Also, to deploy apps on BlackBerry 10 or PlayBook, the device must be set to Development Mode which can be enabled from the __Settings → Security__ menu.
- Open the project.properties file with your favorite editor and customize the following properties:
@@ -175,9 +167,9 @@ BlackBerry PlayBook
BlackBerry Smartphone (OS5-7)
- `./cordova/run blackberry`
-Answer "y" when prompted "Do you have a BlackBerry device connected to your computer? (y/n)"
+When prompted __Do you have a BlackBerry device connected to your computer? (y/n)__, answer __y__.
-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/39353f45/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 766d64a..9232fed 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