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/08/02 00:11:35 UTC
[1/6] Update 3.0.0 from edge directory.
Updated Branches:
refs/heads/master 932e8c6cf -> 3fb6feae4
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/tizen/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/tizen/index.md b/docs/en/3.0.0/guide/platforms/tizen/index.md
index 47130f0..8fb9570 100644
--- a/docs/en/3.0.0/guide/platforms/tizen/index.md
+++ b/docs/en/3.0.0/guide/platforms/tizen/index.md
@@ -63,13 +63,17 @@ Download the Tizen SDK from
## Open a Project in the SDK
1. Launch the Tizen Eclipse IDE.
+
2. Select __File → Import → Tizen Web Project__:
3. Press __Next__.
+
4. Make sure __Select root directory__ is checked.
+
5. Make sure __Copy projects into workspace__ is checked.
+
6. Press __Browse__ and select the Cordova Tizen `samples` project directory (such as `/cordova-basic`):
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/win8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/win8/index.md b/docs/en/3.0.0/guide/platforms/win8/index.md
index 471793a..452e048 100644
--- a/docs/en/3.0.0/guide/platforms/win8/index.md
+++ b/docs/en/3.0.0/guide/platforms/win8/index.md
@@ -27,7 +27,7 @@ detailed platform-specific information:
* Windows 8 Command-line Tools
The command-line tools above refer to versions prior to Cordova 3.0.
-See The Cordova Command-line Interface for information about the
+See The Command-line Interface for information about the
current interface.
Microsoft deprecated the name _Metro-style apps_ in Windows 8 and
@@ -46,6 +46,7 @@ Follow the instructions [here](http://www.windowsstore.com/) to submit your apps
## 2. Install SDK + Cordova
- 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. Set up New Project
@@ -55,7 +56,8 @@ available in Windows Store apps. Use Cordova in Windows Store apps to
expose the same APIs as on other Cordova-supported 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, such as **CordovaWin8Foo** as in this example.
+
+- 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` as in this example.
@@ -63,7 +65,7 @@ expose the same APIs as on other Cordova-supported platforms.
-- 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.
+- To include `cordova.js` in your project, right-click on the `js` directory in Solution Explorer and select **Add → New Item**. Locate the `cordova.js` file in the `lib\windows-8` directory 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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/win8/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/win8/tools.md b/docs/en/3.0.0/guide/platforms/win8/tools.md
index 9fbb26d..db2c68b 100644
--- a/docs/en/3.0.0/guide/platforms/win8/tools.md
+++ b/docs/en/3.0.0/guide/platforms/win8/tools.md
@@ -40,5 +40,7 @@ Commands must be run from a cmd or powershell prompt.
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 )
+
+* 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/3fb6feae/docs/en/3.0.0/guide/platforms/win8/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/win8/upgrading.md b/docs/en/3.0.0/guide/platforms/win8/upgrading.md
index 102ad4a..3cb0e1c 100644
--- a/docs/en/3.0.0/guide/platforms/win8/upgrading.md
+++ b/docs/en/3.0.0/guide/platforms/win8/upgrading.md
@@ -21,8 +21,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
This guide shows how to modify Windows 8 projects to upgrade from older versions of Cordova.
Most of these instructions apply to projects created with an older set
-of command-line tools that precede the `cordova` CLI utility. See The
-Cordova Command-line Interface for information how to update the
+of command-line tools that precede the `cordova` CLI utility. See The Command-line Interface for information how to update the
version of the CLI.
## Upgrade to 2.9.0 from 2.8.0 ##
@@ -30,7 +29,9 @@ version of the CLI.
The following commands should be done from within Visual Studio to be sure that the any project references are updated/deleted.
1. Remove `cordova-2.8.0.js` from the project's `www` directory.
-2. Add cordova.js file from the source to the project's `www` directory. (Note that the file no longer contains a version number in the filename.)
+
+2. Add `cordova.js` file from the source to the project's `www` directory. (Note that the file no longer contains a version number in the filename.)
+
3. Build and test!
## Upgrade to 2.8.0 from 2.7.0 ##
@@ -38,5 +39,7 @@ The following commands should be done from within Visual Studio to be sure that
The following commands should be done from within Visual Studio to be sure that the any project references are updated/deleted.
1. Remove `cordova-2.7.0.js` from the project's `www` directory.
-2. Add cordova.js file from the source to the project's `www` directory. (Note that the file no longer contains a version number in the filename.)
+
+2. Add `cordova.js` file from the source to the project's `www` directory. (Note that the file no longer contains a version number in the filename.)
+
3. Build and test!
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/wp7/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/wp7/index.md b/docs/en/3.0.0/guide/platforms/wp7/index.md
index e26780d..f9851eb 100644
--- a/docs/en/3.0.0/guide/platforms/wp7/index.md
+++ b/docs/en/3.0.0/guide/platforms/wp7/index.md
@@ -33,7 +33,7 @@ applies to both versions:
* Windows Phone Command-line Tools
The command-line tools above refer to versions prior to Cordova 3.0.
-See The Cordova Command-line Interface for information about the
+See The Command-line Interface for information about the
current interface.
## 1. System Requirements
@@ -50,7 +50,9 @@ __NOTE:__ Running the SDK in Virtual Machine might present some challenges. You
## 2. Install SDK + Cordova
- Download and install the [Windows Phone SDK](http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=27570/)
+
- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-phone-8\wp7` subfolder, `lib\windows-phone-8\wp8` contains the Windwos Phone 8 version of Cordova.
+
- Copy the file CordovaWP7_x_x_x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\
## 2.1. Building the template
@@ -61,8 +63,9 @@ In order to simplify the development process, Cordova comes with a script to bui
### Run the batch file to create and install the templates.
-- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where x.x.x is the current version number) To easily use these files in Visual Studio, copy them to
+- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where 3.0.0 is the current version number) To easily use these files in Visual Studio, copy them to
"My Documents\Visual Studio 2012\Templates\ProjectTemplates\" You will then be able to create new Apache Cordova Windows Phone apps from the Visual Studio File->New Project menu.
+
- If you run the batch file from the command line, you can also call with a parameter to install automatically
Run the script :
@@ -72,13 +75,17 @@ Run the script :
## 3. Set up New Project
- Open Visual Studio Express for Windows Phone and choose **New Project**.
+
- Select **CordovaWP7**. (The version number is displayed in the template description.)
+
- Give the project a name, and select __OK__.
## 4. Review the project structure
- The `www` folder contains your Cordova `html/js/css` and any other resources included in your app.
+
- Any content that you add here needs to be a part of the Visual Studio project, and it must be set as content.
+
- Note: This screen capture was from the wp8 cordova-2.3.0 download, your listing will vary based on the actual version installed.
@@ -88,7 +95,9 @@ Run the script :
In order to test your application on a device, the device must be registered. Click [here][register-url] to read documentation on deploying and testing on your Windows Phone 7.
- Make sure your phone is connected, and the screen is unlocked.
+
- In Visual Studio, select 'Device' from the top drop-down menu.
+
- Press the green **play** button next to the main drop-down menu to start debugging, or type __F5__.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/wp8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/wp8/index.md b/docs/en/3.0.0/guide/platforms/wp8/index.md
index c45956f..13ef628 100644
--- a/docs/en/3.0.0/guide/platforms/wp8/index.md
+++ b/docs/en/3.0.0/guide/platforms/wp8/index.md
@@ -35,7 +35,7 @@ applies to both versions:
* Windows Phone Command-line Tools
The command-line tools above refer to versions prior to Cordova 3.0.
-See The Cordova Command-line Interface for information about the
+See The Command-line Interface for information about the
current interface.
## 1. System Requirements
@@ -57,7 +57,7 @@ current interface.
- See the [list of Intel processors that support VT-x (virtualization) and EPT (SLAT)](http://ark.intel.com/Products/VirtualizationTechnology)
- Enable the virtualization capability (i.e., VT-x on Intel) in your BIOS settings, as usually this is disabled by default.
-- SDK + IDE ( Visual Studio )
+- SDK + IDE (Visual Studio)
- Visual Studio 2012 Professional, Premium, or Ultimate. Note that Visual Studio Express for Windows Phone (included in the SDK) is not recommended because you can not build the template (see below) with VS Express, as it does not have the __Export Template__ functionality, which is only in VS Pro or higher.
- Register and pay for a [Windows Phone Dev Center](http://dev.windowsphone.com/en-us/publish) account if you want to install your app on a real device or submit it to Market Place.
@@ -67,7 +67,9 @@ __NOTE:__ Running the SDK in Virtual Machine might present some challenges. You
## 2. Install SDK + Cordova
- Download and install [Windows Phone SDK](http://www.microsoft.com/en-us/download/details.aspx?id=35471)
+
- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-phone-8\wp8` subfolder, `lib\windows-phone-8\wp7` contains the Windwos Phone 7 version of Cordova.
+
- Copy the file CordovaWP8_x_x_x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\
## 2.1. Building the template
@@ -78,8 +80,9 @@ In order to simplify the development process, Cordova comes with a script to bui
### Run the batch file to create and install the templates.
-- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where x.x.x is the current version number) To easily use these files in Visual Studio, copy them to
+- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where 3.0.0 is the current version number) To easily use these files in Visual Studio, copy them to
"My Documents\Visual Studio 2012\Templates\ProjectTemplates\" You will then be able to create new Apache Cordova Windows Phone apps from the Visual Studio File->New Project menu.
+
- If you run the batch file from the command line, you can also call with a parameter to install automatically
Run the script :
@@ -89,7 +92,9 @@ Run the script :
## 3. Set up New Project
- Open Visual Studio Express for Windows Phone and choose **New Project**.
+
- Select **CordovaWP8**. (The version number is displayed in the template description.)
+
- Give the project a name, and select __OK__.
@@ -97,7 +102,9 @@ Run the script :
## 4. Review the project structure
- The `www` folder contains your Cordova `html/js/css` and any other resources included in your app.
+
- Any content that you add here needs to be a part of the Visual Studio project, and it must be set as content.
+
- Note: This screen capture was from the cordova-2.3.0 download, your listing will vary based on the actual version installed.
@@ -105,6 +112,7 @@ Run the script :
## 5. Build and Deploy to Emulator
- Make sure **Windows Phone Emulator** is selected in the main drop-down menu.
+
- Press the green **play** button next to the drop-down menu to start debugging, or type __F5__.
@@ -114,7 +122,9 @@ Run the script :
In order to test your application on a device, the device must be registered. Click [here][register-url] to read documentation on deploying and testing on your Windows Phone 8.
- Make sure your phone is connected, and the screen is unlocked.
+
- In Visual Studio, select 'Device' from the top drop-down menu.
+
- Press the green **play** button next to the main drop-down menu to start debugging, or type __F5__.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/wp8/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/wp8/plugin.md b/docs/en/3.0.0/guide/platforms/wp8/plugin.md
index 3bf34b4..62d843e 100644
--- a/docs/en/3.0.0/guide/platforms/wp8/plugin.md
+++ b/docs/en/3.0.0/guide/platforms/wp8/plugin.md
@@ -27,8 +27,10 @@ and it comes with the majority of the 'plumbing' built for you already.
1. Select your project, and right-click to choose __Add → New Item...__
- Preferably add it to the 'Plugins' folder, but it is up to you
+
2. Select 'Class' and name it `Echo.cs`
- The name of this class must _exactly_ match what you call into `cordova.exec(win, fail, "Echo", ...)`
+
3. Include the base classes implementation
using WPCordovaClassLib.Cordova;
@@ -42,7 +44,7 @@ and it comes with the majority of the 'plumbing' built for you already.
// ...
}
-5. Add a method that is callable from JS
+5. Add a method that is callable from JavaScript
public class Echo : BaseCommand
{
@@ -74,7 +76,7 @@ your C# class like this:
}
}
-Then, in JS you need to call `exec` like this:
+Then, in JavaScript you need to call `exec` like this:
cordova.exec(win, fail, "com.mydomain.cordovaExtensions.Echo", ...);
@@ -82,7 +84,7 @@ Then, in JS you need to call `exec` like this:
The data received by your plugin method is a string value, but in actuality
looking at our JavaScript code, we see our intention was to pass an array of strings.
-Looking back at our JS call to `cordova.exec`, we see we passed `[str]`:
+Looking back at our JavaScript call to `cordova.exec`, we see we passed `[str]`:
cordova.exec(win, fail, "Echo", "echo", ["input string"]);
@@ -91,7 +93,7 @@ we see that the value is actually:
"[\"input string\"]"
-All JavaScript exec arguments are JSON encoded before being passed into C#.
+All JavaScript `exec` arguments are JSON encoded before being passed into C#.
If we want to treat this as the string we were expecting, we need to decode it.
We can use simple JSON deserialization.
@@ -99,9 +101,9 @@ We can use simple JSON deserialization.
string optVal = JsonHelper.Deserialize<string[]>(options)[0];
// optVal now has the value of "input string"
-## Passing results from C# to JS
+## Passing results from C# to JavaScript
-The base class BaseCommand provides methods for passing data to your JS callback handlers.
+The base class BaseCommand provides methods for passing data to your JavaScript callback handlers.
To simply signal that the command has succeeded, when no additional result info is needed,
you can simply call:
@@ -111,7 +113,7 @@ To pass data back, you need to call a different version of `DispatchCommandResul
DispatchCommandResult(new PluginResult(PluginResult.Status.OK, "Everything went as planned, this is a result that is passed to the success handler."));
-To pass structured object data back to JS, it should be encoded as a JSON string:
+To pass structured object data back to JavaScript, it should be encoded as a JSON string:
DispatchCommandResult(new PluginResult(PluginResult.Status.OK, "{result:\"super awesome!\"}"));
@@ -144,11 +146,34 @@ in case we have bad input. This is a pattern used throughout the Cordova C# code
// ... continue on to do our work
}
+## Plugin XML
+
+These are windows phone specific examples of using the plugin.xml file, refer to the Plugin Specification for more details
+
+### `<source-file>`
+
+On windows phone the `<source-file>` element is currently used to define all plugin resources (ie. .cs, .xaml, .xaml.cs, .dll, image assets etc).
+
+### `<config-file>`
+
+The `<config-file>` element defines what elements get put into a config file. For example to add a plugin to the platforms config.xml, you would do something like this :
+
+ <config-file target="config.xml" parent="/*">
+ <feature name="PluginName">
+ <param name="wp-package" value="PluginName"/>
+ </feature>
+ </config-file>
+If we wanted to add the contacts capability to the WMAppManifest.xml, it would look like this :
+
+ <config-file target="Properties/WMAppManifest.xml" parent="/Deployment/App/Capabilities">
+ <Capability Name="ID_CAP_CONTACTS" />
+ </config-file>
+
## Advanced Plugin Functionality
See other methods that you can override in:
-1. [BaseCommand.cs](https://github.com/apache/cordova-wp7/blob/master/templates/standalone/cordovalib/Commands/BaseCommand.cs)
+* [BaseCommand.cs](https://github.com/apache/cordova-wp7/blob/master/templates/standalone/cordovalib/Commands/BaseCommand.cs)
For example, you can hook into the 'pause' and 'resume' application events.
@@ -182,6 +207,6 @@ inform yourself of errors.
- It is usually a good idea to do parameter checking in your
JavaScript code, before you call `exec`. This allows you to re-use
- more JavaScript code among your plug-in's various native
+ more JavaScript code among your plugin's various native
implementations.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/wp8/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/wp8/tools.md b/docs/en/3.0.0/guide/platforms/wp8/tools.md
index 2d96064..e688f3a 100644
--- a/docs/en/3.0.0/guide/platforms/wp8/tools.md
+++ b/docs/en/3.0.0/guide/platforms/wp8/tools.md
@@ -45,8 +45,9 @@ There are 2 ways to go about creating a new Apache Cordova WP7 or WP8 applicatio
### Run the batch file to create and install the templates.
-- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where x.x.x is the current version number) To easily use these files in Visual Studio, copy them to
+- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where 3.0.0 is the current version number) To easily use these files in Visual Studio, copy them to
"My Documents\Visual Studio 2012\Templates\ProjectTemplates\" You will then be able to create new Apache Cordova Windows Phone apps from the Visual Studio File->New Project menu.
+
- If you run the batch file from the command line, you can also call with a parameter to install automatically
Run the script :
@@ -89,6 +90,7 @@ name. Here is the syntax for both Windows Phone 7 and 8:
Run the 'run' command with the following *optional* parameters
* Target specification. This includes `--emulator`, `--device`, or `--target=<targetID>`.
+
* Build specification. This includes `--debug`, `--release`, or `--nobuild`.
$ C:\path\to\my_new_project\cordova\run [Target] [Build]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/wp8/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/wp8/upgrading.md b/docs/en/3.0.0/guide/platforms/wp8/upgrading.md
index bc58ba6..5cc09b1 100644
--- a/docs/en/3.0.0/guide/platforms/wp8/upgrading.md
+++ b/docs/en/3.0.0/guide/platforms/wp8/upgrading.md
@@ -20,38 +20,47 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Upgrading Windows Phone
This guide shows how to modify Windows Phone projects, both versions 7
-and 8, to upgrade from older versions of Cordova.
-Most of these instructions apply to projects created with an older set
-of command-line tools that precede the `cordova` CLI utility. See The
-Cordova Command-line Interface for information how to update the
-version of the CLI.
-The following section shows how to upgrade from non-CLI projects.
+and 8, to upgrade from older versions of Cordova. Most of these
+instructions apply to projects created with an older set of
+command-line tools that precede the `cordova` CLI utility. See The
+Command-line Interface for information how to update the version of
+the CLI. The following section shows how to upgrade from non-CLI
+projects.
## Upgrade to the CLI (3.0.0) from 2.9.0 ##
1. Create a new Apache Cordova 3.0.0 project using the cordova CLI, as
- described in The Cordova Command-line Interface.
+ described in The Command-line Interface.
+
2. Add your platforms the the cordova project, for example: `cordova
platform add wp7 wp8`.
-3. Copy the contents of the project's `www` folder to the `www` folder
+
+3. Copy the contents of the project's `www` directory to the `www` directory
at the root of the cordova project you just created.
+
4. Copy or overwrite any native assets from your original project
(`SplashScreen`, `ApplicationIcon`, etc.), making sure to add any
new files to the `.csproj` file. The windows phone project builds
inside the `platforms\wp7` or `platforms\wp8` directory.
+
5. Use the cordova CLI tool to install any plugins you need. Note that
the CLI handles all core APIs as plugins, so they may need to be
added. Only 3.0.0 plugins are compatible with the CLI.
+
6. Build and test.
## Upgrade to 3.0.0 (non-CLI) from 2.9.0 ##
In Visual Studio's Solution Explorer window:
-1. Create a new Apache Cordova WP7 or WP8 3.0.0 Project
-2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+1. Create a new Apache Cordova WP7 or WP8 3.0.0 Project.
+
+2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project.
+
3. Copy and overwrite any splash screen, or icon images.
-4. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+
+4. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project.
+
5. Build and test.
__NOTE:__ all core APIs are removed from Cordova version 3.0, and must
@@ -63,92 +72,144 @@ Manage Plugins.
In Visual Studio's Solution Explorer window:
-1. Create a new Apache Cordova WP7 or WP8 2.9.0 Project
-2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
-3. Update the name of cordova.js in the HTML tag if it's still using cordova-VERSION.js (should be just cordova.js).
+1. Create a new Apache Cordova WP7 or WP8 2.9.0 Project.
+
+2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project.
+
+3. Update the name of `cordova.js` in the HTML tag if it's still using cordova-VERSION.js (should be just `cordova.js`).
+
4. Copy and overwrite any splash screen, or icon images.
-5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the .csproj file.
+
+5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the .csproj file.
+
6. Build and test.
## Upgrade to 2.8.0 from 2.7.0 ##
In Visual Studio's Solution Explorer window:
-1. Create a new Apache Cordova WP7 or WP8 2.8.0 Project
-2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
-3. Update your HTML to use the new cordova.js file. ( note that there is no longer a version number in the name )
+1. Create a new Apache Cordova WP7 or WP8 2.8.0 Project.
+
+2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project.
+
+3. Update your HTML to use the new `cordova.js` file. (Note the lack of a version number in the filename.)
+
4. Copy and overwrite any splash screen, or icon images.
-5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+
+5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project.
+
6. Build and test.
## Upgrade to 2.7.0 from 2.6.0 ##
In Visual Studio's Solution Explorer window:
-1. Create a new Apache Cordova WP7 or WP8 2.7.0 Project
-2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+
+1. Create a new Apache Cordova WP7 or WP8 2.7.0 Project.
+
+2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project.
+
3. Update your HTML to use the new `cordova-2.7.0.js` file.
+
4. Copy and overwrite any splash screen, or icon images.
-5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+
+5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project.
+
6. Build and test.
## Upgrade to 2.6.0 from 2.5.0 ##
In Visual Studio's Solution Explorer window:
-1. Create a new Apache Cordova WP7 or WP8 2.6.0 Project
-2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+
+1. Create a new Apache Cordova WP7 or WP8 2.6.0 Project.
+
+2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project.
+
3. Update your HTML to use the new `cordova-2.6.0.js` file.
+
4. Copy and overwrite any splash screen, or icon images.
-5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+
+5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project.
+
6. Build and test.
## Upgrade to 2.5.0 from 2.4.0 ##
In Visual Studio's Solution Explorer window:
-1. Create a new Apache Cordova WP7 or WP8 2.5.0 Project
-2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+
+1. Create a new Apache Cordova WP7 or WP8 2.5.0 Project.
+
+2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project.
+
3. Update your HTML to use the new `cordova-2.5.0.js` file.
+
4. Copy and overwrite any splash screen, or icon images.
-5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+
+5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project.
+
6. Build and test.
## Upgrade to 2.4.0 from 2.3.0 ##
In Visual Studio's Solution Explorer window:
-1. Create a new Apache Cordova WP7 or WP8 2.4.0 Project
-2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+
+1. Create a new Apache Cordova WP7 or WP8 2.4.0 Project.
+
+2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project.
+
3. Update your HTML to use the new `cordova-2.4.0.js` file.
+
4. Copy and overwrite any splash screen, or icon images.
-5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+
+5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project.
+
6. Build and test.
## Upgrade to 2.3.0 from 2.2.0 ##
In Visual Studio's Solution Explorer window:
-1. Create a new Apache Cordova WP7 2.3.0 Project
-2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+
+1. Create a new Apache Cordova WP7 2.3.0 Project.
+
+2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project.
+
3. Update your HTML to use the new `cordova-2.3.0.js` file.
+
4. Copy and overwrite any splash screen, or icon images.
-5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+
+5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project.
+
6. Build and test.
## Upgrade to 2.2.0 from 2.1.0 ##
In Visual Studio's Solution Explorer window:
-1. Create a new Apache Cordova WP7 2.2.0 Project
-2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+
+1. Create a new Apache Cordova WP7 2.2.0 Project.
+
+2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project.
+
3. Update your HTML to use the new `cordova-2.2.0.js` file.
+
4. Copy and overwrite any splash screen, or icon images.
-5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+
+5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project.
+
6. Build and test.
## Upgrade to 2.1.0 from 2.0.0 ##
In Visual Studio's Solution Explorer window:
-1. Create a new Apache Cordova WP7 2.1.0 Project
-2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+
+1. Create a new Apache Cordova WP7 2.1.0 Project.
+
+2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project.
+
3. Update your HTML to use the new `cordova-2.1.0.js` file.
+
4. Copy and overwrite any splash screen, or icon images.
-5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+
+5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project.
+
6. Build and test.
## Upgrade to 2.0.0 from 1.9.0 ##
@@ -156,119 +217,185 @@ In Visual Studio's Solution Explorer window:
There have been considerable changes to the WP7 project structure in Apache Cordova 2.0.0 which make this upgrade a little more involved that the others. Essentially this is not an upgrade but creation of a new project and copy over of existing source files.
In Visual Studio's Solution Explorer window:
-1. Create a new Apache Cordova WP7 2.0 Project
-2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+
+1. Create a new Apache Cordova WP7 2.0 Project.
+
+2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project.
+
3. Update your HTML to use the new `cordova-2.0.0.js` file.
+
4. Copy and overwrite any splash screen, or icon images.
-5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+
+5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project.
+
6. Build and test.
## Upgrade to 1.9.0 from 1.8.0 ##
In Visual Studio's Solution Explorer window:
+
1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+
2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
-3. Right-click on __References__ and select __Add Reference__
-4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+
+3. Right-click on __References__ and select __Add Reference__.
+
+4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`.
- __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+
5. Copy the new `cordova-1.9.0.js` into your project. (Be sure it is marked as Content.)
+
6. Update your HTML to use the new `cordova-1.9.0.js` file.
## Upgrade to 1.8.0 from 1.7.0 ##
In Visual Studio's Solution Explorer window:
+
1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+
2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
-3. Right-click on __References__ and select __Add Reference__
-4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+
+3. Right-click on __References__ and select __Add Reference__.
+
+4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`.
- __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+
5. Copy the new `cordova-1.8.0.js` into your project. (Be sure it is marked as Content.)
+
6. Update your HTML to use the new `cordova-1.8.0.js` file.
## Upgrade to 1.7.0 from 1.6.0 ##
In Visual Studio's Solution Explorer window:
+
1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+
2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
-3. Right-click on __References__ and select __Add Reference__
-4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+
+3. Right-click on __References__ and select __Add Reference__.
+
+4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`.
- __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+
5. Copy the new `cordova-1.7.0.js` into your project. (Be sure it is marked as Content.)
+
6. Update your HTML to use the new `cordova-1.7.0.js` file.
## Upgrade to 1.6.1 from 1.6.0 ##
In Visual Studio's Solution Explorer window:
+
1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+
2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
-3. Right-click on __References__ and select __Add Reference__
-4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+
+3. Right-click on __References__ and select __Add Reference__.
+
+4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`.
- __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+
5. Copy the new `cordova-1.6.1.js` into your project. (Be sure it is marked as Content.)
+
6. Update your HTML to use the new `cordova-1.6.1.js` file.
## Upgrade to 1.6.0 from 1.5.0 ##
In Visual Studio's Solution Explorer window:
+
1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+
2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
-3. Right-click on __References__ and select __Add Reference__
-4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+
+3. Right-click on __References__ and select __Add Reference__.
+
+4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`.
- __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+
5. Copy the new `cordova-1.6.0.js` into your project. (Be sure it is marked as Content.)
+
6. Update your HTML to use the new `cordova-1.6.0.js` file.
## Upgrade to 1.5.0 from 1.4.0 ##
In Visual Studio's Solution Explorer window:
+
1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+
2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
-3. Right-click on __References__ and select __Add Reference__
-4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+
+3. Right-click on __References__ and select __Add Reference__.
+
+4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`.
- __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+
5. Copy the new `cordova-1.5.0.js` into your project. (Be sure it is marked as Content.)
+
6. Update your HTML to use the new `cordova-1.5.0.js` file.
## Upgrade to 1.4.0 from 1.3.0 ##
In Visual Studio's Solution Explorer window:
+
1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+
2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
-3. Right-click on __References__ and select __Add Reference__
-4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+
+3. Right-click on __References__ and select __Add Reference__.
+
+4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`.
- __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+
5. Copy the new `cordova-1.4.0.js` into your project. (Be sure it is marked as Content.)
+
6. Update your HTML to use the new `cordova-1.4.0.js` file.
## Upgrade to 1.3.0 from 1.2.0 ##
In Visual Studio's Solution Explorer window:
+
1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+
2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
-3. Right-click on __References__ and select __Add Reference__
-4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+
+3. Right-click on __References__ and select __Add Reference__.
+
+4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`.
- __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+
5. Copy the new `cordova-1.3.0.js` into your project. (Be sure it is marked as Content.)
+
6. Update your HTML to use the new `cordova-1.3.0.js` file.
## Upgrade to 1.2.0 from 1.1.0 ##
In Visual Studio's Solution Explorer window:
+
1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+
2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
-3. Right-click on __References__ and select __Add Reference__
-4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+
+3. Right-click on __References__ and select __Add Reference__.
+
+4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`.
- __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+
5. Copy the new `cordova-1.2.0.js` into your project. (Be sure it is marked as Content.)
+
6. Update your HTML to use the new `cordova-1.2.0.js` file.
## Upgrade to 1.1.0 from 1.0.0 ##
In Visual Studio's Solution Explorer window:
+
1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+
2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
-3. Right-click on __References__ and select __Add Reference__
-4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+
+3. Right-click on __References__ and select __Add Reference__.
+
+4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`.
- __NOTE:__ you can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+
5. Copy the new `cordova-1.1.0.js` into your project. (Be sure it is marked as Content.)
+
6. Update your HTML to use the new `cordova-1.1.0.js` file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/index.md b/docs/en/3.0.0/index.md
index d89fd8e..42f5aa4 100644
--- a/docs/en/3.0.0/index.md
+++ b/docs/en/3.0.0/index.md
@@ -31,7 +31,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
</li>
<li>
<h2>Platform Guides</h2>
- <span>Set up each SDK to create your first app.</span>
+ <span>Set up each SDK and update projects</span>
</li>
<li>
<h2>Configuration Reference</h2>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/plugin_ref/spec.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/plugin_ref/spec.md b/docs/en/3.0.0/plugin_ref/spec.md
index 63b9b0c..685998d 100644
--- a/docs/en/3.0.0/plugin_ref/spec.md
+++ b/docs/en/3.0.0/plugin_ref/spec.md
@@ -32,7 +32,7 @@ A sample plugin element:
id="com.alunny.foo"
version="1.0.2">
-## <plugin> element
+## `<plugin>` element
The `plugin` element is the plugin manifest's top-level element. It
features the following attributes:
@@ -51,9 +51,9 @@ features the following attributes:
A version number for the plugin, that matches the following
major-minor-patch style regular expression:
- ^\d+[.]\d+[.]\d+$
+ ^\d+[.]\d+[.]\d+$
-## <engines> and <engine> elements
+## `<engines>` and `<engine>` elements
The child elements of the `<engines>` element specify versions of
Apache Cordova-based frameworks that this plugin supports. An example:
@@ -68,7 +68,7 @@ Similar to the `<plugin>` element's `version` attribute, the specified
version string should match a major-minor-patch string conforming to
the regular expression:
- ^\d+[.]\d+[.]\d+$
+ ^\d+[.]\d+[.]\d+$
Engine elements may also specify fuzzy matches to avoid repetition,
and to reduce maintenance when the underlying platform is updated.
@@ -86,7 +86,7 @@ project does not meet the engine's constraints.
If no `<engine>` tags are specified, plugman attempts to install into
the specified cordova project directory blindly.
-## <name> element
+## `<name>` element
A human-readable name for the plugin, whose text content contains the
name of the plugin. For example:
@@ -95,7 +95,35 @@ name of the plugin. For example:
This element does not (yet) handle localization.
-## <asset> element
+## `<description>` element
+
+A human-readable description for the plugin. The text content of the element contains
+the description of the plugin. An example:
+
+ <description>Foo plugin description</description>
+
+This element does not (yet) handle localization.
+
+## `<author>` element
+
+Plugin author name. The text content of the element contains
+the name of the plugin author. An example:
+
+ <author>Foo plugin description</author>
+
+## `<keywords>` element
+
+Plugin keywords. The text content of the element contains comma separated keywords to describe the plugin. An example:
+
+ <keywords>foo,bar</keywords>
+
+## `<license>` element
+
+Plugin license. The text content of the element contains the plugin license. An example:
+
+ <license>Apache 2.0 License</license>
+
+## `<asset>` element
One or more elements listing the files or directories to be copied
into a Cordova app's `www` directory. Examples:
@@ -132,7 +160,7 @@ platform-specific web assets, as described below. Attributes include:
issues a notification about the conflict, and exits with a non-zero
code.
-## <js-module> element
+## `<js-module>` element
Most plugins include one or more JavaScript files. Each `<js-module>`
tag corresponds to a JavaScript file, and prevents the plugin's users
@@ -169,18 +197,18 @@ Details for the `<js-module>` tag:
* Three tags are allowed within `<js-module>`:
- * `<clobbers target="some.value" />` indicates that the
+ * `<clobbers target="some.value"/>` indicates that the
`module.exports` is inserted into the `window` object as
`window.some.value`. You can have as many `<clobbers>` as you
like. Any object not available on `window` is created.
- * `<merges target="some.value" />` indicates that the module
+ * `<merges target="some.value"/>` indicates that the module
should be merged with any existing value at `window.some.value`.
If any key already exists, the module's version overrides the
original. You can have as many `<merges>` as you like. Any
object not available on `window` is created.
- * `<runs />` means that your code should be specified with
+ * `<runs/>` means that your code should be specified with
`cordova.require`, but not installed on the `window`
object. This is useful when initializing the module, attaching
event handlers or otherwise. You can only have up to one
@@ -198,7 +226,7 @@ exits with a non-zero code.
Nesting `<js-module>` elements within `<platform>` declares
platform-specific JavaScript module bindings.
-## <dependency>
+## `<dependency>`
The `<dependency>` tag allows you specify other plugins on which the
current plugin depends. While future versions will access them from
@@ -240,7 +268,7 @@ installed the plugin with a local path directly to it. Plugman finds
the root of the git repository and then finds the other plugin from
there.
-## <platform>
+## `<platform>`
The `<platform>` tag identifies platforms that have associated native
code or require modifications to their configuration files. Tools
@@ -271,7 +299,7 @@ chosen, are listed:
* wp7
* wp8
-## <source-file>
+## `<source-file>`
The `<source-file>` element identifies executable source code that
should be installed into a project. Examples:
@@ -312,7 +340,7 @@ It supports the following attributes:
If set, assigns the specified compiler flags for the particular
source file.
-## <config-file>
+## `<config-file>`
Identifies an XML-based configuration file to be modified, where in
that document the modification should take place, and what should be
@@ -375,7 +403,7 @@ It supports the following attributes:
document, the tool stops and reverses the installation process,
issues a warning, and exits with a non-zero code.
-## <plugins-plist>
+## `<plugins-plist>`
This is _outdated_ as it only applies to cordova-ios 2.2.0 and
below. Use the `<config-file>` tag for newer versions of Cordova.
@@ -391,7 +419,7 @@ file in an iOS Cordova project. For example:
<plugins-plist key="Foo" string="CDVFoo" />
-## <resource-file> and <header-file>
+## `<resource-file>` and `<header-file>`
Like source files, but specifically for platforms such as iOS that
distinguish between source files, headers, and resources. Examples:
@@ -400,7 +428,7 @@ distinguish between source files, headers, and resources. Examples:
<resource-file src="CDVFooViewController.xib" />
<header-file src="CDVFoo.h" />
-## <lib-file>
+## `<lib-file>`
Like source, resource, and header files, but specifically for
platforms such as BlackBerry 10 that use user-generated libraries.
@@ -420,7 +448,7 @@ Supported attributes:
* `arch`: The architecture for which the `.so` file has been built,
either `device` or `simulator`.
-## <framework>
+## `<framework>`
Identifies a framework (usually part of the OS/platform) on which the plugin depends.
@@ -429,9 +457,6 @@ Examples:
<framework src="libsqlite3.dylib" />
<framework src="social.framework" weak="true" />
-
-
-
The `src` attribute identifies the framework, which plugman attempts
to add to the Cordova project, in the correct fashion for a given
platform.
@@ -439,7 +464,7 @@ platform.
The optional `weak` attribute is a boolean indicating whether the
framework should be weakly linked. The default is `false`.
-## <info>
+## `<info>`
Additional information provided to users. This is useful when you
require extra steps that can't be easily automated or are beyond
[4/6] Update 3.0.0 from edge directory.
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/cli/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/cli/index.md b/docs/en/3.0.0/guide/cli/index.md
index 1f94040..7d4c42f 100644
--- a/docs/en/3.0.0/guide/cli/index.md
+++ b/docs/en/3.0.0/guide/cli/index.md
@@ -39,7 +39,7 @@ platform's SDK. The CLI supports the following combinations:
* iOS (Mac)
* Android (Mac, Linux)
-* BlackBerry (Mac, Windows)
+* BlackBerry 10 (Mac, Linux, Windows)
* Windows Phone 7 (Windows)
* Windows Phone 8 (Windows)
@@ -72,9 +72,12 @@ To install the `cordova` command-line tool, follow these steps:
Go to the directory where you maintain your source code, and run a
command such as the following:
- $ cordova create HelloWorld com.example.hello "HelloWorld"
+ $ cordova create hello com.example.hello HelloWorld
-The first argument specifies a _HelloWorld_ directory to be generated
+It may take some time for the command to complete, so be patient. Run
+the `cordova -d` to see information about progress.
+
+The first argument specifies a _hello_ directory to be generated
for your project. Its `www` subdirectory houses your application's
home page, along with various resources under `css`, `js`, and `img`,
which follow common web development file-naming conventions. The
@@ -83,7 +86,7 @@ distribute the application.
The other two arguments are optional: the `com.example.hello` argument
provides your project with a reverse domain-style identifier, and the
-`"HelloWorld!"` provides the application's display text. You can edit
+`HelloWorld` provides the application's display text. You can edit
both of these values later in the `config.xml` file.
## Add Platforms
@@ -91,7 +94,7 @@ both of these values later in the `config.xml` file.
All subsequent commands need to be run within the project's directory,
or any subdirectories within its scope:
- $ cd HelloWorld
+ $ cd hello
Before you can build the project, you need to specify a set of target
platforms. Your ability to run these commands depends on whether your
@@ -146,7 +149,7 @@ Edit this application however you want, but any initialization should
be specified as part of the `deviceready` event handler, referenced by
default from `www/js/index.js`.
<!-- XREF
-(See Application Development Guide for details.)
+(See the Application Development Guide for details.)
XREF -->
Run the following command to iteratively build the project:
@@ -170,7 +173,7 @@ an alternative to modify and compile the platform-specific code that
Cordova generates within `platforms/ios`. You can use the same
approach with other platforms' SDKs.
-## View the App in an Emulator
+## Test the App on an Emulator or Device
SDKs for mobile platforms often come bundled with emulators that
execute a device image, so that you can launch the app from the home
@@ -196,6 +199,18 @@ launch from the home screen:
+Alternately, you can plug the handset into your computer and test the
+app directly:
+
+ $ cordova run android
+
+Before running this command, you need to set up the device for
+testing, following procedures that vary for each platform. In
+Android's case, you would have to enable a __USB debugging__ option on
+the device, and perhaps add a USB driver depending on your development
+environmnent.
+See Platform Guides for details on each platform's requirements.
+
## Add Features
When you build and view a new project, the default application that
@@ -218,59 +233,114 @@ The `cordova plugin add` command requires you to specify the
repository for the plugin code. Here are examples of features you
might add:
-* Basic device information:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git
-* Network and battery status:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git
-* Accelerometer, compass, and geolocation:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
-* Camera, media capture, and media playback:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git
-* Access files on device or network:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer.git
-* Notifications via dialog box or vibration:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git
+* Basic device information (Device API):
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git
+
+* Network Connection and Battery Events:
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git
+
+* Accelerometer, Compass, and Geolocation:
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
+
+* Camera, Media playback and Capture:
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git
+
+* Access files on device or network (File API):
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer.git
+
+* Notification via dialog box or vibration:
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git
+
* Contacts:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git
+
* Globalization:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git
-* Splash Screen:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git
-* In-app browser:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git
+
+* Splashscreen:
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git
+
+* Open new browser windows (InAppBrowser):
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git
+
* Debug console:
- $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-console.git
-Use `plugin ls` (or `plugin list`) to view currently installed
-plugins. Each displays by its identifier:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-console.git
- $ cordova plugin ls # or 'plugin list'
- [ 'org.apache.cordova.core.console' ]
+Use `plugin ls` (or `plugin list`, or `plugin` by itself) to view
+currently installed plugins. Each displays by its identifier:
+
+ $ cordova plugin ls # or 'plugin list'
+ [ 'org.apache.cordova.core.console' ]
To remove a plugin, refer to it by the same identifier that appears in
the listing. For example, here is how you would remove support for a
debug console from a release version:
- $ cordova plugin rm org.apache.cordova.core.console
- $ cordova plugin remove org.apache.cordova.core.console # same
+ $ cordova plugin rm org.apache.cordova.core.console
+ $ cordova plugin remove org.apache.cordova.core.console # same
You can batch-remove or add plugins by specifying more than one
argument for each command.
-<!--
+## Customize Each Platform
+
+While Cordova allows you to easily deploy an app for many different
+platforms, sometimes you need to add customizations. In that case,
+you don't want to modify the source files in various `www` directories
+within the top-level `platforms` directory, because they're regularly
+replaced with the top-level `www` directory's cross-platform source.
+
+Instead, the top-level `merges` directory offers a place to specify
+assets to deploy on specific platforms. Each platform-specific
+subdirectory within `merges` mirrors the directory structure of the
+`www` source tree, allowing you to override or add files as needed.
+For example, here is how you might uses `merges` to boost the default
+font size for Android devices:
+
+* Edit the `www/index.html` file, adding a link to an additional CSS
+ file, `overrides.css` in this case:
+
+ <link rel="stylesheet" type="text/css" href="css/overrides.css" />
+
+* Optionally create an empty `www/css/overrides.css` file, which would
+ apply for all non-Android builds, preventing a missing-file error.
+
+* Create a `css` subdirectory within `merges/android`, then add a
+ corresponding `overrides.css` file. Specify CSS that overrides the
+ 12-point default font size specified within `www/css/index.css`, for
+ example:
+
+ body { font-size:14px; }
-## Run the App on the Device
+When you rebuild the project, the Android version features the custom
+font size, while others remain unchanged.
--->
+You can also use `merges` to add files not present in the original
+`www` directory. For example, an app can incorporate a _back button_
+graphic into the iOS interface, stored in
+`merges/ios/img/back_button.png`, while the Android version can
+instead capture `backbutton` events from the corresponding hardware
+button.
-## Update the App
+## Updating Cordova
After installing installing the `cordova` utility, you can always
update it to the latest version by running the following command:
@@ -279,10 +349,19 @@ update it to the latest version by running the following command:
Use this syntax to install a specific version:
- $ sudo npm install -g cordova@2.8.0
+ $ sudo npm install -g cordova@3.0.0
-Run the `info` command for a listing that includes the current version
+Run `cordova -v` to see the currently running version. Run the `npm
+info` command for a longer listing that includes the current version
along with other available version numbers:
$ npm info cordova
+Cordova 3.0 is the first version to support the command-line interface
+described in this section. If you are updating from a version prior to
+3.0, you need to create a new project as described above, then copy
+the older application's assets into the top-level `www` directory.
+Where applicable, further details about upgrading to 3.0 are available
+in the Platform Guides. Once you upgrade to the `cordova`
+command-line interface and use `npm update` to stay current, the more
+time-consuming procedures described there are no longer relevant.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/hybrid/plugins/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/hybrid/plugins/index.md b/docs/en/3.0.0/guide/hybrid/plugins/index.md
index 64896fd..cb4d01b 100644
--- a/docs/en/3.0.0/guide/hybrid/plugins/index.md
+++ b/docs/en/3.0.0/guide/hybrid/plugins/index.md
@@ -44,44 +44,48 @@ front-facing and arguably most important part of your Cordova plugin.
You can structure your plugin's JavaScript however you like. The one
thing you _must_ use to communicate between the Cordova JavaScript
- and native environments is the `cordova.exec` function. Here is an example:
+and native environments is the `cordova.exec` function. Here is an example:
- cordova.exec(function(winParam) {}, function(error) {}, "service",
- "action", ["firstArgument", "secondArgument", 42,
- false]);
+ cordova.exec(function(winParam) {}, function(error) {}, "service",
+ "action", ["firstArgument", "secondArgument", 42,
+ false]);
The parameters are detailed below:
-1. `function(winParam) {}` - Success function callback. Assuming your
- `exec` call completes successfully, this function is invoked
- (optionally with any parameters you pass back to it).
-2. `function(error) {}` - Error function callback. If the operation does
- not complete successfully, this function is invoked (optionally
- with an error parameter).
-3. `"service"` - The service name to call into on the native side. This
- is mapped to a native class, about which more information is
- available in the native guides listed below.
-4. `"action"` - The action name to call into. This is picked up by the
- native class receiving the `exec` call, and, depending on the
- platform, essentially maps to a class's method.
- The native guides listed below provide details.
-5. `[/* arguments */]` - Arguments to pass into the native environment.
+* `function(winParam) {}`: Success function callback. Assuming your
+ `exec` call completes successfully, this function is invoked
+ (optionally with any parameters you pass back to it).
+
+* `function(error) {}`: Error function callback. If the operation does
+ not complete successfully, this function is invoked (optionally with
+ an error parameter).
+
+* `"service"`: The service name to call into on the native side. This
+ is mapped to a native class, about which more information is
+ available in the native guides listed below.
+
+* `"action"`: The action name to call into. This is picked up by the
+ native class receiving the `exec` call, and, depending on the
+ platform, essentially maps to a class's method. The native guides
+ listed below provide details.
+
+* `[/* arguments */]`: Arguments to pass into the native environment.
### Echo Plugin JavaScript Example
- window.echo = function(str, callback) {
- cordova.exec(callback, function(err) {
- callback('Nothing to echo.');
- }, "Echo", "echo", [str]);
- };
+ window.echo = function(str, callback) {
+ cordova.exec(callback, function(err) {
+ callback('Nothing to echo.');
+ }, "Echo", "echo", [str]);
+ };
Let's dive into this. The plugin attaches itself to `window`,
specifically to the `echo` function. Plugin users would then use it as
follows:
- window.echo("echome", function(echoValue) {
- alert(echoValue == "echome"); // should alert true.
- });
+ window.echo("echome", function(echoValue) {
+ alert(echoValue == "echome"); // should alert true.
+ });
First, let's take a look at the last three arguments to the `exec`
function. We will be calling the `Echo` "service", requesting the `echo`
@@ -100,7 +104,7 @@ Cordova has a plugin specification available to enable automated
installation of the plugin for Android, iOS, BlackBerry 10 and Windows
Phone platforms. By structuring your plugin in a particular way and
adding a `plugin.xml` manifest file, you can enable users to install
-your plugin via the command line tooling.
+your plugin via the command-line tooling.
- Plugin Specification
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/overview/index.md b/docs/en/3.0.0/guide/overview/index.md
index 195c84e..c6b7b83 100644
--- a/docs/en/3.0.0/guide/overview/index.md
+++ b/docs/en/3.0.0/guide/overview/index.md
@@ -38,7 +38,7 @@ Use Cordova if you are:
* a mobile developer interested in mixing native application
components with a _WebView_ (browser window) that can access
- device-level APIs, or if you want to develop a plug-in interface
+ device-level APIs, or if you want to develop a plugin interface
between native and WebView components.
## Basic Components
@@ -58,14 +58,14 @@ which you distribute to app stores. For the web app to interact with
various device features the way native apps do, it must also reference
a `cordova.js` file, which provides API bindings.
<!-- XREF
-(See the API Reference for an overview, and the API and Configuration
-Guide for examples of how to use them.)
+(See the API Reference for an overview, and the Application
+Development Guide for examples of how to use them.)
XREF -->
The Cordova-enabled WebView may provide the application with its
entire user interface. It can also be a component within a larger,
hybrid application that mixes the WebView with native application
-components. Cordova provides a _plug-in_ interface for these
+components. Cordova provides a _plugin_ interface for these
components to communicate with each other.
## Development Paths
@@ -136,64 +136,46 @@ available for each mobile platform:
<th>Windows<br/>Phone 7</th>
<th>Windows<br/>Phone 8</th>
<th>Windows<br/>8</th>
+ <th>Tizen</th>
</tr>
</thead>
<tbody>
<tr>
- <th><a href="#">cordova<br/>CLI</a></th>
+ <th><a href="guide_cli_index.md.html">cordova<br/>CLI</a></th>
<td data-col="android" class="y">Mac, Windows, Linux</td>
- <td data-col="blackberry" class="y">Mac, Windows</td>
+ <td data-col="blackberry" class="n">Mac, Windows</td>
<td data-col="blackberry10" class="y">Mac, Windows</td>
<td data-col="ios" class="y">Mac</td>
<td data-col="winphone7" class="y">Windows</td>
<td data-col="winphone8" class="y">Windows</td>
- <td data-col="win8" class="u"></td>
- </tr>
-
- <tr>
- <th><a href="#">PhoneGap<br/>Build</a></th>
- <td data-col="android" class="y"></td>
- <td data-col="blackberry" class="y"></td>
- <td data-col="blackberry10" class="y"></td>
- <td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="u"></td>
- <td data-col="winphone8" class="y"></td>
- <td data-col="win8" class="u"></td>
- </tr>
-
- <tr>
- <th><a href="guide_platforms_index.md.html">SDK platform support</a></th>
- <td data-col="android" class="y"><a href="guide_platforms_android_index.md.html"> </a></td>
- <td data-col="blackberry" class="y"><a href="guide_platforms_blackberry_index.md.html"> </a></td>
- <td data-col="blackberry10" class="y"><a href="guide_platforms_blackberry10_index.md.html"> </a></td>
- <td data-col="ios" class="y"><a href="guide_platforms_ios_index.md.html"> </a></td>
- <td data-col="winphone7" class="y"><a href="guide_platforms_wp7_index.md.html"> </a></td>
- <td data-col="winphone8" class="y"><a href="guide_platforms_windows-phone-8_index.md.html"> </a></td>
- <td data-col="win8" class="y"><a href="guide_platforms_windows-8_index.md.html"> </a></td>
+ <td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
- <th><a href="#">Embedded<br/>WebView</a></th>
- <td data-col="android" class="y"><a href="guide_platforms_android_webview.md.html"></a></td>
+ <th><a href="guide_hybrid_webviews_index.md.html">Embedded<br/>WebView</a></th>
+ <td data-col="android" class="y"><a href="guide_platforms_android_webview.md.html">(see details)</a></td>
<td data-col="blackberry" class="n"></td>
<td data-col="blackberry10" class="n"></td>
- <td data-col="ios" class="y"><a href="guide_platforms_ios_webview.md.html"></a></td>
+ <td data-col="ios" class="y"><a href="guide_platforms_ios_webview.md.html">(see details)</a></td>
<td data-col="winphone7" class="n"></td>
<td data-col="winphone8" class="n"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
- <th><a href="guide_plugin-development_index.md.html">Plug-in<br/>Interface</a></th>
- <td data-col="android" class="y"><a href="guide_guide_platforms_android_plugin.md.html"></a></td>
- <td data-col="blackberry" class="y"><a href="guide_guide_platforms_blackberry_plugin.md.html"></a></td>
- <td data-col="blackberry10" class="y"><a href="guide_guide_platforms_blackberry10_plugin.md.html"></a></td>
- <td data-col="ios" class="y"><a href="guide_guide_platforms_ios_plugin.md.html"></a></td>
- <td data-col="winphone7" class="y"><a href="guide_guide_platforms_wp8_plugin.md.html"></a></td>
- <td data-col="winphone8" class="n"></td>
+ <th><a href="guide_hybrid_plugins_index.md.html">Plug-in<br/>Interface</a></th>
+ <td data-col="android" class="y"><a href="guide_guide_platforms_android_plugin.md.html">(see details)</a></td>
+ <td data-col="blackberry" class="y"><a href="guide_guide_platforms_blackberry_plugin.md.html">(see details)</a></td>
+ <td data-col="blackberry10" class="y"><a href="guide_guide_platforms_blackberry10_plugin.md.html">(see details)</a></td>
+ <td data-col="ios" class="y"><a href="guide_guide_platforms_ios_plugin.md.html">(see details)</a></td>
+ <td data-col="winphone7" class="y"><a href="guide_guide_platforms_wp8_plugin.md.html">(see details)</a></td>
+ <td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
@@ -210,6 +192,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -221,6 +204,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -232,17 +216,19 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
<th><a href="cordova_compass_compass.md.html">Compass</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="n"></td>
- <td data-col="blackberry10" class="n"></td>
+ <td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y">(3GS+)</td>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -254,6 +240,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -265,6 +252,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
@@ -276,6 +264,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -287,6 +276,7 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -295,9 +285,10 @@ available for each mobile platform:
<td data-col="blackberry" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="y"></td>
- <td data-col="winphone8" class="y"></td>
+ <td data-col="winphone7" class="p">(no FileTransfer)</td>
+ <td data-col="winphone8" class="p">(no FileTransfer)</td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
@@ -309,17 +300,19 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_globalization_globalization.md.html">Globalization</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="y"></td>
- <td data-col="blackberry10" class="y"></td>
+ <td data-col="blackberry10" class="n"></td>
<td data-col="ios" class="y"></td>
<td data-col="winphone7" class="n"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
@@ -330,18 +323,20 @@ available for each mobile platform:
<td data-col="ios" class="y"></td>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
- <td data-col="win8" class="y"></td>
+ <td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
<th><a href="cordova_media_media.md.html">Media</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="n"></td>
- <td data-col="blackberry10" class="n"></td>
+ <td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
@@ -353,17 +348,19 @@ available for each mobile platform:
<td data-col="winphone7" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
<tr>
<th><a href="cordova_splashscreen_splashscreen.md.html">Splashscreen</a></th>
<td data-col="android" class="y"></td>
<td data-col="blackberry" class="n"></td>
- <td data-col="blackberry10" class="n"></td>
+ <td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="n"></td>
- <td data-col="winphone8" class="n"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="tizen" class="n"></td>
</tr>
<tr>
@@ -372,9 +369,10 @@ available for each mobile platform:
<td data-col="blackberry" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="y"></td>
- <td data-col="winphone8" class="y"></td>
+ <td data-col="winphone7" class="p">localStorage only</td>
+ <td data-col="winphone8" class="p">localStorage only</td>
<td data-col="win8" class="y"></td>
+ <td data-col="tizen" class="y"></td>
</tr>
</tbody>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/config.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/config.md b/docs/en/3.0.0/guide/platforms/android/config.md
index 00a1ecd..d3e710c 100644
--- a/docs/en/3.0.0/guide/platforms/android/config.md
+++ b/docs/en/3.0.0/guide/platforms/android/config.md
@@ -19,22 +19,47 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Android Configuration
-The `config.xml` settings file controls various settings of Cordova. This is application wide, and not set per CordovaWebView Instance.
+The `config.xml` file controls various Cordova settings. These apply
+across the application, and per CordovaWebView instance.
-## <preference>
+## `<preference>`
-Various **other** preferences (as **<preference>** tags) default on not breaking existing apps. The available preferences are:
+Various other preferences (as `<preference>` tags) default on not
+breaking existing apps. The available preferences are:
-1. **useBrowserHistory (boolean, defaults to true)** - set to false if you want to use the history shim that was used to work around the hashtag error present in Android 3.x prior to the history fix. (Note: This setting will be deprecated in April 2013)
-2. **loadingDialog** - Display a native loading dialog when loading the app. The value's format is _Title, Message_
-3. **loadingPageDialog** - Display a native loading dialog when loading sub-pages. The value's format is _Title, Message_
-4. **errorUrl** - Set the error page for your application. Should be located in your Android project in file://android_asset/www/
-5. **backgroundColor** - Set the background color for your application. Supports a four-byte hex value, with the first byte representing alpha value, and the following three bytes with standard RGB values. (i.e. 0x00000000 = Black)
-6. **loadUrlTimeoutValue** - How much time Cordova should wait before throwing a timeout error on the application.
-7. **keepRunning (boolean, defaults to true)** - Determines whether Cordova will keep running in the background or not
-8. **splashscreen** - The name of the file minus its extension in the `res/drawable` directory. If you have multiple assets, they all must share this common name in their respective directories.
-9. **disallowOverscroll (boolean, defaults to false)** - set to true if you want to disable the glow when a user scrolls beyond the edge of the webview.
+* `useBrowserHistory` (boolean, defaults to `true`): set to false if you
+ want to use the history shim that was used to work around the
+ hashtag error present in Android 3.x prior to the history fix.
+ (Note: This setting will be deprecated in April 2013)
-## <plugin>
+* `loadingDialog`: Display a native loading dialog when loading the
+ app. The value's format is _Title, Message_
+
+* `loadingPageDialog`: Display a native loading dialog when loading
+ sub-pages. The value's format is _Title, Message_
+
+* `errorUrl`: Set the error page for your application. Should be
+ located in your Android project in file://android_asset/www/
+
+* `backgroundColor`: Set the background color for your application.
+ Supports a four-byte hex value, with the first byte representing
+ alpha value, and the following three bytes with standard RGB
+ values. (i.e. 0x00000000 = Black)
+
+* `loadUrlTimeoutValue`: How much time Cordova should wait before
+ throwing a timeout error on the application.
+
+* `keepRunning` (boolean, defaults to `true`): Determines whether
+ Cordova stays running in the background.
+
+* `splashscreen`: The name of the file minus its extension in the
+ `res/drawable` directory. If you have multiple assets, they all
+ must share this common name in their respective directories.
+
+* `disallowOverscroll` (boolean, defaults to `false`): set to `true` to
+ disable the glow when a user scrolls beyond the edge of the webview.
+
+## `<plugin>`
+
+Android supports using `<feature>` as analogues to `<plugin>` elements.
-Android supports using <feature> as analogues to <plugin> elements.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/index.md b/docs/en/3.0.0/guide/platforms/android/index.md
index 63673f0..4e42f50 100644
--- a/docs/en/3.0.0/guide/platforms/android/index.md
+++ b/docs/en/3.0.0/guide/platforms/android/index.md
@@ -30,7 +30,7 @@ detailed platform-specific information:
* Android Command-line Tools
The command-line tools above refer to versions prior to Cordova 3.0.
-See The Cordova Command-line Interface for information about the
+See The Command-line Interface for information about the
current interface.
## Requirements and Support
@@ -111,19 +111,27 @@ Cordova The Command-line Interface. For example, in a source-code directory:
Once created, here's how to use the SDK to modify it:
* Launch the __Eclipse__ application.
+
* Select the __New Project__ menu item.
+
* Choose __Android Project from Existing Code__ from the resulting dialog box, and press __Next__:
+
* Navigate to `hello`, or whichever directory you created for the project, then to the `platforms/android` subdirectory.
+
* Press __Finish__.
Once the Eclipse window opens, a red __X__ may appear to indicate
unresolved problems. If so, follow these additional steps:
-* Right-click on the project folder.
+* Right-click on the project directory.
+
* 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.
## Deploy to Emulator
@@ -179,9 +187,12 @@ For a faster experience, use an Intel-based emulator image:
* Install one or more `Intel x86 Atom` System Images as well as the
`Intel Hardware Accelerated Execution Manager`, available under
__Extras__.
+
* Run the Intel installer, which is available within your Android SDK
at `extras/intel/Hardware_Accelerated_Execution_Manager`.
+
* Create a new AVD with the target set to an Intel image.
+
* When starting the emulator, ensure there are no error messages
indicating a failure to load HAX modules.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/plugin.md b/docs/en/3.0.0/guide/platforms/android/plugin.md
index 6a6540a..ecd5a5a 100644
--- a/docs/en/3.0.0/guide/platforms/android/plugin.md
+++ b/docs/en/3.0.0/guide/platforms/android/plugin.md
@@ -19,14 +19,19 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Android Plugins
-Writing a plugin requires an understanding of the architecture of Cordova-Android. Cordova-Android consists
-of an Android WebView with hooks attached to it. These plugins are represented as class mappings in the config.xml
-file.
-
-A plugin consists of at least one Java class that extends the `CordovaPlugin` class. A plugin must override one
-of the `execute` methods from `CordovaPlugin`.
-As best practice, the plugin should handle `pause` and `resume` events, and any message passing between plugins.
-Plugins with long-running requests, background activity such as media playback, listeners, or internal state should implement the `onReset()` method as well. This method is run when the `WebView` navigates to a new page or refreshes, which reloads the JavaScript.
+Writing a plugin requires an understanding of the architecture of
+Cordova-Android. Cordova-Android consists of an Android WebView with
+hooks attached to it. These plugins are represented as class mappings
+in the `config.xml` file.
+
+A plugin consists of at least one Java class that extends the
+`CordovaPlugin` class. A plugin must override one of the `execute`
+methods from `CordovaPlugin`. As best practice, the plugin should
+handle `pause` and `resume` events, and any message passing between
+plugins. Plugins with long-running requests, background activity such
+as media playback, listeners, or internal state should implement the
+`onReset()` method as well. It executeswhen the `WebView` navigates to
+a new page or refreshes, which reloads the JavaScript.
## Plugin Class Mapping
@@ -38,9 +43,13 @@ This marshals a request from the WebView to the Android native side,
more or less boiling down to calling the `action` method on the
`service` class, with the arguments passed in the `args` Array.
-Whether you distribute your plugin as Java file or as a JAR of its own, the plugin must be added to the `config.xml` file in your Cordova-Android application's `res/xml/` folder.
+Whether you distribute your plugin as Java file or as a JAR of its
+own, the plugin must be added to the `config.xml` file in your
+Cordova-Android application's `res/xml/` directory.
- <plugin name="<service_name>" value="<full_name_including_namespace>"/>
+ <feature name="<service_name>">
+ <param name="android-package" value="<full_name_including_namespace>" />
+ </feature>
The service name should match the one used in the JavaScript `exec`
call, and the value is the Java classes full name, including the
@@ -118,7 +127,9 @@ If you do not need to run on the UI thread, but do not want to block the WebCore
Add the following to our `config.xml` file:
- <plugin name="Echo" value="org.apache.cordova.plugin.Echo" />
+ <feature name="Echo">
+ <param name="android-package" value="org.apache.cordova.plugin.Echo" />
+ </feature>
Then add the following file to
`src/org/apache/cordova/plugin/Echo.java` inside our Cordova-Android
@@ -184,6 +195,7 @@ Eclipse can be used to debug an Android project, and the plugins can be debugged
* Plugins have access to a `CordovaInterface` object. This object has access to the Android `Activity` that is running the application. This is the `Context` required to launch
a new Android `Intent`. The `CordovaInterface` allows plugins to start an `Activity` for a result, and to set the callback plugin for when the `Intent` comes back to the application. This is important, since the
`Intent`s system is how Android communicates between processes.
+
* Plugins do not have direct access to the `Context` as they have in the past. The legacy `ctx` member is deprecated, and will be removed six months after 2.0 is released. All of `ctx` methods exist on the `Context`, so both `getContext()` and `getActivity()` are capable of returning the proper object required.
## Use the Source
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/tools.md b/docs/en/3.0.0/guide/platforms/android/tools.md
index 09fcfdc..ce4b19c 100644
--- a/docs/en/3.0.0/guide/platforms/android/tools.md
+++ b/docs/en/3.0.0/guide/platforms/android/tools.md
@@ -58,6 +58,7 @@ Release, on Mac or Windows:
The `run` command accepts the following _optional_ parameters:
* Target specification. This includes `--emulator`, `--device`, or `--target=<targetID>`.
+
* Build specification. This includes `--debug`, `--release`, or `--nobuild`.
$ /path/to/project/cordova/run [Target] [Build]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/upgrading.md b/docs/en/3.0.0/guide/platforms/android/upgrading.md
index 64be68f..d703ef6 100644
--- a/docs/en/3.0.0/guide/platforms/android/upgrading.md
+++ b/docs/en/3.0.0/guide/platforms/android/upgrading.md
@@ -21,21 +21,24 @@ license: Licensed to the Apache Software Foundation (ASF) under one
This guide shows how to modify Android projects to upgrade from older versions of Cordova.
Most of these instructions apply to projects created with an older set
-of command-line tools that precede the `cordova` CLI utility. See The
-Cordova Command-line Interface for information how to update the
+of command-line tools that precede the `cordova` CLI utility. See The Command-line Interface for information how to update the
version of the CLI.
## Upgrade to the CLI (3.0.0) from 2.9.0 ##
1. Create a new Apache Cordova 3.0.0 project using the cordova CLI, as
- described in The Cordova Command-line Interface.
+ described in The Command-line Interface.
+
2. Add your platforms the the cordova project, for example: `cordova
platform add android`.
-3. Copy the contents of your project's `www` folder to the `www` folder
+
+3. Copy the contents of your project's `www` directory to the `www` directory
at the root of the cordova project you just created.
+
4. Copy any native assets from your old project into the appropriate
directories under `platforms/android`: this directory is where your
native cordova-android project exists.
+
5. Use the cordova CLI tool to install any plugins you need. Note that
the CLI handles all core APIs as plugins, so they may need to be
added. Only 3.0.0 plugins are compatible with the CLI.
@@ -43,226 +46,375 @@ version of the CLI.
## Upgrade to 3.0.0 from 2.9.0 ##
1. Create a new Apache Cordova Android project.
-2. Copy the contents of your `www` folder to the new project.
-3. Copy any native Android assets from your `res` folder to the new project.
+
+2. Copy the contents of your `www` directory to the new project.
+
+3. Copy any native Android assets from your `res` directory to the new project.
+
4. Copy over any plugins you installed from the `src` subdirectories into the new project.
-5. Make sure to upgrade any deprecated `<plugin>` references from your old `config.xml` file to the new `<feature>` specification.
+
+5. Make sure to upgrade any deprecated `<plugin>` references from your old `config.xml` file to the new `<feature>` specification.
+
+6. Update any references to the `org.apache.cordova.api` package to be `org.apache.cordova`.
+
- __NOTE:__ all core APIs have been removed and must be installed as plugins. Please see the Using Plugman to Manage Plugins Guide for details.
## Upgrade to 2.9.0 from 2.8.0
-1. Run `bin/update <project_path>`
+
+1. Run `bin/update <project_path>`.
## Upgrade to 2.8.0 from 2.7.0 ##
-1. Remove `cordova-2.7.0.jar` from the project's `libs` directory
-2. Add `cordova-2.8.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new cordova.js into your project
-5. Update your HTML to use the new cordova.js file
-6. Copy the `res/xml/config.xml` file to match `framework/res/xml/config.xml`
-7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
-8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+1. Remove `cordova-2.7.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.8.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova.js` into your project.
+
+5. Update your HTML to use the new `cordova.js` file.
+
+6. Copy the `res/xml/config.xml` file to match `framework/res/xml/config.xml`.
+
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously.
+
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.7.0 from 2.6.0 ##
-1. Remove `cordova-2.6.0.jar` from the project's `libs` directory
-2. Add `cordova-2.7.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.7.0.js` into your project
-5. Update your HTML to use the new `cordova-2.7.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
-8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+1. Remove `cordova-2.6.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.7.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.7.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.7.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously.
+
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.6.0 from 2.5.0 ##
-1. Remove `cordova-2.5.0.jar` from the project's `libs` directory
-2. Add `cordova-2.6.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.6.0.js` into your project
-5. Update your HTML to use the new `cordova-2.6.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
-8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+1. Remove `cordova-2.5.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.6.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.6.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.6.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously.
+
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
Run `bin/update <project>` with the project path listed in the Cordova Source directory.
## Upgrade to 2.5.0 from 2.4.0 ##
-1. Remove `cordova-2.4.0.jar` from the project's `libs` directory
-2. Add `cordova-2.5.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.5.0.js` into your project
-5. Update your HTML to use the new `cordova-2.5.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
-8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+1. Remove `cordova-2.4.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.5.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.5.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.5.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously.
+
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.4.0 from 2.3.0 ##
-1. Remove `cordova-2.3.0.jar` from the project's `libs` directory
-2. Add `cordova-2.4.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.4.0.js` into your project
-5. Update your HTML to use the new `cordova-2.4.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+1. Remove `cordova-2.3.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.4.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.4.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.4.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.3.0 from 2.2.0 ##
-1. Remove `cordova-2.2.0.jar` from the project's `libs` directory
-2. Add `cordova-2.3.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.3.0.js` into your project
-5. Update your HTML to use the new `cordova-2.3.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+1. Remove `cordova-2.2.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.3.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.3.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.3.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.2.0 from 2.1.0 ##
-1. Remove `cordova-2.1.0.jar` from the project's `libs` directory
-2. Add `cordova-2.2.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.2.0.js` into your project
-5. Update your HTML to use the new `cordova-2.2.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+1. Remove `cordova-2.1.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.2.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.2.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.2.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.1.0 from 2.0.0 ##
-1. Remove `cordova-2.0.0.jar` from the project's `libs` directory
-2. Add `cordova-2.1.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.1.0.js` into your project
-5. Update your HTML to use the new `cordova-2.1.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
-7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+1. Remove `cordova-2.0.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.1.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.1.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.1.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
+
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory.
## Upgrade to 2.0.0 from 1.9.0 ##
-1. Remove `cordova-1.9.0.jar` from the project's `libs` directory
-2. Add `cordova-2.0.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-2.0.0.js` into your project
-5. Update your HTML to use the new `cordova-2.0.0.js` file
-6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
+1. Remove `cordova-1.9.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-2.0.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-2.0.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-2.0.0.js` file.
+
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
### Notes about 2.0.0 release
-config.xml will be replacing cordova.xml and plugins.xml. This new file is a combination of the previous two. However, the
-old files are deprecated, and while currently still work, will cease working in a future release.
+
+`config.xml` will be replacing `cordova.xml` and `plugins.xml`. This
+new file is a combination of the previous two. However, the old files
+are deprecated, and while currently still work, will cease working in
+a future release.
## Upgrade to 1.9.0 from 1.8.1 ##
-1. Remove `cordova-1.8.0.jar` from the project's `libs` directory
-2. Add `cordova-1.9.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.9.0.js` into your project
-5. Update your HTML to use the new `cordova-1.9.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.8.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.9.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.9.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.9.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
### Notes about 1.9.0 release
-- Third-Party plugins may or may not work. This is because of the introduction of the CordovaWebView. These plugins need to get a context from the CordovaInterface using
-getContext() or getActivity(). If you are not an experienced Android developer, please contact the plugin maintainer and add this task to their bug tracker.
+Due to the introduction of the `CordovaWebView`, third-Party plugins
+may not work. These plugins need to get a context from the
+`CordovaInterface` using `getContext()` or `getActivity()`. If you
+are not an experienced Android developer, please contact the plugin
+maintainer and add this task to their bug tracker.
## Upgrade to 1.8.0 from 1.8.0 ##
-1. Remove `cordova-1.8.0.jar` from the project's `libs` directory
-2. Add `cordova-1.8.1.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.8.1.js` into your project
-5. Update your HTML to use the new `cordova-1.8.1.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.8.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.8.1.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.8.1.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.8.1.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.8.0 from 1.7.0 ##
-1. Remove `cordova-1.7.0.jar` from the project's `libs` directory
-2. Add `cordova-1.8.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.8.0.js` into your project
-5. Update your HTML to use the new `cordova-1.8.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.7.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.8.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.8.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.8.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.8.0 from 1.7.0 ##
-1. Remove `cordova-1.7.0.jar` from the project's `libs` directory
-2. Add `cordova-1.8.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.8.0.js` into your project
-5. Update your HTML to use the new `cordova-1.8.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.7.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.8.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.8.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.8.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.7.0 from 1.6.1 ##
-1. Remove `cordova-1.6.1.jar` from the project's `libs` directory
-2. Add `cordova-1.7.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.7.0.js` into your project
-5. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.6.1.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.7.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.7.0.js` into your project.
+
+5. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.6.1 from 1.6.0 ##
-1. Remove `cordova-1.6.0.jar` from the project's `libs` directory
-2. Add `cordova-1.6.1.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.6.1.js` into your project
-5. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+1. Remove `cordova-1.6.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.6.1.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.6.1.js` into your project.
+
+5. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.6.0 from 1.5.0 ##
-1. Remove `cordova-1.5.0.jar` from the project's `libs` directory
-2. Add `cordova-1.6.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.6.0.js` into your project
-5. Update your HTML to use the new `cordova-1.6.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
-7. Replace `res/xml/phonegap.xml` with `res/xml/cordova.xml` to match `framework/res/xml/cordova.xml`
+
+1. Remove `cordova-1.5.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.6.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.6.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.6.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
+
+7. Replace `res/xml/phonegap.xml` with `res/xml/cordova.xml` to match `framework/res/xml/cordova.xml`.
## Upgrade to 1.5.0 from 1.4.0##
-1. Remove `phonegap-1.4.0.jar` from the project's `libs` directory
-2. Add `cordova-1.5.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `cordova-1.5.0.js` into your project
-5. Update your HTML to use the new `cordova-1.5.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
-7. Replace `res/xml/phonegap.xml` with `res/xml/cordova.xml` to match `framework/res/xml/cordova.xml`
+
+1. Remove `phonegap-1.4.0.jar` from the project's `libs` directory.
+
+2. Add `cordova-1.5.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `cordova-1.5.0.js` into your project.
+
+5. Update your HTML to use the new `cordova-1.5.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
+
+7. Replace `res/xml/phonegap.xml` with `res/xml/cordova.xml` to match `framework/res/xml/cordova.xml`.
## Upgrade to 1.4.0 from 1.3.0 ##
-1. Remove `phonegap-1.3.0.jar` from the project's `libs` directory
-2. Add `phonegap-1.4.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `phonegap-1.4.0.js` into your project
-5. Update your HTML to use the new `phonegap-1.4.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
-7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`
+
+1. Remove `phonegap-1.3.0.jar` from the project's `libs` directory.
+
+2. Add `phonegap-1.4.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `phonegap-1.4.0.js` into your project.
+
+5. Update your HTML to use the new `phonegap-1.4.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
+
+7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`.
## Upgrade to 1.3.0 from 1.2.0 ##
-1. Remove `phonegap-1.2.0.jar` from the project's `libs` directory
-2. Add `phonegap-1.3.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `phonegap-1.3.0.js` into your project
-5. Update your HTML to use the new `phonegap-1.2.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
-7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`
+
+1. Remove `phonegap-1.2.0.jar` from the project's `libs` directory.
+
+2. Add `phonegap-1.3.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `phonegap-1.3.0.js` into your project.
+
+5. Update your HTML to use the new `phonegap-1.2.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
+
+7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`.
## Upgrade to 1.2.0 from 1.1.0 ##
-1. Remove `phonegap-1.1.0.jar` from the project's `libs` directory
-2. Add `phonegap-1.2.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `phonegap-1.2.0.js` into your project
-5. Update your HTML to use the new `phonegap-1.2.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
-7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`
+
+1. Remove `phonegap-1.1.0.jar` from the project's `libs` directory.
+
+2. Add `phonegap-1.2.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `phonegap-1.2.0.js` into your project.
+
+5. Update your HTML to use the new `phonegap-1.2.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
+
+7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`.
## Upgrade to 1.1.0 from 1.0.0 ##
-1. Remove `phonegap-1.0.0.jar` from the project's `libs` directory
-2. Add `phonegap-1.1.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `phonegap-1.1.0.js` into your project
-5. Update your HTML to use the new `phonegap-1.1.0.js` file
-6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
+1. Remove `phonegap-1.0.0.jar` from the project's `libs` directory.
+
+2. Add `phonegap-1.1.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `phonegap-1.1.0.js` into your project.
+
+5. Update your HTML to use the new `phonegap-1.1.0.js` file.
+
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
## Upgrade to 1.0.0 from 0.9.6 ##
-1. Remove `phonegap-0.9.6.jar` from the project's `libs` directory
-2. Add `phonegap-1.0.0.jar` to the project's `libs` directory
-3. If you are using Eclipse, please refresh your eclipse project and do a clean
-4. Copy the new `phonegap-1.0.0.js` into your project
-5. Update your HTML to use the new `phonegap-1.0.0.js` file
-6. Add the `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
+1. Remove `phonegap-0.9.6.jar` from the project's `libs` directory.
+
+2. Add `phonegap-1.0.0.jar` to the project's `libs` directory.
+
+3. If you are using Eclipse, please refresh your eclipse project and do a clean.
+
+4. Copy the new `phonegap-1.0.0.js` into your project.
+
+5. Update your HTML to use the new `phonegap-1.0.0.js` file.
+
+6. Add the `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/android/webview.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/webview.md b/docs/en/3.0.0/guide/platforms/android/webview.md
index ece0458..dd45a33 100644
--- a/docs/en/3.0.0/guide/platforms/android/webview.md
+++ b/docs/en/3.0.0/guide/platforms/android/webview.md
@@ -34,14 +34,18 @@ but may be eventually be automated.
## Prerequisites
-1. **Cordova 1.9** or greater
-2. Android SDK updated with 15
+* Cordova 1.9 or greater
+
+* Android SDK updated with 15
## Guide to using CordovaWebView in an Android Project
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.
+
+2. `cd` into `/framework` and run `ant jar` to build the cordova jar. It creates the .jar file formed as `cordova-3.0.0.jar` in the `/framework` directory.
+
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
@@ -116,4 +120,5 @@ but may be eventually be automated.
}
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.
+
+7. Copy `cordova.xml` and `plugins.xml` from `/framework/res/xml` to your project's `/res/xml` directory.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/blackberry/index.md b/docs/en/3.0.0/guide/platforms/blackberry/index.md
index 3c8f407..76eb31c 100644
--- a/docs/en/3.0.0/guide/platforms/blackberry/index.md
+++ b/docs/en/3.0.0/guide/platforms/blackberry/index.md
@@ -31,7 +31,7 @@ information:
* BlackBerry Command-line Tools
The command-line tools above refer to versions prior to Cordova 3.0.
-See The Cordova Command-line Interface for information about the
+See The Command-line Interface for information about the
current interface.
## Requirements and Support
@@ -68,30 +68,49 @@ development. BlackBerry PlayBook and BlackBerry Smartphone WebWorks
SDKs can be downloaded from the following locations.
- [BlackBerry PlayBook SDK] (https://developer.blackberry.com/html5/download/#playbook) and [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.
+- [BlackBerry Smartphones SDK] (https://developer.blackberry.com/html5/download/#smartphones)
-To register for Signing Keys visit, and complete the [BlackBerry Keys Order Form](https://www.blackberry.com/SignedKeys).
+## Register for Signing Keys
-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).
+If you wish to publish your application on BlackBerry App World, or on
+an actual device, you’ll need to register for a set of free Code
+Signing Keys. To do so, complete the [BlackBerry Keys Order
+Form](https://www.blackberry.com/SignedKeys).
+Once you receive your Signing Keys, they require setup. See the [BlackBerry HTML5/WebWorks website](https://developer.blackberry.com/html5/documentation/signing_setup_bb10_apps_2008396_11.html) for information.
-## 4. Install Cordova
+## Install Cordova
Download and extract the latest copy of [Cordova](http://cordova.apache.org/#download).
-## 5. Set up New Project
+## Set up a New Project
- Open up a command-line terminal and navigate to where you extracted Cordova.
-- There is a directory for each platform that Cordova supports. CD into the `blackberry` directory.
-- The blackberry directory contains several directories. The `example` folder contains a complete Cordova project. Copy the `example` folder to another location on your computer.
-- Change to the newly created directory.
-- Open up the project.properties file with your favorite editor and edit the entries for the WebWorks SDKs you are using. For example...
-BlackBerry 10 (QNX)
-- `qnx.bbwp.dir=C:\\Program Files (x86)\\Research In Motion\\BlackBerry 10 WebWorks SDK 1.0.2.9`
+- There is a directory for each platform that Cordova supports.
+ Navigate to the `blackberry` directory.
+
+- The `blackberry` directory contains several subdirectories. The
+ `example` directory contains a complete Cordova project. Copy the
+ `example` directory to another location on your computer, and
+ navigate there.
+
+- Edit the `project.properties` file to specify the WebWorks SDK you
+ are using. For example, here are the respective settings for
+ BlackBerry PlayBook, BlackBerry Smartphone (OS5-7), or BlackBerry 10
+ (QNX):
+
+ playbook.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks SDK for TabletOS 2.1.0.6\\bbwp
+ blackberry.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks Packager
+ qnx.bbwp.dir=C:\\Program Files (x86)\\Research In Motion\\BlackBerry 10 WebWorks SDK 1.0.2.9
+
+These correspond to parameters you specify when building your
+project. The first time you run these commands, they generate a
+"HelloWorld" application:
+
+ cordova/build playbook
+ cordova/build blackberry
+ cordova/build qnx
Along with the SDK, you also need to register for a code signing key
and debug token. The signing key allows you to distribute apps through
@@ -99,40 +118,16 @@ BlackBerry World. The debug token allows you to test unsigned apps on
a BlackBerry emulator or device. You do not need to create and
install the debug token yourself; if you supply the keystore password,
the build script creates and installs the debug token for you. To set
-up the signing key, go to the Blackberry website to obtain it, making
+up the signing key, go to the BlackBerry website to obtain it, making
sure to retain the password you specify. Then run the
-`blackberry-signer` utility that is included with the SDK. Consult the
-following for more information:
+`blackberry-signer` utility that is included with the SDK.
+BlackBerry provides more information here:
* [Register for your code signing key](https://www.blackberry.com/SignedKeys/codesigning.html)
* [Set up your computer for code signing](http://developer.blackberry.com/html5/documentation/set_up_for_signing.html)
-Build the Cordova sample project by typing `./cordova/build <target>` in your command prompt while you are in your project's directory. Replace `<target>` with either `qnx` `playbook` or `blackberry`. For example...
-
-* [Comprehensive guide to setting up your SDK environment](http://developer.blackberry.com/native/documentation/bb10/com.qnx.doc.native_sdk.quickstart/topic/set_up_your_environment.html)
-
-## Set up a New Project
-
-* Open up a command-line terminal. From the directory where you
- extracted Cordova, navigate to the `blackberry` subdirectory.
-
-* Copy the `blackberry` directory's `example` subdirectory to another
- location on your computer and navigate there.
-
-* Edit the `project.properties` file to specify the WebWorks SDK you
- are using. For example, here are the respective settings for
- BlackBerry PlayBook or BlackBerry Smartphone (OS5-7):
-
- playbook.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks SDK for TabletOS 2.1.0.6\\bbwp
- blackberry.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks Packager
-
-These correspond to parameters you specify when building your project.
-The first time you run these commands, they generate a "HelloWorld"
-application:
-
- cordova/build playbook
- cordova/build blackberry
+* [comprehensive guide to setting up your SDK environment](http://developer.blackberry.com/native/documentation/bb10/com.qnx.doc.native_sdk.quickstart/topic/set_up_your_environment.html)
## Deploy to Emulator
@@ -142,7 +137,12 @@ VMWare Fusion (Mac OS X). The WebWorks SDK provides a default
emulator, but additional emulators are [available through
BlackBerry](http://us.blackberry.com/developers/resources/simulators.jsp).
-While in your project directory, in command prompt type `./cordova/run <target>`. Replace `<target>` with either `qnx`, `playbook`, or `blackberry`. Note, for BlackBerry 10 and PlayBook, the emulator virtual image must already be started. For example...
+From your project directory, type `./cordova/run <target>`, replacing
+`<target>` with either `qnx`, `playbook`, or `blackberry`. Note that
+for BlackBerry 10 and PlayBook, the emulator virtual image must
+already be started.
+
+See the following for more information:
* [BlackBerry PlayBook](https://developer.blackberry.com/html5/documentation/using_the_tablet_simulator_1866980_11.html)
@@ -164,14 +164,14 @@ Files\\BlackBerry\\Simulator`.
Once the emulator is installed and running, run either of the
following to install an application to the home screen:
- cordova/run playbook
- cordova/run blackberry
+ cordova/run playbook
+ cordova/run blackberry
If you are prompted whether a device is connected to your computer,
answer no.
__NOTE:__ On BlackBerry OS 5, the application is installed in the
-`Downloads` folder.
+`Downloads` directory.
## Deploy to Device
@@ -180,11 +180,12 @@ registered for code signing keys as described above. Also, to deploy
apps on BlackBerry PlayBook, the __Settings → Security →
Development Mode__ option must be enabled.
-On Blackberry PlayBook, edit the `project.properties` file and modify
+On BlackBerry PlayBook, edit the `project.properties` file and modify
the following to reflect the device's IP and password as descibed
above, along with the signing key password you set up:
-While in your project directory, in command prompt type `./cordova/run <target>`. Replace `<target>` with either `qnx`, `playbook`, or `blackberry`. For example...
+From your project directory, type `./cordova/run <target>`, replacing
+`<target>` with either `qnx`, `playbook`, or `blackberry`.
On BlackBerry Smartphone (OS5-7), specify the
`blackberry.sigtool.password` property as the signing key password.
@@ -192,14 +193,14 @@ On BlackBerry Smartphone (OS5-7), specify the
Then from the project's directory, run either of the commands you
would to view the app in an emulator:
- cordova/run playbook
- cordova/run blackberry
+ cordova/run playbook
+ cordova/run blackberry
If you are prompted whether a device is connected to your computer,
answer yes.
__NOTE:__ On BlackBerry OS 5, the application is installed in the
-`Downloads` folder.
+`Downloads` directory.
## Additional Information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/blackberry/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/blackberry/plugin.md b/docs/en/3.0.0/guide/platforms/blackberry/plugin.md
index 56ba5ac..560d97d 100644
--- a/docs/en/3.0.0/guide/platforms/blackberry/plugin.md
+++ b/docs/en/3.0.0/guide/platforms/blackberry/plugin.md
@@ -43,27 +43,25 @@ to the `window.echo` function:
## Modifying plugins.xml
-Your project's `www/plugins.xml` folder contains all of the necessary
-references to your Cordova project's plugins. Add an
+Your project's `www/plugins.xml` directory contains all of the
+necessary references to your Cordova project's plugins. Add an
additional reference so that when `cordova.exec` is called, Cordova
knows how to map the `Echo` argument of `cordova.exec` to the `Echo`
class that we want to write natively:
- <plugins>
- ...
- <plugin name="Echo" value="org.apache.cordova.echo.Echo"/>
- ...
- </plugins>
+ <feature name="Echo">
+ <param name="blackberry-package" value="org.apache.cordova.echo.Echo" />
+ </feature>
## Adding Echo.java
If you notice the structure of the value attribute, you'll see a
-defined path that leads to the Echo plugin. In the root folder of the
-Cordova BlackBerry WebWorks repo, look for a folder called framework.
-This folder contains all of the source code that runs natively on the
+defined path that leads to the Echo plugin. In the root directory of the
+Cordova BlackBerry WebWorks repo, look for a directory called `framework`.
+This directory contains all of the source code that runs natively on the
BlackBerry. Navigate to `framework/ext/src/org/apache/cordova`. At
-this point, you'll see all of the plugin folders, inside of which is
-the source code. So add the folder echo to
+this point, you'll see all of the plugin directorys, inside of which is
+the source code. So add the directory echo to
`framework/ext/src/org/apache/cordova/echo` and create a file called
`Echo.java` at `framework/ext/src/org/apache/cordova/echo/Echo.java`.
@@ -131,7 +129,7 @@ status exceptions like `PluginResult.Status.ERROR`,
`PluginResult.Status.INVALID_ACTION`. When passed back, these types of
results fire the fail callback in JavaScript.
-## Updating the .jar in your project's www folder
+## Updating the .jar in your project's www directory
The added `Echo.java` needs to be updated in your project. To build
the `.jar` file, Navigate to the BlackBerry WebWorks repo's root
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/blackberry/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/blackberry/tools.md b/docs/en/3.0.0/guide/platforms/blackberry/tools.md
index ee9f3b3..df4a1f7 100644
--- a/docs/en/3.0.0/guide/platforms/blackberry/tools.md
+++ b/docs/en/3.0.0/guide/platforms/blackberry/tools.md
@@ -57,7 +57,7 @@ emulator executables.
## Launch emulator
For BlackBerry projects, please make sure you customize the
-`project.properties` file in the root of your Cordova project folder.
+`project.properties` file in the root of your Cordova project directory.
You need to do so to supply your BlackBerry signing key password, and
specify locations for the BlackBerry WebWorks SDK and BlackBerry
emulator executables.
[5/6] Update 3.0.0 from edge directory.
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/fileentry/fileentry.md b/docs/en/3.0.0/cordova/file/fileentry/fileentry.md
index f362833..357ec46 100644
--- a/docs/en/3.0.0/cordova/file/fileentry/fileentry.md
+++ b/docs/en/3.0.0/cordova/file/fileentry/fileentry.md
@@ -28,8 +28,11 @@ Properties
----------
- __isFile__: Always true. _(boolean)_
+
- __isDirectory__: Always false. _(boolean)_
+
- __name__: The name of the `FileEntry`, excluding the path leading to it. _(DOMString)_
+
- __fullPath__: The full absolute path from the root to the `FileEntry`. _(DOMString)_
__NOTE:__ The following attribute is defined by the W3C specification,
@@ -41,13 +44,21 @@ Methods
-------
- __getMetadata__: Look up metadata about a file.
+
- __setMetadata__: Set metadata on a file.
+
- __moveTo__: Move a file to a different location on the file system.
+
- __copyTo__: Copy a file to a different location on the file system.
+
- __toURL__: Return a URL that can be used to locate a file.
+
- __remove__: Delete a file.
+
- __getParent__: Look up the parent directory.
+
- __createWriter__: Creates a `FileWriter` object that can be used to write to a file.
+
- __file__: Creates a `File` object containing file properties.
Supported Platforms
@@ -67,6 +78,7 @@ Look up metadata about a file.
__Parameters:__
- __successCallback__: A callback that is passed a `Metadata` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when retrieving the `Metadata`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -88,12 +100,15 @@ setMetadata
Set metadata on a file.
__Currently works only on iOS.__
+
- this will set the extended attributes of a file.
__Parameters:__
- __successCallback__: A callback that executes when the metadata is set. _(Function)_
+
- __errorCallback__: A callback that executes when the metadata is not successfully set. _(Function)_
+
- __metadataObject__: An object that contains the metadata's keys and values. _(Object)_
__Quick Example__
@@ -117,31 +132,31 @@ __Quick Example__
function setFileMetadata(localFileSystem, filePath, metadataKey, metadataValue)
{
- var onSetMetadataWin = function() {
- console.log("success setting metadata")
- }
+ var onSetMetadataWin = function() {
+ console.log("success setting metadata")
+ }
var onSetMetadataFail = function() {
- console.log("error setting metadata")
+ console.log("error setting metadata")
}
- var onGetFileWin = function(parent) {
- var data = {};
- data[metadataKey] = metadataValue;
- parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
- }
- var onGetFileFail = function() {
- console.log("error getting file")
- }
+ var onGetFileWin = function(parent) {
+ var data = {};
+ data[metadataKey] = metadataValue;
+ parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
+ }
+ var onGetFileFail = function() {
+ console.log("error getting file")
+ }
- var onFSWin = function(fileSystem) {
- fileSystem.root.getFile(filePath, {create: true, exclusive: false}, onGetFileWin, onGetFileFail);
- }
+ var onFSWin = function(fileSystem) {
+ fileSystem.root.getFile(filePath, {create: true, exclusive: false}, onGetFileWin, onGetFileFail);
+ }
- var onFSFail = function(evt) {
- console.log(evt.target.error.code);
- }
+ var onFSFail = function(evt) {
+ console.log(evt.target.error.code);
+ }
- window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
+ window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
}
setFileMetadata(LocalFileSystem.PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1);
@@ -153,6 +168,7 @@ Move a file to a different location on the file system. An error
results if the app attempts to:
- move a file into its parent if a name different from its current one isn't provided;
+
- move a file to a path occupied by a directory;
In addition, moving a file on top of an existing file attempts to
@@ -161,8 +177,11 @@ delete and replace that file.
__Parameters:__
- __parent__: The parent directory to which to move the file. _(DirectoryEntry)_
+
- __newName__: The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
-- __successCallback__: A callback that is passed the new files `FileEntry` object. _(Function)_
+
+- __successCallback__: A callback that is passed the new file's `FileEntry` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to move the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -195,8 +214,11 @@ the app attempts to:
__Parameters:__
- __parent__: The parent directory to which to copy the file. _(DirectoryEntry)_
+
- __newName__: The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
+
- __successCallback__: A callback that is passed the new file's `FileEntry` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to copy the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -237,6 +259,7 @@ Deletes a file.
__Parameters:__
- __successCallback__: A callback that executes after the file has been deleted. Invoked with no parameters. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to delete the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -260,6 +283,7 @@ Look up the parent `DirectoryEntry` containing the file.
__Parameters:__
- __successCallback__: A callback that is passed the file's parent `DirectoryEntry`. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to retrieve the parent `DirectoryEntry`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -283,6 +307,7 @@ Create a `FileWriter` object associated with the file represented by the `FileEn
__Parameters:__
- __successCallback__: A callback that is passed a `FileWriter` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs while attempting to create the FileWriter. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -307,6 +332,7 @@ that this `FileEntry` represents.
__Parameters:__
- __successCallback__: A callback that is passed a `File` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when creating the `File` object, such as when the file no longer exists. Invoked with a `FileError` object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/fileobj/fileobj.md b/docs/en/3.0.0/cordova/file/fileobj/fileobj.md
index 0825889..e1216c4 100644
--- a/docs/en/3.0.0/cordova/file/fileobj/fileobj.md
+++ b/docs/en/3.0.0/cordova/file/fileobj/fileobj.md
@@ -26,9 +26,13 @@ Properties
----------
- __name__: The name of the file. _(DOMString)_
+
- __fullPath__: The full path of the file including the file name. _(DOMString)_
+
- __type__: The mime type of the file. _(DOMString)_
+
- __lastModifiedDate__: The last time the file was modified. _(Date)_
+
- __size__: The size of the file in bytes. _(long)_
Methods
@@ -63,6 +67,7 @@ relative to the current slice. (See the full example below.)
__Parameters:__
- __start__: The index of the first byte to read, inclusive.
+
- __end__: The index of the byte after the last one to read.
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/filereader/filereader.md b/docs/en/3.0.0/cordova/file/filereader/filereader.md
index 0664242..412e935 100644
--- a/docs/en/3.0.0/cordova/file/filereader/filereader.md
+++ b/docs/en/3.0.0/cordova/file/filereader/filereader.md
@@ -26,12 +26,19 @@ Properties
----------
- __readyState__: One of the reader's three possible states, either `EMPTY`, `LOADING` or `DONE`.
+
- __result__: The contents of the file that have been read. _(DOMString)_
+
- __error__: An object containing errors. _(FileError)_
+
- __onloadstart__: Called when the read starts. _(Function)_
+
- __onload__: Called when the read has successfully completed. _(Function)_
+
- __onabort__: Called when the read has been aborted. For instance, by invoking the `abort()` method. _(Function)_
+
- __onerror__: Called when the read has failed. _(Function)_
+
- __onloadend__: Called when the request has completed (either in success or failure). _(Function)_
__NOTE:__ The following porperty is not supported:
@@ -42,9 +49,13 @@ Methods
-------
- __abort__: Aborts reading file.
+
- __readAsDataURL__: Read file and return data as a base64-encoded data URL.
+
- __readAsText__: Reads text file.
+
- __readAsBinaryString__: Reads file as binary and returns a binary string.
+
- __readAsArrayBuffer__: Reads file as an `ArrayBuffer`.
Details
@@ -95,6 +106,7 @@ Read As Text
__Parameters:__
- __file__: the file object to read.
+
- __encoding__: the encoding to use to encode the file's content. Default is UTF8.
Quick Example
@@ -147,9 +159,7 @@ Full Example
// Wait for device API libraries to load
//
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
+ document.addEventListener("deviceready", onDeviceReady, false);
// device APIs are available
//
@@ -202,6 +212,7 @@ Full Example
iOS Quirks
----------
+
- The __encoding__ parameter is not supported, and UTF8 encoding is always in effect.
Read As Binary String
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/filesystem/filesystem.md b/docs/en/3.0.0/cordova/file/filesystem/filesystem.md
index 04a5f53..2367d2d 100644
--- a/docs/en/3.0.0/cordova/file/filesystem/filesystem.md
+++ b/docs/en/3.0.0/cordova/file/filesystem/filesystem.md
@@ -26,6 +26,7 @@ Properties
----------
- __name__: The name of the file system. _(DOMString)_
+
- __root__: The root directory of the file system. _(DirectoryEntry)_
Details
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md b/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md
index 37a2dd5..7db3932 100644
--- a/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md
@@ -32,7 +32,9 @@ Methods
-------
- __upload__: sends a file to a server.
+
- __download__: downloads a file from server.
+
- __abort__: Aborts an in-progress transfer.
Details
@@ -63,10 +65,15 @@ upload
__Parameters:__
- __filePath__: Full path of the file on the device.
+
- __server__: URL of the server to receive the file, as encoded by `encodeURI()`.
+
- __successCallback__: A callback that is passed a `Metadata` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs retrieving the `Metadata`. Invoked with a `FileTransferError` object. _(Function)_
+
- __options__: Optional parameters such as file name and mimetype.
+
- __trustAllHosts__: Optional parameter, defaults to `false`. If set to true, it accepts all security certificates. This is useful since Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
__Quick Example__
@@ -205,10 +212,15 @@ download
__Parameters:__
- __source__: URL of the server to download the file, as encoded by `encodeURI()`.
+
- __target__: Full path of the file on the device.
+
- __successCallback__: A callback that is passed a `FileEntry` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when retrieving the `Metadata`. Invoked with a `FileTransferError` object. _(Function)_
+
- __trustAllHosts__: Optional parameter, defaults to `false`. If set to `true` then it will accept all security certificates. This is useful as Android rejects self signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
+
- __options__: Optional parameters, currently only supports headers (such as Authorization (Basic Authentication), etc).
__Quick Example__
@@ -251,32 +263,25 @@ __Quick Example__
// !! Assumes variable fileURI contains a valid URI to a text file on the device
- var win = function(r) {
- console.log("Code = " + r.responseCode);
- console.log("Response = " + r.response);
- console.log("Sent = " + r.bytesSent);
- }
+ var win = function(r) {
+ console.log("Should not be called.");
+ }
var fail = function(error) {
+ // error.code == FileTransferError.ABORT_ERR
alert("An error has occurred: Code = " + error.code);
console.log("upload error source " + error.source);
console.log("upload error target " + error.target);
}
- var options = new FileUploadOptions();
- options.fileKey="file";
- options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
- options.mimeType="text/plain";
-
- var params = {};
- params.value1 = "test";
- params.value2 = "param";
-
- options.params = params;
+ var options = new FileUploadOptions();
+ options.fileKey="file";
+ options.fileName="myphoto.jpg";
+ options.mimeType="image/jpeg";
- var ft = new FileTransfer();
+ var ft = new FileTransfer();
ft.upload(fileURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
- ft.abort(win, fail);
+ ft.abort();
onprogress
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/filetransfererror/filetransfererror.md b/docs/en/3.0.0/cordova/file/filetransfererror/filetransfererror.md
index abb135f..a3cba30 100644
--- a/docs/en/3.0.0/cordova/file/filetransfererror/filetransfererror.md
+++ b/docs/en/3.0.0/cordova/file/filetransfererror/filetransfererror.md
@@ -26,8 +26,11 @@ Properties
----------
- __code__: One of the predefined error codes listed below. (Number)
+
- __source__: URI to the source. (String)
+
- __target__: URI to the target. (String)
+
- __http_status__: HTTP status code. This attribute is only available when a response code is received from the HTTP connection. (Number)
Constants
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md b/docs/en/3.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md
index e0e6fe2..0aea57e 100644
--- a/docs/en/3.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/docs/en/3.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -28,10 +28,15 @@ Properties
----------
- __fileKey__: The name of the form element. Defaults to `file`. (DOMString)
+
- __fileName__: The file name to use when saving the file on the server. Defaults to `image.jpg`. (DOMString)
+
- __mimeType__: The mime type of the data to upload. Defaults to `image/jpeg`. (DOMString)
+
- __params__: A set of optional key/value pairs to pass in the HTTP request. (Object)
+
- __chunkedMode__: Whether to upload the data in chunked streaming mode. Defaults to `true`. (Boolean)
+
- __headers__: A map of header name/header values. Use an array to specify more than one value. (Object)
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/fileuploadresult/fileuploadresult.md b/docs/en/3.0.0/cordova/file/fileuploadresult/fileuploadresult.md
index 4d9305a..f24d9c5 100644
--- a/docs/en/3.0.0/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/docs/en/3.0.0/cordova/file/fileuploadresult/fileuploadresult.md
@@ -27,7 +27,9 @@ Properties
----------
- __bytesSent__: The number of bytes sent to the server as part of the upload. (long)
+
- __responseCode__: The HTTP response code returned by the server. (long)
+
- __response__: The HTTP response returned by the server. (DOMString)
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/filewriter/filewriter.md b/docs/en/3.0.0/cordova/file/filewriter/filewriter.md
index 8ac5b18..4af7f7d 100644
--- a/docs/en/3.0.0/cordova/file/filewriter/filewriter.md
+++ b/docs/en/3.0.0/cordova/file/filewriter/filewriter.md
@@ -26,14 +26,23 @@ Properties
----------
- __readyState__: One of the three possible states, either `INIT`, `WRITING`, or `DONE`.
+
- __fileName__: The name of the file to be written. _(DOMString)_
+
- __length__: The length of the file to be written. _(long)_
+
- __position__: The current position of the file pointer. _(long)_
+
- __error__: An object containing errors. _(FileError)_
+
- __onwritestart__: Called when the write starts. _(Function)_
+
- __onwrite__: Called when the request has completed successfully. _(Function)_
+
- __onabort__: Called when the write has been aborted. For instance, by invoking the abort() method. _(Function)_
+
- __onerror__: Called when the write has failed. _(Function)_
+
- __onwriteend__: Called when the request has completed (either in success or failure). _(Function)_
The following property is _not_ supported:
@@ -43,8 +52,11 @@ Methods
-------
- __abort__: Aborts writing the file.
+
- __seek__: Moves the file pointer to the specified byte.
+
- __truncate__: Shortens the file to the specified length.
+
- __write__: Writes data to the file.
Details
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/flags/flags.md b/docs/en/3.0.0/cordova/file/flags/flags.md
index 504f323..9303dd6 100644
--- a/docs/en/3.0.0/cordova/file/flags/flags.md
+++ b/docs/en/3.0.0/cordova/file/flags/flags.md
@@ -28,6 +28,7 @@ Properties
----------
- __create__: Indicates that the file or directory should be created if it does not already exist. _(boolean)_
+
- __exclusive__: Has has no effect by itself, but when used with `create` causes the file or directory creation to fail if the target path already exists. _(boolean)_
Supported Platforms
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/localfilesystem/localfilesystem.md b/docs/en/3.0.0/cordova/file/localfilesystem/localfilesystem.md
index ea271e2..67bcee2 100644
--- a/docs/en/3.0.0/cordova/file/localfilesystem/localfilesystem.md
+++ b/docs/en/3.0.0/cordova/file/localfilesystem/localfilesystem.md
@@ -26,12 +26,14 @@ Methods
----------
- __requestFileSystem__: Requests a filesystem. _(Function)_
+
- __resolveLocalFileSystemURI__: Retrieve a `DirectoryEntry` or `FileEntry` using local URI. _(Function)_
Constants
---------
- `LocalFileSystem.PERSISTENT`: Used for storage that should not be removed by the user agent without application or user permission.
+
- `LocalFileSystem.TEMPORARY`: Used for storage with no guarantee of persistence.
Details
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/Coordinates/coordinates.md b/docs/en/3.0.0/cordova/geolocation/Coordinates/coordinates.md
index 2ebbcd5..4b39428 100644
--- a/docs/en/3.0.0/cordova/geolocation/Coordinates/coordinates.md
+++ b/docs/en/3.0.0/cordova/geolocation/Coordinates/coordinates.md
@@ -26,11 +26,17 @@ Properties
----------
* __latitude__: Latitude in decimal degrees. _(Number)_
+
* __longitude__: Longitude in decimal degrees. _(Number)_
+
* __altitude__: Height of the position in meters above the ellipsoid. _(Number)_
+
* __accuracy__: Accuracy level of the latitude and longitude coordinates in meters. _(Number)_
+
* __altitudeAccuracy__: Accuracy level of the altitude coordinate in meters. _(Number)_
+
* __heading__: Direction of travel, specified in degrees counting clockwise relative to the true north. _(Number)_
+
* __speed__: Current ground speed of the device, specified in meters per second. _(Number)_
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/Position/position.md b/docs/en/3.0.0/cordova/geolocation/Position/position.md
index 13eb8f4..61178e2 100644
--- a/docs/en/3.0.0/cordova/geolocation/Position/position.md
+++ b/docs/en/3.0.0/cordova/geolocation/Position/position.md
@@ -26,6 +26,7 @@ Properties
----------
- __coords__: A set of geographic coordinates. _(Coordinates)_
+
- __timestamp__: Creation timestamp for `coords`. _(Date)_
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/PositionError/positionError.md b/docs/en/3.0.0/cordova/geolocation/PositionError/positionError.md
index 07200d5..9ba183e 100755
--- a/docs/en/3.0.0/cordova/geolocation/PositionError/positionError.md
+++ b/docs/en/3.0.0/cordova/geolocation/PositionError/positionError.md
@@ -26,6 +26,7 @@ Properties
----------
- __code__: One of the predefined error codes listed below.
+
- __message__: Error message describing the details of the error encountered.
Constants
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/3.0.0/cordova/geolocation/geolocation.getCurrentPosition.md
index 9bd09f1..e5a5ed8 100644
--- a/docs/en/3.0.0/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/3.0.0/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -30,7 +30,9 @@ Parameters
----------
- __geolocationSuccess__: The callback that is passed the current position.
+
- __geolocationError__: _(Optional)_ The callback that executes if an error occurs.
+
- __geolocationOptions__: _(Optional)_ The geolocation options.
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/geolocation.md b/docs/en/3.0.0/cordova/geolocation/geolocation.md
index f2444c5..4b657c7 100644
--- a/docs/en/3.0.0/cordova/geolocation/geolocation.md
+++ b/docs/en/3.0.0/cordova/geolocation/geolocation.md
@@ -56,49 +56,55 @@ Objects (Read-Only)
- PositionError
- Coordinates
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
+ $ cordova plugin rm org.apache.cordova.core.geolocation
- <plugin name="Geolocation" value="org.apache.cordova.GeoBroker" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-#### app/AndroidManifest.xml
+* Android
- <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
- <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
- <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
+ (in app/res/xml/config.xml)
+ <feature name="Geolocation">
+ <param name="android-package" value="org.apache.cordova.GeoBroker" />
+ </feature>
-### BlackBerry WebWorks
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+ <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+ <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
-#### www/plugins.xml
+* BlackBerry WebWorks
- <plugin name="Geolocation" value="org.apache.cordova.geolocation.Geolocation" />
+ (in www/plugins.xml)
+ <feature name="Geolocation">
+ <param name="blackberry-package" value="org.apache.cordova.geolocation.Geolocation" />
+ </feature>
-#### www/config.xml
+ (in www/config.xml)
+ <rim:permissions>
+ <rim:permit>read_geolocation</rim:permit>
+ </rim:permissions>
- <rim:permissions>
- <rim:permit>read_geolocation</rim:permit>
- </rim:permissions>
+* iOS (in `config.xml`)
-### iOS
+ <feature name="Geolocation">
+ <param name="ios-package" value="CDVLocation" />
+ </feature>
-#### config.xml
+* Windows Phone (in `Properties/WPAppManifest.xml`)
- <plugin name="Geolocation" value="CDVLocation" />
+ <Capabilities>
+ <Capability Name="ID_CAP_LOCATION" />
+ </Capabilities>
-### Windows Phone
+ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-#### Properties/WPAppManifest.xml
-
- <Capabilities>
- <Capability Name="ID_CAP_LOCATION" />
- </Capabilities>
-
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-
-### Tizen
-
- No permissions are required.
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/geolocation.watchPosition.md b/docs/en/3.0.0/cordova/geolocation/geolocation.watchPosition.md
index 280976f..c1e4119 100644
--- a/docs/en/3.0.0/cordova/geolocation/geolocation.watchPosition.md
+++ b/docs/en/3.0.0/cordova/geolocation/geolocation.watchPosition.md
@@ -30,7 +30,9 @@ Parameters
----------
- __geolocationSuccess__: The callback that is passed the current position.
+
- __geolocationError__: (Optional) The callback that executes if an error occurs.
+
- __geolocationOptions__: (Optional) The geolocation options.
Returns
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/parameters/geolocation.options.md b/docs/en/3.0.0/cordova/geolocation/parameters/geolocation.options.md
index 74353f4..107009d 100644
--- a/docs/en/3.0.0/cordova/geolocation/parameters/geolocation.options.md
+++ b/docs/en/3.0.0/cordova/geolocation/parameters/geolocation.options.md
@@ -29,7 +29,9 @@ Options
-------
- __enableHighAccuracy__: Provides a hint that the application needs the best possible results. By default, the device attempts to retrieve a `Position` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
+
- __timeout__: The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback executes. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback is passed a `PositionError.TIMEOUT` error code. (Note that when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds!) _(Number)_
+
- __maximumAge__: Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
Android Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/3.0.0/cordova/globalization/globalization.getCurrencyPattern.md
index 0df7fcd..cad69c5 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/3.0.0/cordova/globalization/globalization.getCurrencyPattern.md
@@ -32,10 +32,15 @@ Returns the pattern to the `successCallback` with a `properties` object
as a parameter. That object should contain the following properties:
- __pattern__: The currency pattern to format and parse currency values. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_
+
- __code__: The ISO 4217 currency code for the pattern. _(String)_
+
- __fraction__: The number of fractional digits to use when parsing and formatting currency. _(Number)_
+
- __rounding__: The rounding increment to use when parsing and formatting. _(Number)_
+
- __decimal__: The decimal symbol to use for parsing and formatting. _(String)_
+
- __grouping__: The grouping symbol to use for parsing and formatting. _(String)_
The inbound `currencyCode` parameter should be a `String` of one of
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.getDatePattern.md b/docs/en/3.0.0/cordova/globalization/globalization.getDatePattern.md
index 044b014..b7c6dde 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/3.0.0/cordova/globalization/globalization.getDatePattern.md
@@ -32,8 +32,11 @@ Returns the pattern to the `successCallback`. The object passed in as
a parameter contains the following properties:
- __pattern__: The date and time pattern to format and parse dates. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_
+
- __timezone__: The abbreviated name of the time zone on the client. _(String)_
+
- __utc\_offset__: The current difference in seconds between the client's time zone and coordinated universal time. _(Number)_
+
- __dst\_offset__: The current daylight saving time offset in seconds between the client's non-daylight saving's time zone and the client's daylight saving's time zone. _(Number)_
If there is an error obtaining the pattern, the `errorCallback`
@@ -99,7 +102,10 @@ Windows Phone 8 Quirks
--------------
- The `formatLength` supports only `short` and `full` values.
+
- The `pattern` for `date and time` pattern returns only full datetime format.
+
- The `timezone` returns the full time zone name.
+
- The `dst_offset` property is not supported, and always returns zero.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.getLocaleName.md b/docs/en/3.0.0/cordova/globalization/globalization.getLocaleName.md
index d9a8ba4..276e38d 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/3.0.0/cordova/globalization/globalization.getLocaleName.md
@@ -24,7 +24,6 @@ Get the string identifier for the client's current locale setting.
navigator.globalization.getLocaleName(successCallback, errorCallback);
-
Description
-----------
@@ -80,4 +79,5 @@ Full Example
Windows Phone 8 Quirks
---------------------
+
- Returns the two-letter code defined in ISO 3166 for the current country/region.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.getNumberPattern.md b/docs/en/3.0.0/cordova/globalization/globalization.getNumberPattern.md
index dc22d3f..54777ed 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/3.0.0/cordova/globalization/globalization.getNumberPattern.md
@@ -31,12 +31,19 @@ Returns the pattern to the `successCallback` with a `properties` object
as a parameter. That object contains the following properties:
- __pattern__: The number pattern to format and parse numbers. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_
+
- __symbol__: The symbol to use when formatting and parsing, such as a percent or currency symbol. _(String)_
+
- __fraction__: The number of fractional digits to use when parsing and formatting numbers. _(Number)_
+
- __rounding__: The rounding increment to use when parsing and formatting. _(Number)_
+
- __positive__: The symbol to use for positive numbers when parsing and formatting. _(String)_
+
- __negative__: The symbol to use for negative numbers when parsing and formatting. _(String)_
+
- __decimal__: The decimal symbol to use for parsing and formatting. _(String)_
+
- __grouping__: The grouping symbol to use for parsing and formatting. _(String)_
If there is an error obtaining the pattern, then the `errorCallback`
@@ -121,5 +128,7 @@ Full Example
Windows Phone 8 Quirks
----------------
+
- The `pattern` property is not supported, and retuens an empty string.
+
- The `fraction` property is not supported, and returns zero.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/3.0.0/cordova/globalization/globalization.getPreferredLanguage.md
index 0c29506..60fb856 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/3.0.0/cordova/globalization/globalization.getPreferredLanguage.md
@@ -24,7 +24,6 @@ Get the string identifier for the client's current language.
navigator.globalization.getPreferredLanguage(successCallback, errorCallback);
-
Description
-----------
@@ -80,4 +79,5 @@ Full Example
Windows Phone 8 Quirks
-------
+
- Returns the ISO 639-1 two-letter code for the current language.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.md b/docs/en/3.0.0/cordova/globalization/globalization.md
index b473ec9..7d7309c 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.md
+++ b/docs/en/3.0.0/cordova/globalization/globalization.md
@@ -53,11 +53,23 @@ therefore has global scope.
// The global globalization object
var globalization = navigator.globalization;
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git
+ $ cordova plugin rm org.apache.cordova.core.globalization
- <plugin name="Globalization" value="org.apache.cordova.Globalization" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
+
+* Android (in `app/res/xml/config.xml`)
+
+ <feature name="Globalization">
+ <param name="android-package" value="org.apache.cordova.Globalization" />
+ </feature>
+
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/globalization/globalization.stringToDate.md b/docs/en/3.0.0/cordova/globalization/globalization.stringToDate.md
index 0dc4d63..cff0e4e 100644
--- a/docs/en/3.0.0/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/3.0.0/cordova/globalization/globalization.stringToDate.md
@@ -33,12 +33,18 @@ Returns the date to the success callback with a `properties` object as
a parameter. That object should have the following properties:
- __year__: The four digit year. _(Number)_
-- __month__: The month from (0 - 11). _(Number)_
-- __day__: The day from (1 - 31). _(Number)_
-- __hour__: The hour from (0 - 23). _(Number)_
-- __minute__: The minute from (0 - 59). _(Number)_
-- __second__: The second from (0 - 59). _(Number)_
-- __millisecond__: The milliseconds (from 0 - 999), not available on all platforms. _(Number)_
+
+- __month__: The month from (0-11). _(Number)_
+
+- __day__: The day from (1-31). _(Number)_
+
+- __hour__: The hour from (0-23). _(Number)_
+
+- __minute__: The minute from (0-59). _(Number)_
+
+- __second__: The second from (0-59). _(Number)_
+
+- __millisecond__: The milliseconds (from 0-999), not available on all platforms. _(Number)_
The inbound `dateString` parameter should be of type `String`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/inappbrowser/inappbrowser.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/inappbrowser/inappbrowser.md b/docs/en/3.0.0/cordova/inappbrowser/inappbrowser.md
index 3c6b5f8..86ee72f 100644
--- a/docs/en/3.0.0/cordova/inappbrowser/inappbrowser.md
+++ b/docs/en/3.0.0/cordova/inappbrowser/inappbrowser.md
@@ -39,26 +39,36 @@ Methods
- executeScript
- insertCSS
-Permissions
------------
+## Accessing the Feature
+
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-### Android
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git
+ $ cordova plugin rm org.apache.cordova.core.inappbrowser
-#### app/res/xml/config.xml
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
- <plugin name="InAppBrowser" value="org.apache.cordova.InAppBrowser" />
+* Android (in `app/res/xml/config.xml`)
-### iOS
+ <feature name="InAppBrowser">
+ <param name="android-package" value="org.apache.cordova.InAppBrowser" />
+ </feature>
-#### config.xml
+* iOS (in `config.xml`)
- <plugin name="InAppBrowser" value="CDVInAppBrowser" />
+ <feature name="InAppBrowser">
+ <param name="ios-package" value="CDVInAppBrowser" />
+ </feature>
-### Windows Phone 7 + 8
+* Windows Phone 7 and 8 (in `config.xml`)
-#### config.xml
+ <feature name="InAppBrowser" />
- <plugin name="InAppBrowser" />
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
addEventListener
================
@@ -68,6 +78,7 @@ addEventListener
ref.addEventListener(eventname, callback);
- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
+
- __eventname__: the event to listen for _(String)_
- __loadstart__: event fires when the `InAppBrowser` starts to load a URL.
@@ -81,8 +92,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
-- Windows Phone 7 + 8
+- Windows Phone 7 and 8
Quick Example
-------------
@@ -129,6 +141,7 @@ removeEventListener
ref.removeEventListener(eventname, callback);
- __ref__: reference to the `InAppBrowser` window. _(InAppBrowser)_
+
- __eventname__: the event to stop listening for. _(String)_
- __loadstart__: event fires when the `InAppBrowser` starts to load a URL.
@@ -143,8 +156,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
-- Windows Phone 7 + 8
+- Windows Phone 7 and 8
Quick Example
-------------
@@ -221,9 +235,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
-- Windows Phone 7 + 8
-- BlackBerry 10
+- Windows Phone 7 and 8
Quick Example
-------------
@@ -275,6 +289,7 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
Quick Example
@@ -317,7 +332,6 @@ Full Example
</body>
</html>
-
executeScript
=============
@@ -326,9 +340,11 @@ executeScript
ref.executeScript(details, callback);
- __ref__: reference to the `InAppBrowser` window. _(InAppBrowser)_
+
- __injectDetails__: details of the script to run, specifying either a `file` or `code` key. _(Object)_
- __file__: URL of the script to inject.
- __code__: Text of the script to inject.
+
- __callback__: the function that executes after the JavaScript code is injected.
- If the injected script is of type `code`, the callback executes
with a single parameter, which is the return value of the
@@ -340,6 +356,7 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
Quick Example
@@ -405,15 +422,18 @@ insertCSS
ref.insertCSS(details, callback);
- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
+
- __injectDetails__: details of the script to run, specifying either a `file` or `code` key. _(Object)_
- __file__: URL of the stylesheet to inject.
- __code__: Text of the stylesheet to inject.
+
- __callback__: the function that executes after the CSS is injected.
Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
Quick Example
@@ -481,6 +501,9 @@ Properties
----------
- __type__: the eventname, either `loadstart`, `loadstop`, `loaderror`, or `exit`. _(String)_
+
- __url__: the URL that was loaded. _(String)_
+
- __code__: the error code, only in the case of `loaderror`. _(Number)_
+
- __message__: the error message, only in the case of `loaderror`. _(String)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/inappbrowser/window.open.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/inappbrowser/window.open.md b/docs/en/3.0.0/cordova/inappbrowser/window.open.md
index 71e75b9..c5e15b7 100644
--- a/docs/en/3.0.0/cordova/inappbrowser/window.open.md
+++ b/docs/en/3.0.0/cordova/inappbrowser/window.open.md
@@ -26,7 +26,9 @@ instance, or the system browser.
var ref = window.open(url, target, options);
- __ref__: Reference to the `InAppBrowser` window. _(InAppBrowser)_
+
- __url__: The URL to load _(String)_. Call `encodeURI()` on this if the URL contains Unicode characters.
+
- __target__: The target in which to load the URL, an optional parameter that defaults to `_self`. _(String)_
- `_self`: Opens in the Cordova WebView if the URL is in the white list, otherwise it opens in the `InAppBrowser`.
@@ -61,9 +63,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry
- iOS
-- BlackBerry 10
-- Windows Phone 7 + 8
+- Windows Phone 7 and 8
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/MediaError/mediaError.md b/docs/en/3.0.0/cordova/media/MediaError/mediaError.md
index 5652a27..fd5e3c5 100644
--- a/docs/en/3.0.0/cordova/media/MediaError/mediaError.md
+++ b/docs/en/3.0.0/cordova/media/MediaError/mediaError.md
@@ -27,6 +27,7 @@ Properties
----------
- __code__: One of the predefined error codes listed below.
+
- __message__: An error message describing the details of the error.
Constants
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/CaptureError.md b/docs/en/3.0.0/cordova/media/capture/CaptureError.md
index 0268f06..a532ab9 100644
--- a/docs/en/3.0.0/cordova/media/capture/CaptureError.md
+++ b/docs/en/3.0.0/cordova/media/capture/CaptureError.md
@@ -31,7 +31,11 @@ Constants
---------
- `CaptureError.CAPTURE_INTERNAL_ERR`: The camera or microphone failed to capture image or sound.
+
- `CaptureError.CAPTURE_APPLICATION_BUSY`: The camera or audio capture application is currently serving another capture request.
+
- `CaptureError.CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. the value of `limit` is less than one).
+
- `CaptureError.CAPTURE_NO_MEDIA_FILES`: The user exits the camera or audio capture application before capturing anything.
+
- `CaptureError.CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/ConfigurationData.md b/docs/en/3.0.0/cordova/media/capture/ConfigurationData.md
index 361f45a..619e8a6 100644
--- a/docs/en/3.0.0/cordova/media/capture/ConfigurationData.md
+++ b/docs/en/3.0.0/cordova/media/capture/ConfigurationData.md
@@ -41,7 +41,9 @@ Properties
----------
- __type__: The ASCII-encoded lowercase string representing the media type. (DOMString)
+
- __height__: The height of the image or video in pixels. The value is zero for sound clips. (Number)
+
- __width__: The width of the image or video in pixels. The value is zero for sound clips. (Number)
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/MediaFile.md b/docs/en/3.0.0/cordova/media/capture/MediaFile.md
index 3bca7aa..072e90f 100644
--- a/docs/en/3.0.0/cordova/media/capture/MediaFile.md
+++ b/docs/en/3.0.0/cordova/media/capture/MediaFile.md
@@ -26,9 +26,13 @@ Properties
----------
- __name__: The name of the file, without path information. (DOMString)
+
- __fullPath__: The full path of the file, including the name. (DOMString)
+
- __type__: The file's mime type (DOMString)
+
- __lastModifiedDate__: The date and time when the file was last modified. (Date)
+
- __size__: The size of the file, in bytes. (Number)
Methods
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/MediaFileData.md b/docs/en/3.0.0/cordova/media/capture/MediaFileData.md
index 545b549..35ef16a 100644
--- a/docs/en/3.0.0/cordova/media/capture/MediaFileData.md
+++ b/docs/en/3.0.0/cordova/media/capture/MediaFileData.md
@@ -26,9 +26,13 @@ Properties
----------
- __codecs__: The actual format of the audio and video content. (DOMString)
+
- __bitrate__: The average bitrate of the content. The value is zero for images. (Number)
+
- __height__: The height of the image or video in pixels. The value is zero for audio clips. (Number)
+
- __width__: The width of the image or video in pixels. The value is zero for audio clips. (Number)
+
- __duration__: The length of the video or sound clip in seconds. The value is zero for images. (Number)
BlackBerry WebWorks Quirks
@@ -39,9 +43,13 @@ No API provides format information for media files, so the
the following default values:
- __codecs__: Not supported, and returns `null`.
+
- __bitrate__: Not supported, and returns zero.
+
- __height__: Not supported, and returns zero.
+
- __width__: Not supported, and returns zero.
+
- __duration__: Not supported, and returns zero.
Android Quirks
@@ -49,9 +57,13 @@ Android Quirks
Supports the following `MediaFileData` properties:
- __codecs__: Not supported, and returns `null`.
+
- __bitrate__: Not supported, and returns zero.
+
- __height__: Supported: image and video files only.
+
- __width__: Supported: image and video files only.
+
- __duration__: Supported: audio and video files only.
iOS Quirks
@@ -59,7 +71,11 @@ iOS Quirks
Supports the following `MediaFileData` properties:
- __codecs__: Not supported, and returns null.
+
- __bitrate__: Supported on iOS4 devices for audio only. Returns zero for images and videos.
+
- __height__: Supported: image and video files only.
+
- __width__: Supported: image and video files only.
+
- __duration__: Supported: audio and video files only.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/capture.md b/docs/en/3.0.0/cordova/media/capture/capture.md
index ca184bb..d645063 100644
--- a/docs/en/3.0.0/cordova/media/capture/capture.md
+++ b/docs/en/3.0.0/cordova/media/capture/capture.md
@@ -58,14 +58,18 @@ Properties
----------
- __supportedAudioModes__: The audio recording formats supported by the device. (ConfigurationData[])
+
- __supportedImageModes__: The recording image sizes and formats supported by the device. (ConfigurationData[])
+
- __supportedVideoModes__: The recording video resolutions and formats supported by the device. (ConfigurationData[])
Methods
-------
- `capture.captureAudio`: Launch the device's audio recording application to record audio clips.
+
- `capture.captureImage`: Launch the device's camera application to take photos.
+
- `capture.captureVideo`: Launch the device's video recorder application to record videos.
Supported Platforms
@@ -77,45 +81,55 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Permissions
------------
-
-### Android
-
-#### app/res/xml/plugins.xml
+## Accessing the Feature
- <plugin name="Capture" value="org.apache.cordova.Capture"/>
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/AndroidManifest.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git
+ $ cordova plugin rm org.apache.cordova.core.media-capture
- <uses-permission android:name="android.permission.RECORD_AUDIO" />
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-### BlackBerry WebWorks
+* Android
-#### www/plugins.xml
+ (in app/res/xml/plugins.xml)
+ <feature name="Capture">
+ <param name="android-package" value="org.apache.cordova.Capture" />
+ </feature>
- <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture" />
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.RECORD_AUDIO" />
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-#### www/config.xml
+* BlackBerry WebWorks
- <feature id="blackberry.system" required="true" version="1.0.0.0" />
- <feature id="blackberry.io.file" required="true" version="1.0.0.0" />
+ (in www/plugins.xml)
+ <feature name="Capture">
+ <param name="blackberry-package" value="org.apache.cordova.capture.MediaCapture" />
+ </feature>
-### iOS
+ (in www/config.xml)
+ <feature id="blackberry.system" required="true" version="1.0.0.0" />
+ <feature id="blackberry.io.file" required="true" version="1.0.0.0" />
-#### config.xml
+* iOS (in `config.xml`)
- <plugin name="Capture" value="CDVCapture" />
+ <feature name="Capture">
+ <param name="ios-package" value="CDVCapture" />
+ </feature>
-### Windows Phone
+* Windows Phone (in `Properties/WPAppManifest.xml`)
-#### Properties/WPAppManifest.xml
+ <Capabilities>
+ <Capability Name="ID_CAP_MEDIALIB" />
+ <Capability Name="ID_CAP_MICROPHONE" />
+ <Capability Name="ID_HW_FRONTCAMERA" />
+ <Capability Name="ID_CAP_ISV_CAMERA" />
+ <Capability Name="ID_CAP_CAMERA" />
+ </Capabilities>
- <Capabilities>
- <Capability Name="ID_CAP_MEDIALIB" />
- <Capability Name="ID_CAP_MICROPHONE" />
- <Capability Name="ID_HW_FRONTCAMERA" />
- <Capability Name="ID_CAP_ISV_CAMERA" />
- <Capability Name="ID_CAP_CAMERA" />
- </Capabilities>
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/captureAudio.md b/docs/en/3.0.0/cordova/media/capture/captureAudio.md
index edf05e3..ba0fc36 100644
--- a/docs/en/3.0.0/cordova/media/capture/captureAudio.md
+++ b/docs/en/3.0.0/cordova/media/capture/captureAudio.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
capture.captureAudio
====================
-> Start the audio recorder application and return information about the captured audio clip file(s).
+> Start the audio recorder application and return information about captured audio clip files.
navigator.device.capture.captureAudio(
CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/captureAudioOptions.md b/docs/en/3.0.0/cordova/media/capture/captureAudioOptions.md
index c7d7ac2..75e2c83 100644
--- a/docs/en/3.0.0/cordova/media/capture/captureAudioOptions.md
+++ b/docs/en/3.0.0/cordova/media/capture/captureAudioOptions.md
@@ -26,6 +26,7 @@ Properties
----------
- __limit__: The maximum number of audio clips the device user can record in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+
- __duration__: The maximum duration of an audio sound clip, in seconds.
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/captureImage.md b/docs/en/3.0.0/cordova/media/capture/captureImage.md
index 4b02b0b..9153a47 100644
--- a/docs/en/3.0.0/cordova/media/capture/captureImage.md
+++ b/docs/en/3.0.0/cordova/media/capture/captureImage.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
capture.captureImage
====================
-> Start the camera application and return information about captured image file(s).
+> Start the camera application and return information about captured image files.
navigator.device.capture.captureImage(
CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/captureVideo.md b/docs/en/3.0.0/cordova/media/capture/captureVideo.md
index e893b54..997a3b1 100644
--- a/docs/en/3.0.0/cordova/media/capture/captureVideo.md
+++ b/docs/en/3.0.0/cordova/media/capture/captureVideo.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
capture.captureVideo
====================
-> Start the video recorder application and return information about captured video clip file(s).
+> Start the video recorder application and return information about captured video clip files.
navigator.device.capture.captureVideo(
CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureVideoOptions options]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/captureVideoOptions.md b/docs/en/3.0.0/cordova/media/capture/captureVideoOptions.md
index 769e2ac..41c472b 100644
--- a/docs/en/3.0.0/cordova/media/capture/captureVideoOptions.md
+++ b/docs/en/3.0.0/cordova/media/capture/captureVideoOptions.md
@@ -26,6 +26,7 @@ Properties
----------
- __limit__: The maximum number of video clips the device's user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+
- __duration__: The maximum duration of a video clip, in seconds.
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/media.getCurrentPosition.md b/docs/en/3.0.0/cordova/media/media.getCurrentPosition.md
index 43c2018..66509f6 100644
--- a/docs/en/3.0.0/cordova/media/media.getCurrentPosition.md
+++ b/docs/en/3.0.0/cordova/media/media.getCurrentPosition.md
@@ -28,6 +28,7 @@ Parameters
----------
- __mediaSuccess__: The callback that is passed the current position in seconds.
+
- __mediaError__: (Optional) The callback to execute if an error occurs.
Description
@@ -41,10 +42,15 @@ Supported Platforms
-------------------
- Android
+
- BlackBerry WebWorks (OS 5.0 and higher)
+
- iOS
+
- Windows Phone 7 and 8
+
- Tizen
+
- Windows 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/media.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/media.md b/docs/en/3.0.0/cordova/media/media.md
index 2f9e49e..1c0edeb 100644
--- a/docs/en/3.0.0/cordova/media/media.md
+++ b/docs/en/3.0.0/cordova/media/media.md
@@ -33,8 +33,11 @@ Parameters
----------
- __src__: A URI containing the audio content. _(DOMString)_
+
- __mediaSuccess__: (Optional) The callback that executes after a `Media` object has completed the current play, record, or stop action. _(Function)_
+
- __mediaError__: (Optional) The callback that executes if an error occurs. _(Function)_
+
- __mediaStatus__: (Optional) The callback that executes to indicate status changes. _(Function)_
Constants
@@ -53,14 +56,23 @@ Methods
-------
- `media.getCurrentPosition`: Returns the current position within an audio file.
+
- `media.getDuration`: Returns the duration of an audio file.
+
- `media.play`: Start or resume playing an audio file.
+
- `media.pause`: Pause playback of an audio file.
+
- `media.release`: Releases the underlying operating system's audio resources.
+
- `media.seekTo`: Moves the position within the audio file.
+
- `media.setVolume`: Set the volume for audio playback.
+
- `media.startRecord`: Start recording an audio file.
+
- `media.stopRecord`: Stop recording an audio file.
+
- `media.stop`: Stop playing an audio file.
Additional ReadOnly Parameters
@@ -68,6 +80,7 @@ Additional ReadOnly Parameters
- __position__: The position within the audio playback, in seconds.
- Not automatically updated during play; call `getCurrentPosition` to update.
+
- __duration__: The duration of the media, in seconds.
Supported Platforms
@@ -80,54 +93,61 @@ Supported Platforms
- Tizen
- Windows 8
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git
- <plugin name="Media" value="org.apache.cordova.AudioHandler" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-#### app/AndroidManifest.xml
+* Android
- <uses-permission android:name="android.permission.RECORD_AUDIO" />
- <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+ (in app/res/xml/config.xml)
+ <feature name="Media">
+ <param name="android-package" value="org.apache.cordova.AudioHandler" />
+ </feature>
-### BlackBerry WebWorks
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.RECORD_AUDIO" />
+ <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-#### www/plugins.xml
+* BlackBerry WebWorks
- <plugin name="Capture" value="org.apache.cordova.media.MediaCapture" />
+ (in www/plugins.xml)
+ <feature name="Capture">
+ <param name="blackberry-package" value="org.apache.cordova.media.MediaCapture" />
+ </feature>
-### iOS
+* iOS (in `config.xml`)
-#### config.xml
+ <feature name="Media">
+ <param name="ios-package" value="CDVSound" />
+ </feature>
- <plugin name="Media" value="CDVSound" />
+* Windows Phone (in `Properties/WPAppManifest.xml`)
-### Windows Phone
+ <Capabilities>
+ <Capability Name="ID_CAP_MEDIALIB" />
+ <Capability Name="ID_CAP_MICROPHONE" />
+ <Capability Name="ID_HW_FRONTCAMERA" />
+ <Capability Name="ID_CAP_ISV_CAMERA" />
+ <Capability Name="ID_CAP_CAMERA" />
+ </Capabilities>
-#### Properties/WPAppManifest.xml
+ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
- <Capabilities>
- <Capability Name="ID_CAP_MEDIALIB" />
- <Capability Name="ID_CAP_MICROPHONE" />
- <Capability Name="ID_HW_FRONTCAMERA" />
- <Capability Name="ID_CAP_ISV_CAMERA" />
- <Capability Name="ID_CAP_CAMERA" />
- </Capabilities>
-
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-
-### Tizen
-
- No permissions are required.
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
### Windows Phone Quirks
- Only one media file can be played back at a time.
+
- There are strict restrictions on how your application interacts with other media. See the [Microsoft documentation for details][url].
[url]: http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/media.setVolume.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/media.setVolume.md b/docs/en/3.0.0/cordova/media/media.setVolume.md
index dc7ef9e..f960457 100644
--- a/docs/en/3.0.0/cordova/media/media.setVolume.md
+++ b/docs/en/3.0.0/cordova/media/media.setVolume.md
@@ -71,7 +71,6 @@ Quick Example
}, 5000);
}
-
Full Example
------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/media.startRecord.md b/docs/en/3.0.0/cordova/media/media.startRecord.md
index d33d777..50f9ef9 100644
--- a/docs/en/3.0.0/cordova/media/media.startRecord.md
+++ b/docs/en/3.0.0/cordova/media/media.startRecord.md
@@ -144,7 +144,9 @@ iOS Quirks
----------
- iOS only records to files of type _.wav_ and returns an error if the file name extension is not correct.
+
- If a full path is not provided, the recording is placed in the application's `documents/tmp` directory. This can be accessed via the `File` API using `LocalFileSystem.TEMPORARY`. Any subdirectory specified at record time must already exist.
+
- Files can be recorded and played back using the documents URI:
var myMedia = new Media("documents://beer.mp3")
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/notification/notification.alert.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/notification/notification.alert.md b/docs/en/3.0.0/cordova/notification/notification.alert.md
index ab73d58..99f1c0d 100644
--- a/docs/en/3.0.0/cordova/notification/notification.alert.md
+++ b/docs/en/3.0.0/cordova/notification/notification.alert.md
@@ -25,8 +25,11 @@ Shows a custom alert or dialog box.
navigator.notification.alert(message, alertCallback, [title], [buttonName])
- __message__: Dialog message. _(String)_
+
- __alertCallback__: Callback to invoke when alert dialog is dismissed. _(Function)_
+
- __title__: Dialog title. _(String)_ (Optional, defaults to `Alert`)
+
- __buttonName__: Button name. _(String)_ (Optional, defaults to `OK`)
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/notification/notification.beep.md b/docs/en/3.0.0/cordova/notification/notification.beep.md
index a254e96..104208e 100644
--- a/docs/en/3.0.0/cordova/notification/notification.beep.md
+++ b/docs/en/3.0.0/cordova/notification/notification.beep.md
@@ -107,5 +107,6 @@ Tizen Quirks
-------------
- Tizen implements beeps by playing an audio file via the media API.
-- The beep file must be short, must be located in a `sounds` sub-directory of the application's root directory, and must be named `beep.wav`.
+
+- The beep file must be short, must be located in a `sounds` subdirectory of the application's root directory, and must be named `beep.wav`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/notification/notification.confirm.md b/docs/en/3.0.0/cordova/notification/notification.confirm.md
index 48567da..072a603 100755
--- a/docs/en/3.0.0/cordova/notification/notification.confirm.md
+++ b/docs/en/3.0.0/cordova/notification/notification.confirm.md
@@ -25,8 +25,11 @@ Displays a customizable confirmation dialog box.
navigator.notification.confirm(message, confirmCallback, [title], [buttonLabels])
- __message__: Dialog message. _(String)_
+
- __confirmCallback__: Callback to invoke with index of button pressed (1, 2, or 3) or when the dialog is dismissed without a button press (0). _(Function)_
+
- __title__: Dialog title. _(String)_ (Optional, defaults to `Confirm`)
+
- __buttonLabels__: Comma-separated string specifying button labels. _(String)_ (Optional, defaults to `OK,Cancel`)
Description
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/notification/notification.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/notification/notification.md b/docs/en/3.0.0/cordova/notification/notification.md
index d72d51b..2f09a63 100644
--- a/docs/en/3.0.0/cordova/notification/notification.md
+++ b/docs/en/3.0.0/cordova/notification/notification.md
@@ -31,39 +31,45 @@ Methods
- `notification.beep`
- `notification.vibrate`
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git
+ $ cordova plugin rm org.apache.cordova.core.dialogs
+ $ cordova plugin rm org.apache.cordova.core.vibration
- <plugin name="Notification" value="org.apache.cordova.Notification"/>
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-#### app/AndroidManifest.xml
+* Android
- <uses-permission android:name="android.permission.VIBRATE" />
+ (in app/res/xml/config.xml)
+ <feature name="Notification">
+ <param name="android-package" value="org.apache.cordova.Notification" />
+ </feature>
-### BlackBerry WebWorks
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.VIBRATE" />
-#### www/plugins.xml
+* BlackBerry WebWorks
- <plugin name="Notification" value="org.apache.cordova.notification.Notification" />
+ (in www/plugins.xml)
+ <feature name="Notification">
+ <param name="blackberry-package" value="org.apache.cordova.notification.Notification" />
+ </feature>
-#### www/config.xml
+ (in www/config.xml)
+ <feature id="blackberry.ui.dialog" />
- <feature id="blackberry.ui.dialog" />
+* iOS (in `config.xml`)
-### iOS
+ <feature name="Notification">
+ <param name="ios-package" value="CDVNotification" />
+ </feature>
-#### config.xml
-
- <plugin name="Notification" value="CDVNotification" />
-
-### Windows Phone
-
- No permissions are required.
-
-### Tizen
-
- No permissions are required.
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/notification/notification.prompt.md b/docs/en/3.0.0/cordova/notification/notification.prompt.md
index 434df6b..fe704c3 100644
--- a/docs/en/3.0.0/cordova/notification/notification.prompt.md
+++ b/docs/en/3.0.0/cordova/notification/notification.prompt.md
@@ -25,10 +25,14 @@ Shows a customizable prompt dialog box.
navigator.notification.prompt(message, promptCallback, [title], [buttonLabels], [defaultText])
- __message__: Dialog message. _(String)_
+
- __promptCallback__: Callback to invoke when a button is pressed. _(Function)_
+
- __title__: Dialog title _(String)_ (Optional, defaults to `Prompt`)
+
- __buttonLabels__: Array of strings specifying button labels _(Array)_ (Optional, defaults to `["OK","Cancel"]`)
-- __defaultText__: Default textbox input value (`String`) (Optional, Default: "Default text")
+
+- __defaultText__: Default textbox input value (`String`) (Optional, Default: empty string)
Description
-----------
@@ -44,6 +48,7 @@ in the prompt dialog box. The `results` object passed to the callback
contains the following properties:
- __buttonIndex__: The index of the pressed button. _(Number)_ Note that the index uses one-based indexing, so the value is `1`, `2`, `3`, etc.
+
- __input1__: The text entered in the prompt dialog box. _(String)_
Supported Platforms
@@ -121,4 +126,5 @@ Android Quirks
----------------------
- Android supports a maximum of three buttons, and ignores any more than that.
+
- On Android 3.0 and later, buttons are displayed in reverse order for devices that use the Holo theme.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/splashscreen/splashscreen.hide.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/splashscreen/splashscreen.hide.md b/docs/en/3.0.0/cordova/splashscreen/splashscreen.hide.md
index 70ad003..f7d932a 100644
--- a/docs/en/3.0.0/cordova/splashscreen/splashscreen.hide.md
+++ b/docs/en/3.0.0/cordova/splashscreen/splashscreen.hide.md
@@ -33,7 +33,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry 10
- iOS
+- Windows Phone 7 and 8
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/splashscreen/splashscreen.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/splashscreen/splashscreen.md b/docs/en/3.0.0/cordova/splashscreen/splashscreen.md
index c2cc060..2c86114 100644
--- a/docs/en/3.0.0/cordova/splashscreen/splashscreen.md
+++ b/docs/en/3.0.0/cordova/splashscreen/splashscreen.md
@@ -28,20 +28,32 @@ Methods
- splashscreen.show
- splashscreen.hide
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git
+ $ cordova plugin rm org.apache.cordova.core.splashscreen
- <plugin name="SplashScreen" value="org.apache.cordova.SplashScreen"/>
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-### iOS
+* Android (in `app/res/xml/config.xml`)
+
+ <feature name="SplashScreen">
+ <param name="android-package" value="org.apache.cordova.SplashScreen" />
+ </feature>
+
+* iOS (in `config.xml`)
-#### config.xml
+ <feature name="SplashScreen">
+ <param name="ios-package" value="CDVSplashScreen" />
+ </feature>
- <plugin name="SplashScreen" value="CDVSplashScreen" />
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
Setup
-----
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/splashscreen/splashscreen.show.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/splashscreen/splashscreen.show.md b/docs/en/3.0.0/cordova/splashscreen/splashscreen.show.md
index 8aeffc7..806f30a 100644
--- a/docs/en/3.0.0/cordova/splashscreen/splashscreen.show.md
+++ b/docs/en/3.0.0/cordova/splashscreen/splashscreen.show.md
@@ -33,7 +33,9 @@ Supported Platforms
-------------------
- Android
+- BlackBerry 10
- iOS
+- Windows Phone 7 and 8
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/storage/database/database.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/storage/database/database.md b/docs/en/3.0.0/cordova/storage/database/database.md
index 5ac6444..7d2ec41 100644
--- a/docs/en/3.0.0/cordova/storage/database/database.md
+++ b/docs/en/3.0.0/cordova/storage/database/database.md
@@ -26,6 +26,7 @@ Methods
-------
- __transaction__: Runs a database transaction.
+
- __changeVersion__: Allows scripts to automatically verify the version number and change it when updating a schema.
Details
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/storage/localstorage/localstorage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/storage/localstorage/localstorage.md b/docs/en/3.0.0/cordova/storage/localstorage/localstorage.md
index 614584c..66b3562 100644
--- a/docs/en/3.0.0/cordova/storage/localstorage/localstorage.md
+++ b/docs/en/3.0.0/cordova/storage/localstorage/localstorage.md
@@ -20,26 +20,34 @@ license: Licensed to the Apache Software Foundation (ASF) under one
localStorage
===============
-Provides access to a [W3C Storage interface](http://dev.w3.org/html5/webstorage/#the-localstorage-attribute)
+Provides access to the W3C's
+[Web Storage interface](http://dev.w3.org/html5/webstorage/#the-localstorage-attribute)
- var storage = window.localStorage;
+ var permanentStorage = window.localStorage;
+ var tempStorage = window.sessionStorage;
Methods
-------
- __key__: Returns the name of the key at the specified position.
+
- __getItem__: Returns the item identified by the specified key.
+
- __setItem__: Assigns a keyed item's value.
+
- __removeItem__: Removes the item identified by the specified key.
+
- __clear__: Removes all of the key/value pairs.
Details
-----------
-The `window.localStorage` interface is based on the W3C Web Storage
-interface. An app can use it to save persistent data using key-value
-pairs. The `window.sessionStorage` interface works the same way, but
-all data is cleared each time the app closes.
+The `window.localStorage` interface implements the W3C's [Web Storage
+interface](http://dev.w3.org/html5/webstorage/). An app can use it to
+save persistent data using key-value pairs. The
+`window.sessionStorage` interface works the same way in every respect,
+except that all data is cleared each time the app closes. Each
+database provides a separate namespace.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/storage/sqlerror/sqlerror.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/storage/sqlerror/sqlerror.md b/docs/en/3.0.0/cordova/storage/sqlerror/sqlerror.md
index 5515103..1f33944 100644
--- a/docs/en/3.0.0/cordova/storage/sqlerror/sqlerror.md
+++ b/docs/en/3.0.0/cordova/storage/sqlerror/sqlerror.md
@@ -26,6 +26,7 @@ Properties
----------
- __code__: One of the predefined error codes listed below.
+
- __message__: A description of the error.
Constants
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/3.0.0/cordova/storage/sqlresultset/sqlresultset.md
index 89a0704..e29c0d0 100644
--- a/docs/en/3.0.0/cordova/storage/sqlresultset/sqlresultset.md
+++ b/docs/en/3.0.0/cordova/storage/sqlresultset/sqlresultset.md
@@ -27,7 +27,9 @@ Properties
-------
- __insertId__: The row ID of the row that the `SQLResultSet` object's SQL statement inserted into the database.
+
- __rowsAffected__: The number of rows changed by the SQL statement, zero if the statement did not affect any rows.
+
- __rows__: a `SQLResultSetRowList` representing the rows returned, empty if no rows are returned.
Details
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/storage/storage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/storage/storage.md b/docs/en/3.0.0/cordova/storage/storage.md
index 1f703fd..366f613 100644
--- a/docs/en/3.0.0/cordova/storage/storage.md
+++ b/docs/en/3.0.0/cordova/storage/storage.md
@@ -22,12 +22,22 @@ Storage
> Provides access to the device's storage options.
-This API is based on the [W3C Web SQL Database
-Specification](http://dev.w3.org/html5/webdatabase/) and [W3C Web
-Storage API Specification](http://dev.w3.org/html5/webstorage/). Some
-devices already provide an implementation of these specifications, in
-which case the built-in support applies. Cordova's implementation
-offers compatible support for those that don't.
+This API offers storage options based on two different W3C
+specifications:
+
+* The
+ [Web Storage API Specification](http://dev.w3.org/html5/webstorage/)
+ allows you to access data via simple key/value pairs. See the
+ section on localStorage for complete details on this interface.
+
+* The
+ [Web SQL Database Specification](http://dev.w3.org/html5/webdatabase/)
+ offers more full-featured database tables accessed via SQL queries.
+ A summary of this interface appears immediately below.
+
+Cordova provides access to both interfaces for the minority of devices
+that don't already support them. Otherwise the built-in
+implementations apply.
Methods
-------
@@ -50,31 +60,26 @@ Objects
- SQLResultSet
- SQLResultSetRowList
- SQLError
-- localStorage
-
-Permissions
------------
-
-### Android
-
-#### app/res/xml/config.xml
-
- <plugin name="Storage" value="org.apache.cordova.Storage" />
-
-### BlackBerry WebWorks
-#### www/config.xml
+## Accessing the Feature
- <feature id="blackberry.widgetcache" required="true" version="1.0.0.0" />
+As of version 3.0, access to Storage APIs is built into Cordova, and
+does not require using the CLI to add plugins as described in The
+Command-line Interface.
-### iOS
+If you are using the older set of Cordova tools that precede the CLI,
+the following platform-specific configuration settings are still
+required:
- No permissions are required.
+* Android (in `app/res/xml/config.xml`)
-### Windows Phone
+ <feature name="Storage">
+ <param name="android-package" value="org.apache.cordova.Storage" />
+ </feature>
- No permissions are required.
+* BlackBerry WebWorks (in `www/config.xml`)
-### Tizen
+ <feature id="blackberry.widgetcache" required="true" version="1.0.0.0" />
- No permissions are required.
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
[3/6] Update 3.0.0 from edge directory.
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/blackberry/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/blackberry/upgrading.md b/docs/en/3.0.0/guide/platforms/blackberry/upgrading.md
index 8c17b29..3885260 100644
--- a/docs/en/3.0.0/guide/platforms/blackberry/upgrading.md
+++ b/docs/en/3.0.0/guide/platforms/blackberry/upgrading.md
@@ -19,34 +19,47 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Upgrading BlackBerry
-This guide shows how to modify BlackBerry projects to upgrade from older versions of Cordova.
-Most of these instructions apply to projects created with an older set
-of command-line tools that precede the `cordova` CLI utility. See The
-Cordova Command-line Interface for information how to update the
-version of the CLI.
+This guide shows how to modify BlackBerry projects to upgrade from
+older versions of Cordova. These instructions apply to projects
+created with an older set of command-line tools that precede the
+`cordova` CLI utility. See The Command-line Interface for information
+how to update the version of the CLI.
## Upgrading 2.8.0 projects to 2.9.0 ##
BlackBerry 10:
-1. **Download and extract the Cordova 2.9.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.9.0)
-2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
-3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
-4. **Create a new project**, as described in BlackBerry Command-line Tools. This becomes the home of your updated project.
-5. **Copy** your projects source from the old project's /www folder to the new project's /www folder
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file
+1. Download and extract the Cordova 2.9.0 source to a permanent location on your hard drive, for example to `~/Cordova-2.9.0`.
+
+2. Quit any running SDK tools: Eclipse, Momentics and the like.
+
+3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
+
+4. Create a new project, as described in BlackBerry Command-line Tools. This becomes the home of your updated project.
+
+5. Copy your project's source from the old project's `/www` directory to the new project's `/www` directory.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova.js` file.
### BlackBerryOS/Playbook ###
-1. **Download and extract the Cordova 2.9.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.9.0)
-2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
-3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova.js** file from the new project into your **www** folder, and delete your **www/cordova.js** file
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file
-7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder
-8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder
-9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder
+1. Download and extract the Cordova 2.9.0 source to a permanent location on your hard drive, for example to `~/Cordova-2.9.0`.
+
+2. Quit any running SDK tools: Eclipse, Momentics and the like.
+
+3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova.js` file from the new project into your `www` directory, and delete your `www/cordova.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova.js` file.
+
+7. Copy the `native` directory from the new project into the existing project, overwriting the old `native` directory.
+
+8. Copy the `lib` directory from the new project into the existing project, overwriting the old `lib` directory.
+
+9. Copy the `cordova` directory from the new project into the existing project, overwriting the old `cordova` directory.
## Upgrading 2.7.0 projects to 2.8.0 ##
@@ -55,181 +68,270 @@ BlackBerry 10:
BlackBerry 10 uses the new CLI tooling and manages core APIs as plugins. The instructions migrate your project to a new project, rather than updating an existing project, due to the complexity of updating an old project.
Also note that the cordova js script file is now called 'cordova.js' and no longer contains a version string.
-1. **Download and extract the Cordova 2.8.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.8.0)
-2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
-3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
-4. **Create a new project**, as described in BlackBerry Command-line Tools. This becomes the home of your updated project.
-5. **Copy** your projects source from the old project's /www folder to the new project's /www folder
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file
+1. Download and extract the Cordova 2.8.0 source to a permanent location on your hard drive, for example to `~/Cordova-2.8.0`.
+
+2. Quit any running SDK tools: Eclipse, Momentics and the like.
+
+3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
+
+4. Create a new project, as described in BlackBerry Command-line Tools. This becomes the home of your updated project.
+
+5. Copy your project's source from the old project's `/www` directory to the new project's `/www` directory.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova.js` file.
BlackBerryOS/Playbook:
-1. **Download and extract the Cordova 2.8.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.8.0)
-2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
-3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova.js** file from the new project into your **www** folder, and delete your **www/cordova.js** file
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file
-7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder
-8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder
-9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder
+1. Download and extract the Cordova 2.8.0 source to a permanent location on your hard drive, for example to `~/Cordova-2.8.0`.
+
+2. Quit any running SDK tools: Eclipse, Momentics and the like.
+
+3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova.js` file from the new project into your `www` directory, and delete your `www/cordova.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova.js` file.
+
+7. Copy the `native` directory from the new project into the existing project, overwriting the old `native` directory.
+
+8. Copy the `lib` directory from the new project into the existing project, overwriting the old `lib` directory.
+
+9. Copy the `cordova` directory from the new project into the existing project, overwriting the old `cordova` directory.
## Upgrading 2.6.0 projects to 2.7.0 ##
-1. **Download and extract the Cordova 2.7.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.7.0)
-2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
-3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
-4. **Create a new project**, as described in BlackBerry Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova-2.7.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.6.0.js** file
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova-2.7.0.js** file
-7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder
-8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder
-9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder
+1. Download and extract the Cordova 2.7.0 source to a permanent location on your hard drive, for example to `~/Cordova-2.7.0`.
+
+2. Quit any running SDK tools: Eclipse, Momentics and the like.
+
+3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
+
+4. Create a new project, as described in BlackBerry Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova-2.7.0.js` file from the new project into your `www` directory, and delete your `www/cordova-2.6.0.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-2.7.0.js` file.
+
+7. Copy the `native` directory from the new project into the existing project, overwriting the old `native` directory.
+
+8. Copy the `lib` directory from the new project into the existing project, overwriting the old `lib` directory.
+
+9. Copy the `cordova` directory from the new project into the existing project, overwriting the old `cordova` directory.
## Upgrade to 2.6.0 from 2.5.0 ##
-Updating the PhoneGap download folder:
+Updating the PhoneGap download directory:
-It is recommended that you download a fresh copy of the entire folder.
+It is recommended that you download a fresh copy of the entire directory.
However, here are the new parts needed for the piecemeal update:
-1. Update the cordova.blackberry.js file in the ‘Phonegap-2.6.0/lib/blackberry/javascript’ folder
-2. Update the ‘ext’, ‘ext-air’, and ‘ext-qnx’ in the ‘Phonegap-2.6.0/lib/blackberry/framework’ folder
-3. Update the ‘build.xml’ file in the ‘Phonegap-2.6.0/lib/blackberry’ folder
-4. Update the ‘Phonegap-2.6.0/lib/blackberry/bin’ folder
-5. Update the ‘VERSION’ file in the ‘Phonegap-2.6.0/lib/blackberry’ folder
-
-Updating the example/ folder or migrating an existing project:
-
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
-4. Update the contents of the `ext-qnx/` folder.
+
+1. Update the cordova.blackberry.js file in the `Phonegap-2.6.0/lib/blackberry/javascript` directory.
+
+2. Update the `ext`, `ext-air`, and `ext-qnx` in the `Phonegap-2.6.0/lib/blackberry/framework` directory.
+
+3. Update the `build.xml` file in the `Phonegap-2.6.0/lib/blackberry` directory.
+
+4. Update the `Phonegap-2.6.0/lib/blackberry/bin` directory.
+
+5. Update the `VERSION` file in the `Phonegap-2.6.0/lib/blackberry` directory.
+
+Updating the `example/` directory or migrating an existing project:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
+
+4. Update the contents of the `ext-qnx/` directory.
+
4. Copy the new `cordova-2.6.0.js` into your project.
+
5. Update your HTML to use the new `cordova-2.6.0.js` file.
## Upgrade to 2.5.0 from 2.4.0 ##
-Updating the PhoneGap download folder:
+Updating the PhoneGap download directory:
-It is recommended that you download a fresh copy of the entire folder.
+It is recommended that you download a fresh copy of the entire directory.
However, here are the new parts needed for the piecemeal update:
-1. Update the cordova.blackberry.js file in the ‘Phonegap-2.5.0/lib/blackberry/javascript’ folder
-2. Update the ‘ext’, ‘ext-air’, and ‘ext-qnx’ in the ‘Phonegap-2.5.0/lib/blackberry/framework’ folder
-3. Update the ‘build.xml’ file in the ‘Phonegap-2.5.0/lib/blackberry’ folder
-4. Update the ‘Phonegap-2.5.0/lib/blackberry/bin’ folder
-5. Update the ‘VERSION’ file in the ‘Phonegap-2.5.0/lib/blackberry’ folder
-
-Updating the example/ folder or migrating an existing project:
-
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
-4. Update the contents of the `ext-qnx/` folder.
+
+1. Update the cordova.blackberry.js file in the `Phonegap-2.5.0/lib/blackberry/javascript` directory.
+
+2. Update the `ext`, `ext-air`, and `ext-qnx` in the `Phonegap-2.5.0/lib/blackberry/framework` directory.
+
+3. Update the `build.xml` file in the `Phonegap-2.5.0/lib/blackberry` directory.
+
+4. Update the `Phonegap-2.5.0/lib/blackberry/bin` directory.
+
+5. Update the `VERSION` file in the `Phonegap-2.5.0/lib/blackberry` directory.
+
+Updating the example/ directory or migrating an existing project:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
+
+4. Update the contents of the `ext-qnx/` directory.
+
4. Copy the new `cordova-2.5.0.js` into your project.
+
5. Update your HTML to use the new `cordova-2.5.0.js` file.
## Upgrade to 2.4.0 from 2.3.0 ##
-Updating just the `www` folder:
+Updating just the `www` directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-2.4.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
- - If BlackBerry 10, then update the .js file in the `qnx/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+ - If BlackBerry 10, then update the .js file in the `qnx/` directory.
+
5. Update your HTML to use the new `cordova-2.4.0.js` file.
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` directory.
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.2.3.0/ext/` folder.
-3. Update the contents of the `cordova.2.3.0/ext-air/` folder.
-4. Update the contents of the `cordova.2.3.0/ext-qnx/` folder.
-5. Update the .js file in the `cordova.2.3.0/javascript/` folder.
-6. Open the `sample/lib/` folder and rename the `cordova.2.3.0/` folder to `cordova.2.4.0/`.
-7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-8. Open the `www/` folder and update your HTML to use the new `cordova-2.4.0.js` file
+2. Update the .jar file in the `cordova.2.3.0/ext/` directory.
+
+3. Update the contents of the `cordova.2.3.0/ext-air/` directory.
+
+4. Update the contents of the `cordova.2.3.0/ext-qnx/` directory.
+
+5. Update the .js file in the `cordova.2.3.0/javascript/` directory.
+
+6. Open the `sample/lib/` directory and rename the `cordova.2.3.0/` directory to `cordova.2.4.0/`.
+
+7. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
+
+8. Open the `www/` directory and update your HTML to use the new `cordova-2.4.0.js` file.
## Upgrade to 2.3.0 from 2.2.0 ##
-Updating just the `www` folder:
+Updating just the `www` directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-2.3.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
- - If BlackBerry 10, then update the .js file in the `qnx/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+ - If BlackBerry 10, then update the .js file in the `qnx/` directory.
+
5. Update your HTML to use the new `cordova-2.3.0.js` file.
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` directory.
+
+2. Update the .jar file in the `cordova.2.2.0/ext/` directory.
+
+3. Update the contents of the `cordova.2.2.0/ext-air/` directory.
+
+4. Update the contents of the `cordova.2.2.0/ext-qnx/` directory.
+
+5. Update the .js file in the `cordova.2.2.0/javascript/` directory.
+
+6. Open the `sample/lib/` directory and rename the `cordova.2.2.0/` directory to `cordova.2.3.0/`.
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.2.2.0/ext/` folder.
-3. Update the contents of the `cordova.2.2.0/ext-air/` folder.
-4. Update the contents of the `cordova.2.2.0/ext-qnx/` folder.
-5. Update the .js file in the `cordova.2.2.0/javascript/` folder.
-6. Open the `sample/lib/` folder and rename the `cordova.2.2.0/` folder to `cordova.2.3.0/`.
-7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-8. Open the `www/` folder and update your HTML to use the new `cordova-2.3.0.js` file
+7. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
+
+8. Open the `www/` directory and update your HTML to use the new `cordova-2.3.0.js` file.
## Upgrade to 2.2.0 from 2.1.0 ##
-Updating just the www folder:
+Updating just the www directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-2.2.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
- - If BlackBerry 10, then update the .js file in the `qnx/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+ - If BlackBerry 10, then update the .js file in the `qnx/` directory.
+
5. Update your HTML to use the new `cordova-2.2.0.js` file.
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` directory.
+
+2. Update the .jar file in the `cordova.2.1.0/ext/` directory.
+
+3. Update the contents of the `cordova.2.1.0/ext-air/` directory.
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.2.1.0/ext/` folder.
-3. Update the contents of the `cordova.2.1.0/ext-air/` folder.
-4. Update the contents of the `cordova.2.1.0/ext-qnx/` folder.
-5. Update the .js file in the `cordova.2.1.0/javascript/` folder.
-6. Open the `sample/lib/` folder and rename the `cordova.2.1.0/` folder to `cordova.2.2.0/`.
-7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-8. Open the `www/` folder and update your HTML to use the new `cordova-2.2.0.js` file.
+4. Update the contents of the `cordova.2.1.0/ext-qnx/` directory.
+
+5. Update the .js file in the `cordova.2.1.0/javascript/` directory.
+
+6. Open the `sample/lib/` directory and rename the `cordova.2.1.0/` directory to `cordova.2.2.0/`.
+
+7. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
+
+8. Open the `www/` directory and update your HTML to use the new `cordova-2.2.0.js` file.
## Upgrade to 2.1.0 from 2.0.0 ##
-Updating just the `www` folder:
+Updating just the `www` directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-2.1.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+
5. Update your HTML to use the new `cordova-2.1.0.js` file.
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` directory.
+
+2. Update the .jar file in the `cordova.2.0.0/ext/` directory.
+
+3. Update the contents of the `cordova.2.0.0/ext-air/` directory.
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.2.0.0/ext/` folder.
-3. Update the contents of the `cordova.2.0.0/ext-air/` folder.
-4. Update the .js file in the `cordova.2.0.0/javascript/` folder.
-5. Open the `sample/lib/` folder and rename the `cordova.2.0.0/` folder to `cordova.2.1.0/`.
-6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-7. Open the `www/` folder and update your HTML to use the new `cordova-2.1.0.js` file.
+4. Update the .js file in the `cordova.2.0.0/javascript/` directory.
+
+5. Open the `sample/lib/` directory and rename the `cordova.2.0.0/` directory to `cordova.2.1.0/`.
+
+6. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
+
+7. Open the `www/` directory and update your HTML to use the new `cordova-2.1.0.js` file.
## Upgrade to 2.0.0 from 1.9.0 ##
-Updating just the `www` folder:
+Updating just the `www` directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-2.0.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+
5. Update your HTML to use the new `cordova-2.0.0.js` file.
+
6. Update your `www/plugins.xml` file. Two plugins changed their
namespace/service label. Change the old entries for the Capture and
Contact plugins from:
@@ -242,16 +344,23 @@ Updating just the `www` folder:
<plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
<plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` directory.
+
+2. Update the .jar file in the `cordova.1.9.0/ext/` directory.
+
+3. Update the contents of the `cordova.1.9.0/ext-air/` directory.
+
+4. Update the .js file in the `cordova.1.9.0/javascript/` directory.
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.1.9.0/ext/` folder.
-3. Update the contents of the `cordova.1.9.0/ext-air/` folder.
-4. Update the .js file in the `cordova.1.9.0/javascript/` folder.
-5. Open the `sample/lib/` folder and rename the `cordova.1.9.0/` folder to `cordova.2.0.0/`.
-6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-7. Open the `www/` folder and update your HTML to use the new `cordova-2.0.0.js` file.
-8. Open the `www/` folder and update the `plugins.xml` file. Two plugins
+5. Open the `sample/lib/` directory and rename the `cordova.1.9.0/` directory to `cordova.2.0.0/`.
+
+6. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
+
+7. Open the `www/` directory and update your HTML to use the new `cordova-2.0.0.js` file.
+
+8. Open the `www/` directory and update the `plugins.xml` file. Two plugins
changed their namespace/service label. Change the old entries for the
Capture and Contact plugins from:
@@ -267,14 +376,19 @@ Updating the sample folder (ie, updating using the ant tools):
## Upgrade to 1.8.0 from 1.7.0 ##
-Updating just the `www` folder:
+Updating just the `www` directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-1.8.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+
5. Update your HTML to use the new `cordova-1.8.0.js` file.
+
6. Update your `www/plugins.xml` file. Two plugins changed their
namespace/service label. Change the old entries for the Capture and
Contact plugins from:
@@ -287,16 +401,23 @@ Updating just the `www` folder:
<plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
<plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` directory.
+
+2. Update the .jar file in the `cordova.1.7.0/ext/` directory.
+
+3. Update the contents of the `cordova.1.7.0/ext-air/` directory.
+
+4. Update the .js file in the `cordova.1.7.0/javascript/` directory.
+
+5. Open the `sample/lib/` directory and rename the `cordova.1.7.0/` directory to `cordova.1.8.0/`.
+
+6. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
+
+7. Open the `www/` directory and update your HTML to use the new `cordova-1.8.0.js` file.
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.1.7.0/ext/` folder.
-3. Update the contents of the `cordova.1.7.0/ext-air/` folder.
-4. Update the .js file in the `cordova.1.7.0/javascript/` folder.
-5. Open the `sample/lib/` folder and rename the `cordova.1.7.0/` folder to `cordova.1.8.0/`.
-6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-7. Open the `www/` folder and update your HTML to use the new `cordova-1.8.0.js` file.
-8. Open the `www/` folder and update the `plugins.xml` file. Two plugins
+8. Open the `www/` directory and update the `plugins.xml` file. Two plugins
changed their namespace/service label. Change the old entries for the
Capture and Contact plugins from:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/blackberry10/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/blackberry10/index.md b/docs/en/3.0.0/guide/platforms/blackberry10/index.md
index 7695c8d..2eb91b4 100644
--- a/docs/en/3.0.0/guide/platforms/blackberry10/index.md
+++ b/docs/en/3.0.0/guide/platforms/blackberry10/index.md
@@ -19,55 +19,65 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# BlackBerry 10 Platform Guide
-This guide shows how to set up your development environment to build and deploy Cordova apps for BlackBerry 10 devices.
-
-For previous versions of BlackBerry, you need to use a different set of command-line tools, described in BlackBerry Platform Guide.
+This guide shows how to set up your development environment to build
+and deploy Cordova apps for BlackBerry 10 devices. For previous
+versions of BlackBerry, you need to use a different set of
+command-line tools, described in BlackBerry Platform Guide.
## Requirements
The development environment is available on Windows, Mac and Linux.
-Developers should use the `cordova` utility in conjunction with the Blackberry Native SDK. See The Command-line Interface for information how to install `cordova`, add projects, then build and deploy.
+Developers should use the `cordova` utility in conjunction with the
+Blackberry Native SDK. See The Command-line Interface for information
+how to install `cordova`, add projects, then build and deploy for each
+platform.
## Install the BlackBerry Native SDK
-The BlackBerry Native SDK is available from [developer.blackberry.com](http://developer.blackberry.com/native/download/).
-
-After installing the BlackBerry Native SDK, its tools must be added to your system path.
+The BlackBerry Native SDK is available from
+[developer.blackberry.com](http://developer.blackberry.com/native/download/).
+Following installation, you need to add its command-line tools to your
+system path.
-### Windows
+On Windows:
-Go to My Computer → Properties → Advanced → Environment Variables
+* Go to __My Computer → Properties → Advanced → Environment Variables__.
-Append to PATH based on where you installed the Native SDK, for example:
+* Append the Native SDK's install directory to the PATH, for example:
;C:\bbndk\host_10_1_0_132\darwin\x86\usr\bin\
-### Mac/Linux
+On Mac and Linux:
-Edit the ~/.bash_profile file, adding a line such as the following, depending on where the Native SDK was installed:
+* Edit the `~/.bash_profile` file, adding a line such as the
+ following, depending on where the Native SDK was installed:
$ export PATH=${PATH}:/Applications/bbndk/host_10_1_0_132/darwin/x86/usr/bin/
-Then run the following to apply the change immidiately:
+* Run the following to apply the change in the current session:
$ source ~/.bash_profile
## Set up for Signing
-If you wish to test on a device or distribute apps through BlackBerry World, your system must be setup for code signing.
+If you wish to test on a device or distribute apps through BlackBerry
+World, your system must be setup for code signing.
-To obtain a signing key, go to the BlackBerry website and make sure to retain the password you specify. Then run the `blackberry-signer` utility that is included with the BlackBerry Native SDK.
+To obtain a signing key, go to the BlackBerry website and make sure to
+retain the password you specify. Then run the `blackberry-signer`
+utility that is included with the BlackBerry Native SDK.
Detailed instuctions can be found here:
* [Register for your code signing key.](https://www.blackberry.com/SignedKeys/codesigning.html)
+
* [Set up your system for code signing.](https://developer.blackberry.com/html5/documentation/signing_setup_bb10_apps_2008396_11.html)
## Create a Project
-Use the `cordova` utility to set up a new project, as described in The Command-line Interface. For example, in a source-code
-directory:
+Use the `cordova` utility to set up a new project, as described in The
+Command-line Interface. For example, in a source-code directory:
$ cordova create hello com.example.hello
$ cd hello
@@ -76,28 +86,36 @@ directory:
## Deploy to Emulator
-If you wish to run a device emulator, download and install the BlackBerry 10 Simulator.
+If you wish to run a device emulator, download and install the
+BlackBerry 10 Simulator.
* [Download](http://developer.blackberry.com/native/download/)
* [Getting Started](http://developer.blackberry.com/devzone/develop/simulator/blackberry_10_simulator_start.html)
-Before testing an app on either an emulator or a device, you need to add a _target_ to your project. Each is identified with a unique name, and associated with an IP address. You need to get the IP address from the emulator before you use it to view apps.
+Before testing an app on either an emulator or a device, you need to
+add a _target_ to your project. Each is identified with a unique name,
+and associated with an IP address. You need to get the IP address from
+the emulator before you use it to view apps.
Launch the emulator image, then choose __Settings__ from the home screen:
-Navigate to the __Security and Privacy → Development Mode__ section, enable the option, and obtain the IP address:
+Navigate to the __Security and Privacy → Development Mode__
+section, enable the option, and obtain the IP address:
-An additional set of command-line utilities are included when you set up the BlackBerry 10 platform for your project. The following command, in this case invoked from the project top-level directory, associates a target named _emu_ with the IP address displayed above.
+An additional set of command-line utilities are included when you set
+up the BlackBerry 10 platform for your project. The following
+command, in this case invoked from the project top-level directory,
+associates a target named _emu_ with the IP address displayed above.
-Windows
+* On Windows:
$ platforms\blackberry10\cordova\target.bat add emu 169.254.0.1 -t simulator
-Mac/Linux
+* On Mac/Linux:
$ platforms/blackberry10/cordova/target add emu 169.254.0.1 -t simulator
@@ -107,58 +125,71 @@ Then, run the `emulate` command to view the app:
## Deploy to Device
-To deploy to a device, make sure it is plugged into your computer. Enable development mode and obtain the IP address as desribed in the emulator section above. You will also need to obtain the PIN from the the __Settings__ application under __About → Hardware__.
+To deploy to a device, make sure it is plugged into your computer.
+Enable development mode and obtain the IP address as desribed in the
+emulator section above. You will also need to obtain the PIN from the
+the __Settings__ application under __About → Hardware__:
-Run the target command-line utility to associate a name with an IP address, device password and PIN.
+Run the target command-line utility to associate a name with an IP
+address, device password and PIN.
-Windows
+* On Windows:
$ platforms\blackberry10\cordova\target.bat add mydevice 169.254.0.1 -t device --password 123456 --pin FFFF972E
-Mac/Linux
+* On Mac/Linux:
$ platforms/blackberry10/cordova/target add mydevice 169.254.0.1 -t device --password 123456 --pin FFFF972E
---password refers to the password to unlock the device
+where:
---pin refers to the device PIN obtained from the Settings application
+* `--password` refers to the password to unlock the device.
+
+* `--pin` refers to the device PIN obtained from the __Settings__ application.
Then, run the `run` command to view the app:
$ cordova run blackberry10
-If a debug token has not yet been created for this device, an error message will prompt you to use the platform run script with the password you provided when registering for signing keys.
+If a debug token is not yet set up for the device, an error message
+prompts you to use the platform run script with the password you
+provided when registering for signing keys.
-Windows
+* On Windows:
$ platforms\blackberry10\cordova\run.bat --device --keystorepass mysecret
-Mac/Linux
+* On Mac/Linux:
$ platforms/blackberry10/cordova/run --device --keystorepass mysecret
## Debugging with WebInspector
-When debugging on the device or a simulator, you may run WebInspector remotely to view the application's internal state.
-
-A prompt displays the URL that allows you to connect to your app with a standard web browser.
-
-For more information, see [Debugging using WebInspector](http://developer.blackberry.com/html5/documentation/web_inspector_overview_1553586_11.html).
+When debugging on the device or an emulator, you may run WebInspector
+remotely to view the application's internal state. A prompt displays
+the URL that allows you to connect to your app with a standard web
+browser. For more information, see
+[Debugging using WebInspector](http://developer.blackberry.com/html5/documentation/web_inspector_overview_1553586_11.html).
## Building a Release Version
-By default, running the `cordova build` command creates an unsigned _.bar_ package file suitable for testing on a device or simulator.
+By default, running the `cordova build` command creates an unsigned
+_.bar_ package file suitable for testing on a device or simulator.
-You need to run a different `build` command to create a release version suitable for distribution through BlackBerry World. This command uses the following syntax:
+You need to run a different `build` command to create a release
+version suitable for distribution through BlackBerry World. It does
+not rely on the `cordova` CLI tool, and instead uses the following
+syntax:
-Windows
+* On Windows:
$ platforms\blackberry10\cordova\build.bat --release --keystorepass mysecret
-Mac/Linux
+* On Mac/Linux:
$ platforms/blackberry10/cordova/build --release --keystorepass mysecret
---keystorepass specifies the password you defined when you configured your computer to sign applications.
+The `--keystorepass` option specifies the password you defined when
+configuring your computer to sign applications.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/blackberry10/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/blackberry10/plugin.md b/docs/en/3.0.0/guide/platforms/blackberry10/plugin.md
index aceb335..8e86ff8 100644
--- a/docs/en/3.0.0/guide/platforms/blackberry10/plugin.md
+++ b/docs/en/3.0.0/guide/platforms/blackberry10/plugin.md
@@ -27,7 +27,7 @@ This is a continuation of the Plugin Development Guide for Cordova. Once you hav
}, "Echo", "echo", [str]);
};
-A native BlackBerry 10 plugin for Cordova contains JavaScript code and may also contain native code. The Echo plugin example demonstrates how to invoke native functionality from JavaScript. The native and JavaScript code communicate with each other through a framework provided by JNEXT. Every plugin must also include a plugin.xml file.
+A native BlackBerry 10 plugin for Cordova contains JavaScript code and may also contain native code. The Echo plugin example demonstrates how to invoke native functionality from JavaScript. The native and JavaScript code communicate with each other through a framework provided by JNEXT. Every plugin must also include a `plugin.xml` file.
## Creating the native part of your plugin ##
@@ -35,10 +35,11 @@ To create the native portion of your plugin, open the BlackBerry 10 NDK IDE and
The project created by the IDE contains sample code for a memory plugin. You may replace or modify these files to include your own functionality.
-- ***name*_js.hpp**: C++ header for the JNEXT code.
-- ***name*_js.cpp**: C++ code for JNEXT.
+- `*name*_js.hpp`: C++ header for the JNEXT code.
-The native interface for the JNEXT extension can be viewed in the plugin header file located in the public folder of your project. It also contains constants and utility functions that can be used in your native code. Your plugin must be derived from JSExt which is defined in plugin.h. That is, you must implement the following class:
+- `*name*_js.cpp`: C++ code for JNEXT.
+
+The native interface for the JNEXT extension can be viewed in the plugin header file located in the public directory of your project. It also contains constants and utility functions that can be used in your native code. Your plugin must be derived from JSExt which is defined in plugin.h. That is, you must implement the following class:
class JSExt
{
@@ -94,6 +95,7 @@ Now we implement these functions in echo_js.cpp. For the Echo example, we implem
Your native plugin must also implement the following callback functions:
- `extern char* onGetObjList( void );`
+
- `extern JSExt* onCreateObject( const string& strClassName, const string& strObjId );`
The `onGetObjList` function returns a comma separated list of classes supported by JNEXT. JNEXT uses this function to determine the set of classes that JNEXT can instantiate. In our Echo plugin, we have the following in `echo_js.cpp`:
@@ -116,11 +118,11 @@ The `onCreateObject ` function takes two parameters. The first parameter is the
The JavaScript portion of your plugin must contain the following files:
-- **client.js**: This is considered the client side and contains the API that a Cordova application can call. The API in client.js calls makes calls to index.js. The API in client.js also connects callback functions to the events that fire the callbacks.
+- `client.js`: This is considered the client side and contains the API that a Cordova application can call. The API in `client.js` calls makes calls to `index.js`. The API in `client.js` also connects callback functions to the events that fire the callbacks.
-- **index.js**: Cordova loads index.js and makes it accessible through the cordova.exec bridge. The client.js file makes calls to the API in the index.js file, which in turn makes call to JNEXT to communicate with the native side.
+- `index.js`: Cordova loads `index.js` and makes it accessible through the cordova.exec bridge. The `client.js` file makes calls to the API in the `index.js` file, which in turn makes call to JNEXT to communicate with the native side.
-The client and server side (client.js and index.js) interacts through the `Cordova.exec `function. So, in client.js you invoke the exec function and provide the necessary arguments. In the Echo plugin, we have the following in the client.js file:
+The client and server side (`client.js` and `index.js`) interacts through the `Cordova.exec `function. So, in `client.js` you invoke the `exec` function and provide the necessary arguments. In the Echo plugin, we have the following in the `client.js` file:
var service = "org.apache.cordova.blackberry.echo",
exec = cordova.require("cordova/exec");
@@ -131,7 +133,7 @@ The client and server side (client.js and index.js) interacts through the `Cordo
}
};
-Now, index.js interacts with the native side using JNEXT. So you attach a constructor function named Echo to JNEXT. Within the constructor you perform the following key operations using the init function:
+Now, `index.js` interacts with the native side using JNEXT. So you attach a constructor function named Echo to JNEXT. Within the constructor you perform the following key operations using the init function:
- Specify the required module exported by the native side. The name of the required module must match the name of a shared library file (.so file).
@@ -139,7 +141,7 @@ Now, index.js interacts with the native side using JNEXT. So you attach a constr
- Create an object by using an acquired module and save the ID that's returned by the call.
self.m_id = JNEXT.createObject("libecho.Echo");
-When your application calls the echo function in client.js, that call in turn calls the echo function in index.js, where the PluginResult object sends a response (data) back to client.js. Since the args argument passed into the functions was converted by JSON.stringfy() and encoded as a URIcomponent, you must call the following:
+When your application calls the echo function in `client.js`, that call in turn calls the echo function in `index.js`, where the PluginResult object sends a response (data) back to `client.js`. Since the args argument passed into the functions was converted by JSON.stringfy() and encoded as a URIcomponent, you must call the following:
`data = JSON.parse(decodeURIComponent(args.data));`
@@ -158,20 +160,30 @@ You can now send the data back. Let’s put it all together:
## Architecture of the plugin ##
-You can place the artifacts of the plugin, which includes the plugin.xml file, the source files (JavaScript, C++), and the binary files (.so) within any directory structure, as long as you correctly specify the file locations in the plugin.xml file. Below we show a typical structure that you can follow:
+You can place the artifacts of the plugin, which includes the
+`plugin.xml` file, the source files (JavaScript, C++), and the binary
+files (`.so`) within any directory structure, as long as you correctly
+specify the file locations in the `plugin.xml` file. A typical structure
+looks like this:
-***your_project_folder*** (>plugin.xml)
+***your_project_directory*** (>plugin.xml)
- **www** (>client.js)
- **src**
- **blackberry10** (>index.js, **native** >*.cpp, *.hpp)
- - **device** (>*biary file* *.so)
+ - **device** (>*binary file* *.so)
- **simulator** (>*binary file* *.so)
-(The list shows the hierarchical relationship among the top level folders. The parenthesis shows the contents of a given folder. All folder names appear in bold text. File names are preceded by the '>' sign.)
+(The list shows the hierarchical relationship among the top-level
+folders. The parenthesis shows the contents of a given directory. All
+directory names appear in bold text. File names are preceded by the `>`
+sign.)
+
+## Contents of the `plugin.xml` file##
-## Contents of the plugin.xml file##
-The plugin.xml file contains the namespace of the extension and other metadata. Define the namespace and specify other metadata for the Echo plugin as follows:
+The `plugin.xml` file contains the namespace of the extension and other
+metadata. Define the namespace and specify other metadata for the Echo
+plugin as follows:
<plugin xmlns="http://www.phonegap.com/ns/plugins/1.0"
id="org.apache.cordova.blackberry.echo"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/blackberry10/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/blackberry10/tools.md b/docs/en/3.0.0/guide/platforms/blackberry10/tools.md
index a605680..8c3f6fa 100644
--- a/docs/en/3.0.0/guide/platforms/blackberry10/tools.md
+++ b/docs/en/3.0.0/guide/platforms/blackberry10/tools.md
@@ -37,15 +37,30 @@ arguments.
## create
-The 'create' command creates a new project:
+The `create` command creates a new project:
- bin/create <path-to-project>
+ bin/create <path-to-project> <project-package> <project-name>
+
+where
+
+- `<path-to-project>` specifies the directory you want the project created in
+
+- `<project-package>` specifies a reverse domain style identifier
+
+- `<project-name>` specifies the apps display name
+
+__NOTE:__ the `create` command bootstraps dependency installation
+through the `npm install` command. Depending on the installation
+directory and system permissions, this may require administrator
+privileges. If there's problem on OSX/Linux, run `sudo npm install`
+before using the `create` command. On Windows, run `npm install` in a
+command-line utility opened with administrator privileges.
## target
-The `target` command allows you to manage the BlackBerry device(s) or
-emulator that you will use to test your app. You can add or remove a
-target, or set a target as the default target.
+The `target` command allows you to manage the emulator or BlackBerry
+devices that you use to test your app. You can add or remove a target,
+or set a target as the default target.
### Add a target
@@ -88,7 +103,9 @@ in debug mode (which produces an unsigned .bar file).
where
- `-k | --keystorepass <password>` specifies the password you defined when you configured your computer to sign applications.
+
- `-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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/blackberry10/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/blackberry10/upgrading.md b/docs/en/3.0.0/guide/platforms/blackberry10/upgrading.md
index da9a58c..85165f8 100644
--- a/docs/en/3.0.0/guide/platforms/blackberry10/upgrading.md
+++ b/docs/en/3.0.0/guide/platforms/blackberry10/upgrading.md
@@ -21,51 +21,68 @@ license: Licensed to the Apache Software Foundation (ASF) under one
This guide shows how to modify BlackBerry projects to upgrade from older versions of Cordova.
Most of these instructions apply to projects created with an older set
-of command-line tools that precede the `cordova` CLI utility. See The
-Cordova Command-line Interface for information how to update the
+of command-line tools that precede the `cordova` CLI utility. See The Command-line Interface for information how to update the
version of the CLI.
-
Please note that the CLI supports the BlackBerry10 platform exclusively. For PlayBook and BBOS, please see Cordova version 2.9.0 and below.
## Upgrade to the CLI (3.0.0) from 2.9.0 ##
-1. **Create a new Apache Cordova 3.0.0 project using the cordova CLI**, as
- described in The Cordova Command-line Interface.
-2. **Add your platforms the the cordova project**, for example: `cordova
+1. Create a new Apache Cordova 3.0.0 project using the cordova CLI, as
+ described in The Command-line Interface.
+
+2. Add your platforms the the cordova project, for example: `cordova
platform add blackberry10`.
-3. **Copy the contents of the original project's `www` folder** to the `www` folder
+
+3. Copy the contents of the original project's `www` directory to the `www` directory
at the root of the cordova project you just created.
-4. **Copy or overwrite any native assets from your original project**
+
+4. Copy or overwrite any native assets from your original project
(`Resources`, etc.)
-5. **Copy your config.xml into the www folder, and remove any plugin definitions**. You will modify settings here instead of the platform folder.
-6. **Use the cordova CLI tool to install any plugins you need.** Note that
+
+5. Copy your `config.xml` into the `www` directory, and remove any plugin definitions. You will modify settings here instead of the platform directory.
+
+6. Use the cordova CLI tool to install any plugins you need. Note that
the CLI handles all core APIs as plugins, so they may need to be
added. Only 3.0.0 plugins are compatible with the CLI.
-7. **Build and test.**
+
+7. Build and test.
## Upgrading 2.8.0 projects to 2.9.0 ##
BlackBerry 10:
-1. **Download and extract the Cordova 2.9.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.9.0)
-2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
-3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
-4. **Create a new project**, as described in BlackBerry Command-line Tools. This becomes the home of your updated project.
-5. **Copy** your projects source from the old project's /www folder to the new project's /www folder
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file
+1. Download and extract the Cordova 2.9.0 source to a permanent directory location on your hard drive, for example to `~/Cordova-2.9.0`.
+
+2. Quit any running SDK tools: Eclipse, Momentics and the like.
+
+3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
+
+4. Create a new project, as described in BlackBerry Command-line Tools. This becomes the home of your updated project.
+
+5. Copy your projects source from the old project's `/www` directory to the new project's `/www` directory.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova.js` file.
### BlackBerryOS/Playbook ###
-1. **Download and extract the Cordova 2.9.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.9.0)
-2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
-3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova.js** file from the new project into your **www** folder, and delete your **www/cordova.js** file
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file
-7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder
-8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder
-9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder
+1. Download and extract the Cordova 2.9.0 source to a permanent directory location on your hard drive, for example to `~/Cordova-2.9.0`.
+
+2. Quit any running SDK tools: Eclipse, Momentics and the like.
+
+3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova.js` file from the new project into your `www` directory, and delete your `www/cordova.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova.js` file.
+
+7. Copy the `native` directory from the new project into the existing project, overwriting the old `native` directory.
+
+8. Copy the `lib` directory from the new project into the existing project, overwriting the old `lib` directory.
+
+9. Copy the `cordova` directory from the new project into the existing project, overwriting the old `cordova` directory.
## Upgrading 2.7.0 projects to 2.8.0 ##
@@ -74,181 +91,270 @@ BlackBerry 10:
BlackBerry 10 uses the new CLI tooling and manages core APIs as plugins. The instructions migrate your project to a new project, rather than updating an existing project, due to the complexity of updating an old project.
Also note that the cordova js script file is now called 'cordova.js' and no longer contains a version string.
-1. **Download and extract the Cordova 2.8.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.8.0)
-2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
-3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
-4. **Create a new project**, as described in BlackBerry Command-line Tools. This becomes the home of your updated project.
-5. **Copy** your projects source from the old project's /www folder to the new project's /www folder
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file
+1. Download and extract the Cordova 2.8.0 source to a permanent directory location on your hard drive, for example to `~/Cordova-2.8.0`.
+
+2. Quit any running SDK tools: Eclipse, Momentics and the like.
+
+3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
+
+4. Create a new project, as described in BlackBerry Command-line Tools. This becomes the home of your updated project.
+
+5. Copy your projects source from the old project's `/www` directory to the new project's `/www` directory.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova.js` file.
BlackBerryOS/Playbook:
-1. **Download and extract the Cordova 2.8.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.8.0)
-2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
-3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova.js** file from the new project into your **www** folder, and delete your **www/cordova.js** file
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file
-7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder
-8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder
-9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder
+1. Download and extract the Cordova 2.8.0 source to a permanent directory location on your hard drive, for example to `~/Cordova-2.8.0`.
+
+2. Quit any running SDK tools: Eclipse, Momentics and the like.
+
+3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova.js` file from the new project into your `www` directory, and delete your `www/cordova.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova.js` file.
+
+7. Copy the `native` directory from the new project into the existing project, overwriting the old `native` directory.
+
+8. Copy the `lib` directory from the new project into the existing project, overwriting the old `lib` directory.
+
+9. Copy the `cordova` directory from the new project into the existing project, overwriting the old `cordova` directory.
## Upgrading 2.6.0 projects to 2.7.0 ##
-1. **Download and extract the Cordova 2.7.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.7.0)
-2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
-3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
-4. **Create a new project**, as described in BlackBerry Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova-2.7.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.6.0.js** file
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova-2.7.0.js** file
-7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder
-8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder
-9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder
+1. Download and extract the Cordova 2.7.0 source to a permanent directory location on your hard drive, for example to `~/Cordova-2.7.0`.
+
+2. Quit any running SDK tools: Eclipse, Momentics and the like.
+
+3. Navigate to the directory where you put the downloaded source above, using a unix like terminal: Terminal.app, Bash, Cygwin, etc.
+
+4. Create a new project, as described in BlackBerry Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova-2.7.0.js` file from the new project into your `www` directory, and delete your `www/cordova-2.6.0.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-2.7.0.js` file.
+
+7. Copy the `native` directory from the new project into the existing project, overwriting the old `native` directory.
+
+8. Copy the `lib` directory from the new project into the existing project, overwriting the old `lib` directory.
+
+9. Copy the `cordova` directory from the new project into the existing project, overwriting the old `cordova` directory.
## Upgrade to 2.6.0 from 2.5.0 ##
-Updating the PhoneGap download folder:
+Updating the PhoneGap download directory:
-It is recommended that you download a fresh copy of the entire folder.
+It is recommended that you download a fresh copy of the entire directory.
However, here are the new parts needed for the piecemeal update:
-1. Update the cordova.blackberry.js file in the ‘Phonegap-2.6.0/lib/blackberry/javascript’ folder
-2. Update the ‘ext’, ‘ext-air’, and ‘ext-qnx’ in the ‘Phonegap-2.6.0/lib/blackberry/framework’ folder
-3. Update the ‘build.xml’ file in the ‘Phonegap-2.6.0/lib/blackberry’ folder
-4. Update the ‘Phonegap-2.6.0/lib/blackberry/bin’ folder
-5. Update the ‘VERSION’ file in the ‘Phonegap-2.6.0/lib/blackberry’ folder
-
-Updating the example/ folder or migrating an existing project:
-
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
-4. Update the contents of the `ext-qnx/` folder.
+
+1. Update the cordova.blackberry.js file in the `Phonegap-2.6.0/lib/blackberry/javascript` directory.
+
+2. Update the `ext`, `ext-air`, and `ext-qnx` in the `Phonegap-2.6.0/lib/blackberry/framework` directory.
+
+3. Update the `build.xml` file in the `Phonegap-2.6.0/lib/blackberry` directory.
+
+4. Update the `Phonegap-2.6.0/lib/blackberry/bin` directory.
+
+5. Update the `VERSION` file in the `Phonegap-2.6.0/lib/blackberry` directory.
+
+Updating the example/ directory or migrating an existing project:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
+
+4. Update the contents of the `ext-qnx/` directory.
+
4. Copy the new `cordova-2.6.0.js` into your project.
+
5. Update your HTML to use the new `cordova-2.6.0.js` file.
## Upgrade to 2.5.0 from 2.4.0 ##
-Updating the PhoneGap download folder:
+Updating the PhoneGap download directory:
-It is recommended that you download a fresh copy of the entire folder.
+It is recommended that you download a fresh copy of the entire directory.
However, here are the new parts needed for the piecemeal update:
-1. Update the cordova.blackberry.js file in the ‘Phonegap-2.5.0/lib/blackberry/javascript’ folder
-2. Update the ‘ext’, ‘ext-air’, and ‘ext-qnx’ in the ‘Phonegap-2.5.0/lib/blackberry/framework’ folder
-3. Update the ‘build.xml’ file in the ‘Phonegap-2.5.0/lib/blackberry’ folder
-4. Update the ‘Phonegap-2.5.0/lib/blackberry/bin’ folder
-5. Update the ‘VERSION’ file in the ‘Phonegap-2.5.0/lib/blackberry’ folder
-
-Updating the example/ folder or migrating an existing project:
-
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
-4. Update the contents of the `ext-qnx/` folder.
+
+1. Update the cordova.blackberry.js file in the `Phonegap-2.5.0/lib/blackberry/javascript` directory.
+
+2. Update the `ext`, `ext-air`, and `ext-qnx` in the `Phonegap-2.5.0/lib/blackberry/framework` directory.
+
+3. Update the `build.xml` file in the `Phonegap-2.5.0/lib/blackberry` directory.
+
+4. Update the `Phonegap-2.5.0/lib/blackberry/bin` directory.
+
+5. Update the `VERSION` file in the `Phonegap-2.5.0/lib/blackberry` directory.
+
+Updating the example/ directory or migrating an existing project:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
+
+4. Update the contents of the `ext-qnx/` directory.
+
4. Copy the new `cordova-2.5.0.js` into your project.
+
5. Update your HTML to use the new `cordova-2.5.0.js` file.
## Upgrade to 2.4.0 from 2.3.0 ##
-Updating just the `www` folder:
+Updating just the `www` directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-2.4.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
- - If BlackBerry 10, then update the .js file in the `qnx/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+ - If BlackBerry 10, then update the .js file in the `qnx/` directory.
+
5. Update your HTML to use the new `cordova-2.4.0.js` file.
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (i.e., updating using the ant tools):
+
+1. Open the `sample/lib/` directory.
+
+2. Update the .jar file in the `cordova.2.3.0/ext/` directory.
+
+3. Update the contents of the `cordova.2.3.0/ext-air/` directory.
+
+4. Update the contents of the `cordova.2.3.0/ext-qnx/` directory.
+
+5. Update the .js file in the `cordova.2.3.0/javascript/` directory.
+
+6. Open the `sample/lib/` directory and rename the `cordova.2.3.0/` directory to `cordova.2.4.0/`.
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.2.3.0/ext/` folder.
-3. Update the contents of the `cordova.2.3.0/ext-air/` folder.
-4. Update the contents of the `cordova.2.3.0/ext-qnx/` folder.
-5. Update the .js file in the `cordova.2.3.0/javascript/` folder.
-6. Open the `sample/lib/` folder and rename the `cordova.2.3.0/` folder to `cordova.2.4.0/`.
-7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-8. Open the `www/` folder and update your HTML to use the new `cordova-2.4.0.js` file
+7. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
+
+8. Open the `www/` directory and update your HTML to use the new `cordova-2.4.0.js` file.
## Upgrade to 2.3.0 from 2.2.0 ##
-Updating just the `www` folder:
+Updating just the `www` directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-2.3.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
- - If BlackBerry 10, then update the .js file in the `qnx/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+ - If BlackBerry 10, then update the .js file in the `qnx/` directory.
+
5. Update your HTML to use the new `cordova-2.3.0.js` file.
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (i.e., updating using the ant tools):
+
+1. Open the `sample/lib/` directory.
+
+2. Update the .jar file in the `cordova.2.2.0/ext/` directory.
+
+3. Update the contents of the `cordova.2.2.0/ext-air/` directory.
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.2.2.0/ext/` folder.
-3. Update the contents of the `cordova.2.2.0/ext-air/` folder.
-4. Update the contents of the `cordova.2.2.0/ext-qnx/` folder.
-5. Update the .js file in the `cordova.2.2.0/javascript/` folder.
-6. Open the `sample/lib/` folder and rename the `cordova.2.2.0/` folder to `cordova.2.3.0/`.
-7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-8. Open the `www/` folder and update your HTML to use the new `cordova-2.3.0.js` file
+4. Update the contents of the `cordova.2.2.0/ext-qnx/` directory.
+
+5. Update the .js file in the `cordova.2.2.0/javascript/` directory.
+
+6. Open the `sample/lib/` directory and rename the `cordova.2.2.0/` directory to `cordova.2.3.0/`.
+
+7. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
+
+8. Open the `www/` directory and update your HTML to use the new `cordova-2.3.0.js` file.
## Upgrade to 2.2.0 from 2.1.0 ##
-Updating just the www folder:
+Updating just the www directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-2.2.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
- - If BlackBerry 10, then update the .js file in the `qnx/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+ - If BlackBerry 10, then update the .js file in the `qnx/` directory.
+
5. Update your HTML to use the new `cordova-2.2.0.js` file.
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (i.e., updating using the ant tools):
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.2.1.0/ext/` folder.
-3. Update the contents of the `cordova.2.1.0/ext-air/` folder.
-4. Update the contents of the `cordova.2.1.0/ext-qnx/` folder.
-5. Update the .js file in the `cordova.2.1.0/javascript/` folder.
-6. Open the `sample/lib/` folder and rename the `cordova.2.1.0/` folder to `cordova.2.2.0/`.
-7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-8. Open the `www/` folder and update your HTML to use the new `cordova-2.2.0.js` file.
+1. Open the `sample/lib/` directory.
+
+2. Update the .jar file in the `cordova.2.1.0/ext/` directory.
+
+3. Update the contents of the `cordova.2.1.0/ext-air/` directory.
+
+4. Update the contents of the `cordova.2.1.0/ext-qnx/` directory.
+
+5. Update the .js file in the `cordova.2.1.0/javascript/` directory.
+
+6. Open the `sample/lib/` directory and rename the `cordova.2.1.0/` directory to `cordova.2.2.0/`.
+
+7. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
+
+8. Open the `www/` directory and update your HTML to use the new `cordova-2.2.0.js` file.
## Upgrade to 2.1.0 from 2.0.0 ##
-Updating just the `www` folder:
+Updating just the `www` directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-2.1.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+
5. Update your HTML to use the new `cordova-2.1.0.js` file.
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (i.e., updating using the ant tools):
+
+1. Open the `sample/lib/` directory.
+
+2. Update the .jar file in the `cordova.2.0.0/ext/` directory.
+
+3. Update the contents of the `cordova.2.0.0/ext-air/` directory.
+
+4. Update the .js file in the `cordova.2.0.0/javascript/` directory.
+
+5. Open the `sample/lib/` directory and rename the `cordova.2.0.0/` directory to `cordova.2.1.0/`.
+
+6. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.2.0.0/ext/` folder.
-3. Update the contents of the `cordova.2.0.0/ext-air/` folder.
-4. Update the .js file in the `cordova.2.0.0/javascript/` folder.
-5. Open the `sample/lib/` folder and rename the `cordova.2.0.0/` folder to `cordova.2.1.0/`.
-6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-7. Open the `www/` folder and update your HTML to use the new `cordova-2.1.0.js` file.
+7. Open the `www/` directory and update your HTML to use the new `cordova-2.1.0.js` file.
## Upgrade to 2.0.0 from 1.9.0 ##
-Updating just the `www` folder:
+Updating just the `www` directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-2.0.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+
5. Update your HTML to use the new `cordova-2.0.0.js` file.
+
6. Update your `www/plugins.xml` file. Two plugins changed their
namespace/service label. Change the old entries for the Capture and
Contact plugins from:
@@ -261,16 +367,23 @@ Updating just the `www` folder:
<plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
<plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (i.e., updating using the ant tools):
+
+1. Open the `sample/lib/` directory.
+
+2. Update the .jar file in the `cordova.1.9.0/ext/` directory.
+
+3. Update the contents of the `cordova.1.9.0/ext-air/` directory.
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.1.9.0/ext/` folder.
-3. Update the contents of the `cordova.1.9.0/ext-air/` folder.
-4. Update the .js file in the `cordova.1.9.0/javascript/` folder.
-5. Open the `sample/lib/` folder and rename the `cordova.1.9.0/` folder to `cordova.2.0.0/`.
-6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-7. Open the `www/` folder and update your HTML to use the new `cordova-2.0.0.js` file.
-8. Open the `www/` folder and update the `plugins.xml` file. Two plugins
+4. Update the .js file in the `cordova.1.9.0/javascript/` directory.
+
+5. Open the `sample/lib/` directory and rename the `cordova.1.9.0/` directory to `cordova.2.0.0/`.
+
+6. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
+
+7. Open the `www/` directory and update your HTML to use the new `cordova-2.0.0.js` file.
+
+8. Open the `www/` directory and update the `plugins.xml` file. Two plugins
changed their namespace/service label. Change the old entries for the
Capture and Contact plugins from:
@@ -286,14 +399,19 @@ Updating the sample folder (ie, updating using the ant tools):
## Upgrade to 1.8.0 from 1.7.0 ##
-Updating just the `www` folder:
+Updating just the `www` directory:
+
+1. Open your `www/` directory, which contains your app.
+
+2. Remove and update the .jar file in the `ext/` directory.
+
+3. Update the contents of the `ext-air/` directory.
-1. Open your `www/` folder, which contains your app.
-2. Remove and update the .jar file in the `ext/` folder.
-3. Update the contents of the `ext-air/` folder.
4. Copy the new `cordova-1.8.0.js` into your project.
- - If playbook, then update the .js file in the `playbook/` folder.
+ - If playbook, then update the .js file in the `playbook/` directory.
+
5. Update your HTML to use the new `cordova-1.8.0.js` file.
+
6. Update your `www/plugins.xml` file. Two plugins changed their
namespace/service label. Change the old entries for the Capture and
Contact plugins from:
@@ -306,16 +424,23 @@ Updating just the `www` folder:
<plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
<plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
-Updating the sample folder (ie, updating using the ant tools):
+Updating the sample directory (i.e., updating using the ant tools):
+
+1. Open the `sample/lib/` directory.
+
+2. Update the .jar file in the `cordova.1.7.0/ext/` directory.
+
+3. Update the contents of the `cordova.1.7.0/ext-air/` directory.
+
+4. Update the .js file in the `cordova.1.7.0/javascript/` directory.
+
+5. Open the `sample/lib/` directory and rename the `cordova.1.7.0/` directory to `cordova.1.8.0/`.
+
+6. Type `ant blackberry build` or `ant playbook build` to update the `www/` directory with updated Cordova.
+
+7. Open the `www/` directory and update your HTML to use the new `cordova-1.8.0.js` file.
-1. Open the `sample/lib/` folder.
-2. Update the .jar file in the `cordova.1.7.0/ext/` folder.
-3. Update the contents of the `cordova.1.7.0/ext-air/` folder.
-4. Update the .js file in the `cordova.1.7.0/javascript/` folder.
-5. Open the `sample/lib/` folder and rename the `cordova.1.7.0/` folder to `cordova.1.8.0/`.
-6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
-7. Open the `www/` folder and update your HTML to use the new `cordova-1.8.0.js` file.
-8. Open the `www/` folder and update the `plugins.xml` file. Two plugins
+8. Open the `www/` directory and update the `plugins.xml` file. Two plugins
changed their namespace/service label. Change the old entries for the
Capture and Contact plugins from:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/ios/config.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/ios/config.md b/docs/en/3.0.0/guide/platforms/ios/config.md
index ba79cf8..4b0a36d 100644
--- a/docs/en/3.0.0/guide/platforms/ios/config.md
+++ b/docs/en/3.0.0/guide/platforms/ios/config.md
@@ -19,39 +19,75 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# iOS Configuration
-The `config.xml` settings file controls various settings of Cordova. This is application wide, and not set per CDVViewController instance.
-The `config.xml` file is located in your `<project folder>/<appname>` directory.
-
-## <preference>
-
-Various preferences (as **<preference>** tags) default on not breaking existing apps. The available preferences are:
-
-1. **DisallowOverscroll (boolean, defaults to false)** - set to true if you don't want the WebView to rubber-band
-
-2. **TopActivityIndicator (string, defaults to 'gray')** - this is the top spinning throbber in the status/battery bar, valid values are `whiteLarge`, `white`, and `gray`
-
-3. **EnableLocation (boolean, defaults to false)** - set to true, to initialize the Geolocation plugin at start-up (so the fix on your location can be more accurate) **DEPRECATED**: please set the **onload** attribute of the **Geolocation** plugin to **true** instead.
-
-4. **EnableViewportScale (boolean, defaults to false)** - set to true to prevent viewport scaling through a meta tag
-
-5. **AutoHideSplashScreen (boolean, defaults to true)** - set to false to control when the splashscreen is hidden through a JavaScript API
-
-6. **FadeSplashScreen (boolean, defaults to true)** - set to false to prevent the splash-screen to fade in and out when showing or hiding it.
-
-7. **FadeSplashScreenDuration (float, defaults to 2)** - The splash-screen Fade duration in seconds.
-
-8. **ShowSplashScreenSpinner (boolean, defaults to true)** - set to false to hide the splash-screen spinner
-
-9. **MediaPlaybackRequiresUserAction (boolean, defaults to false)** - set to true to not allow autoplayed HTML5 video
-
-10. **AllowInlineMediaPlayback (boolean, defaults to false)** - set to true to allow inline HTML5 media playback, also, the video element in the HTML document must also include the webkit-playsinline attribute
-
-11. **BackupWebStorage (string, defaults to 'cloud')** - valid values are 'none', 'cloud' and 'local'. Set to 'cloud' to allow the web storage data to be backed up to iCloud, and set to 'local' to only allow local backups (iTunes sync). Set to 'none' to not allow any backups of web storage.
-
-12. **KeyboardDisplayRequiresUserAction (boolean, defaults to true)** - set to false to open the keyboard when form elements get focus via the JavaScript focus() call.
-
-13. **SuppressesIncrementalRendering (boolean, defaults to false)** - set to true to wait until all new view content has been received before it is rendered.
-
-14. **HideKeyboardFormAccessoryBar (boolean, defaults to false)** - set to true to hide the additional toolbar that is on top of the keyboard (this is the toolbar that has the Prev, Next and Done buttons)
-
-15. **KeyboardShrinksView (boolean, defaults to false)** - set to true to shrink the WebView when the keyboard comes up. The WebView shrinks instead of the viewport shrinking and the page scrollable. This applies to apps that position their elements relative to the bottom of the WebView. This is the default behaviour on Android, and makes a lot of sense when building apps as opposed to webpages.
+The `config.xml` settings file controls various Cordova settings.
+This is application wide, and not set per CDVViewController instance.
+The `config.xml` file is located in your `<project folder>/<appname>`
+directory.
+
+## `<preference>`
+
+Various preferences (as `<preference>` tags) default on not breaking
+existing apps. The available preferences are:
+
+* `DisallowOverscroll` (boolean, defaults to `false`): set to `true` if
+ you don't want the WebView to rubber-band.
+
+* `TopActivityIndicator` (string, defaults to `gray`): this is the top
+ spinning throbber in the status/battery bar, valid values are
+ `whiteLarge`, `white`, and `gray`.
+
+* `EnableLocation` (boolean, defaults to `false`): set to true, to
+ initialize the Geolocation plugin at start-up (so the fix on your
+ location can be more accurate) **DEPRECATED**: please set the
+ `onload` attribute of the `Geolocation` plugin to `true`
+ instead.
+
+* `EnableViewportScale` (boolean, defaults to `false`): set to true to
+ prevent viewport scaling through a meta tag.
+
+* `AutoHideSplashScreen` (boolean, defaults to `true`): set to false to
+ control when the splashscreen is hidden through a JavaScript API.
+
+* `FadeSplashScreen` (boolean, defaults to `true`): set to false to
+ prevent the splash-screen to fade in and out when showing or hiding
+ it.
+
+* `FadeSplashScreenDuration` (float, defaults to 2): The splash-screen
+ Fade duration in seconds.
+
+* `ShowSplashScreenSpinner` (boolean, defaults to `true`): set to false
+ to hide the splash-screen spinner.
+
+* `MediaPlaybackRequiresUserAction` (boolean, defaults to `false`): set
+ to true to not allow autoplayed HTML5 video.
+
+* `AllowInlineMediaPlayback` (boolean, defaults to `false`): set to
+ true to allow inline HTML5 media playback, also, the video element
+ in the HTML document must also include the webkit-playsinline
+ attribute.
+
+* `BackupWebStorage` (string, defaults to `cloud`): valid values are
+ `none`, `cloud` and `local`. Set to `cloud` to allow the web
+ storage data to be backed up to iCloud, and set to `local` to only
+ allow local backups (iTunes sync). Set to `none` to not allow any
+ backups of web storage.
+
+* `KeyboardDisplayRequiresUserAction` (boolean, defaults to `true`):
+ set to false to open the keyboard when form elements get focus via
+ the JavaScript focus() call.
+
+* `SuppressesIncrementalRendering` (boolean, defaults to `false`): set
+ to true to wait until all new view content has been received
+ before it is rendered.
+
+* `HideKeyboardFormAccessoryBar` (boolean, defaults to `false`): set to
+ true to hide the additional toolbar that is on top of the
+ keyboard. This toolbar features the __Prev__, __Next__, and __Done__
+ buttons.
+
+* `KeyboardShrinksView` (boolean, defaults to `false`): set to `true` to
+ shrink the WebView when the keyboard comes up. The WebView shrinks
+ instead of the viewport shrinking and the page scrollable. This
+ applies to apps that position their elements relative to the bottom
+ of the WebView. This is the default behaviour on Android, and makes
+ a lot of sense when building apps as opposed to webpages.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/ios/index.md b/docs/en/3.0.0/guide/platforms/ios/index.md
index 92a813f..9fbaf20 100644
--- a/docs/en/3.0.0/guide/platforms/ios/index.md
+++ b/docs/en/3.0.0/guide/platforms/ios/index.md
@@ -30,7 +30,7 @@ following for more detailed platform-specific information:
* iOS Command-line Tools
The command-line tools above refer to versions prior to Cordova 3.0.
-See The Cordova Command-line Interface for information about the
+See The Command-line Interface for information about the
current interface.
## Requirements and Support
@@ -76,7 +76,7 @@ Cordova The Command-line Interface. For example, in a source-code directory:
$ cordova create hello com.example.hello "HelloWorld"
$ cd hello
- $ cordova platform add android
+ $ cordova platform add ios
$ cordova prepare # or "cordova build"
Once created, you can open it from within Xcode. Double-click to open
[6/6] docs commit: Update 3.0.0 from edge directory.
Posted by mw...@apache.org.
Update 3.0.0 from edge directory.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/3fb6feae
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/3fb6feae
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/3fb6feae
Branch: refs/heads/master
Commit: 3fb6feae415b9bdd1f71f3556a5ede1a9f4e1628
Parents: 932e8c6
Author: Michael Brooks <mi...@michaelbrooks.ca>
Authored: Thu Aug 1 14:48:53 2013 -0700
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Thu Aug 1 14:48:53 2013 -0700
----------------------------------------------------------------------
docs/en/3.0.0/config_ref/index.md | 45 +-
.../accelerometer.getCurrentAcceleration.md | 2 +
.../cordova/accelerometer/accelerometer.md | 56 +-
.../3.0.0/cordova/camera/camera.getPicture.md | 3 +
docs/en/3.0.0/cordova/camera/camera.md | 74 +-
.../camera/parameter/CameraPopoverHandle.md | 1 +
.../cordova/camera/parameter/cameraOptions.md | 17 +
.../3.0.0/cordova/compass/compass.clearWatch.md | 3 +-
.../compass/compass.getCurrentHeading.md | 3 +-
docs/en/3.0.0/cordova/compass/compass.md | 44 +-
.../cordova/compass/compass.watchHeading.md | 1 +
.../compass/parameters/compassHeading.md | 10 +-
.../compass/parameters/compassOptions.md | 4 +
docs/en/3.0.0/cordova/connection/connection.md | 63 +-
.../3.0.0/cordova/connection/connection.type.md | 1 +
.../3.0.0/cordova/contacts/Contact/contact.md | 37 +
.../contacts/ContactAddress/contactaddress.md | 17 +
.../contacts/ContactField/contactfield.md | 5 +
.../ContactFindOptions/contactfindoptions.md | 1 +
.../cordova/contacts/ContactName/contactname.md | 10 +
.../ContactOrganization/contactorganization.md | 15 +-
.../3.0.0/cordova/contacts/contacts.create.md | 1 -
docs/en/3.0.0/cordova/contacts/contacts.find.md | 3 +
docs/en/3.0.0/cordova/contacts/contacts.md | 67 +-
.../contacts/parameters/contactFindOptions.md | 1 +
docs/en/3.0.0/cordova/device/device.md | 70 +-
docs/en/3.0.0/cordova/device/device.model.md | 1 +
docs/en/3.0.0/cordova/device/device.name.md | 2 +-
.../3.0.0/cordova/events/events.backbutton.md | 1 -
.../cordova/events/events.batterycritical.md | 1 +
.../3.0.0/cordova/events/events.batterylow.md | 1 +
.../cordova/events/events.batterystatus.md | 1 +
docs/en/3.0.0/cordova/events/events.md | 62 +-
docs/en/3.0.0/cordova/events/events.pause.md | 3 +-
.../file/directoryentry/directoryentry.md | 94 ++-
.../file/directoryreader/directoryreader.md | 1 +
docs/en/3.0.0/cordova/file/file.md | 94 ++-
.../3.0.0/cordova/file/fileentry/fileentry.md | 66 +-
docs/en/3.0.0/cordova/file/fileobj/fileobj.md | 5 +
.../3.0.0/cordova/file/filereader/filereader.md | 17 +-
.../3.0.0/cordova/file/filesystem/filesystem.md | 1 +
.../cordova/file/filetransfer/filetransfer.md | 39 +-
.../file/filetransfererror/filetransfererror.md | 3 +
.../file/fileuploadoptions/fileuploadoptions.md | 5 +
.../file/fileuploadresult/fileuploadresult.md | 2 +
.../3.0.0/cordova/file/filewriter/filewriter.md | 12 +
docs/en/3.0.0/cordova/file/flags/flags.md | 1 +
.../file/localfilesystem/localfilesystem.md | 2 +
.../geolocation/Coordinates/coordinates.md | 6 +
.../cordova/geolocation/Position/position.md | 1 +
.../geolocation/PositionError/positionError.md | 1 +
.../geolocation.getCurrentPosition.md | 2 +
.../en/3.0.0/cordova/geolocation/geolocation.md | 68 +-
.../geolocation/geolocation.watchPosition.md | 2 +
.../parameters/geolocation.options.md | 2 +
.../globalization.getCurrencyPattern.md | 5 +
.../globalization.getDatePattern.md | 6 +
.../globalization.getLocaleName.md | 2 +-
.../globalization.getNumberPattern.md | 9 +
.../globalization.getPreferredLanguage.md | 2 +-
.../cordova/globalization/globalization.md | 22 +-
.../globalization/globalization.stringToDate.md | 18 +-
.../3.0.0/cordova/inappbrowser/inappbrowser.md | 55 +-
.../3.0.0/cordova/inappbrowser/window.open.md | 6 +-
.../cordova/media/MediaError/mediaError.md | 1 +
.../3.0.0/cordova/media/capture/CaptureError.md | 4 +
.../cordova/media/capture/ConfigurationData.md | 2 +
.../en/3.0.0/cordova/media/capture/MediaFile.md | 4 +
.../cordova/media/capture/MediaFileData.md | 16 +
docs/en/3.0.0/cordova/media/capture/capture.md | 70 +-
.../3.0.0/cordova/media/capture/captureAudio.md | 2 +-
.../media/capture/captureAudioOptions.md | 1 +
.../3.0.0/cordova/media/capture/captureImage.md | 2 +-
.../3.0.0/cordova/media/capture/captureVideo.md | 2 +-
.../media/capture/captureVideoOptions.md | 1 +
.../cordova/media/media.getCurrentPosition.md | 6 +
docs/en/3.0.0/cordova/media/media.md | 80 +-
docs/en/3.0.0/cordova/media/media.setVolume.md | 1 -
.../en/3.0.0/cordova/media/media.startRecord.md | 2 +
.../cordova/notification/notification.alert.md | 3 +
.../cordova/notification/notification.beep.md | 3 +-
.../notification/notification.confirm.md | 3 +
.../3.0.0/cordova/notification/notification.md | 54 +-
.../cordova/notification/notification.prompt.md | 8 +-
.../cordova/splashscreen/splashscreen.hide.md | 2 +
.../3.0.0/cordova/splashscreen/splashscreen.md | 28 +-
.../cordova/splashscreen/splashscreen.show.md | 2 +
.../3.0.0/cordova/storage/database/database.md | 1 +
.../storage/localstorage/localstorage.md | 20 +-
.../3.0.0/cordova/storage/sqlerror/sqlerror.md | 1 +
.../storage/sqlresultset/sqlresultset.md | 2 +
docs/en/3.0.0/cordova/storage/storage.md | 57 +-
docs/en/3.0.0/guide/cli/index.md | 169 ++--
docs/en/3.0.0/guide/hybrid/plugins/index.md | 58 +-
docs/en/3.0.0/guide/overview/index.md | 98 ++-
docs/en/3.0.0/guide/platforms/android/config.md | 53 +-
docs/en/3.0.0/guide/platforms/android/index.md | 15 +-
docs/en/3.0.0/guide/platforms/android/plugin.md | 34 +-
docs/en/3.0.0/guide/platforms/android/tools.md | 1 +
.../3.0.0/guide/platforms/android/upgrading.md | 470 +++++++----
.../en/3.0.0/guide/platforms/android/webview.md | 13 +-
.../3.0.0/guide/platforms/blackberry/index.md | 105 +--
.../3.0.0/guide/platforms/blackberry/plugin.md | 24 +-
.../3.0.0/guide/platforms/blackberry/tools.md | 2 +-
.../guide/platforms/blackberry/upgrading.md | 437 ++++++----
.../3.0.0/guide/platforms/blackberry10/index.md | 115 ++-
.../guide/platforms/blackberry10/plugin.md | 42 +-
.../3.0.0/guide/platforms/blackberry10/tools.md | 27 +-
.../guide/platforms/blackberry10/upgrading.md | 453 +++++++----
docs/en/3.0.0/guide/platforms/ios/config.md | 108 ++-
docs/en/3.0.0/guide/platforms/ios/index.md | 4 +-
docs/en/3.0.0/guide/platforms/ios/plugin.md | 49 +-
docs/en/3.0.0/guide/platforms/ios/upgrading.md | 799 ++++++++++++-------
docs/en/3.0.0/guide/platforms/ios/webview.md | 92 ++-
docs/en/3.0.0/guide/platforms/tizen/index.md | 4 +
docs/en/3.0.0/guide/platforms/win8/index.md | 8 +-
docs/en/3.0.0/guide/platforms/win8/tools.md | 4 +-
docs/en/3.0.0/guide/platforms/win8/upgrading.md | 11 +-
docs/en/3.0.0/guide/platforms/wp7/index.md | 13 +-
docs/en/3.0.0/guide/platforms/wp8/index.md | 16 +-
docs/en/3.0.0/guide/platforms/wp8/plugin.md | 43 +-
docs/en/3.0.0/guide/platforms/wp8/tools.md | 4 +-
docs/en/3.0.0/guide/platforms/wp8/upgrading.md | 253 ++++--
docs/en/3.0.0/index.md | 2 +-
docs/en/3.0.0/plugin_ref/spec.md | 69 +-
125 files changed, 3391 insertions(+), 1757 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/config_ref/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/config_ref/index.md b/docs/en/3.0.0/config_ref/index.md
index 51af63d..311a0ec 100644
--- a/docs/en/3.0.0/config_ref/index.md
+++ b/docs/en/3.0.0/config_ref/index.md
@@ -19,24 +19,26 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Configuration Reference
-You can set various application configuration parameters using a platform-agnostic configuration file, `config.xml`.
-This file is based on the W3C [Packaged Web Apps (Widgets)](http://www.w3.org/TR/widgets/) specification.
-
-The location of the `config.xml` file is different depending on the platform. The contents, in general, are not.
-
-## Platform-Specific Properties
-
-As with any abstraction layer, Apache Cordova cannot be a perfect silver bullet. As such, some native and platform-specific
-properties, characteristics and behaviours are encapsulated as much as possible as `<preference>` elements inside the
-`config.xml` file. The following sub-sections linked to are guides which go into more details about these preferences.
+Many aspects of an application's behavior can be controlled with a
+platform-agnostic configuration file, `config.xml`, which is formatted
+based on the W3C's
+[Packaged Web Apps (Widgets)](http://www.w3.org/TR/widgets/)
+specification.
+
+For projects created with the Cordova CLI (described in The
+Command-line Interface), this file can be found in the top-level `www`
+directory. Using the CLI to build projects regenerates versions of
+this file in various subdirectories within `platforms`. For non-CLI
+projects, each platform-specific file serves as a source.
+
+While the location of the `config.xml` file may change depending on
+the platform, its contents generally do not. Some platform-specific
+features are also specified in the same configuration file. Details
+are listed below:
- iOS Configuration
- Android Configuration
- BlackBerry Configuration
-- Windows Phone 7 Configuration
-- Windows Phone 8 Configuration
-- Windows 8 Configuration
-- FirefoxOS Configuration
## config.xml Elements
@@ -49,22 +51,19 @@ An example:
<widget>
<preference name="MySetting" value="true" />
- <plugins>
- <plugin name="MyPlugin" value="MyPluginClass" />
- </plugins>
+ <feature name="MyPlugin" value="MyPluginClass" />
<access origin="*" />
<content src="index.html" />
</widget>
A list of supported elements across major platforms which are supported in Apache Cordova follow.
-### `<plugin>`
+### `<feature>`
These elements map to native APIs that the application accesses. At
-runtime, the Apache Cordova framework checks the `<plugin>` elements
-and maps them to native code to enable your Cordova application to
-access device APIs otherwise unavailable to typical web-based
-applications.
+runtime, the Apache Cordova framework maps `<feature>` elements to
+native code to enable your Cordova application to access device APIs
+otherwise unavailable to typical web-based applications.
### `<access>`
@@ -74,5 +73,5 @@ Domain Whitelist Guide for more information.
### `<content>`
This element defines your application's start page relative to the
-project's standard web assets root folder. This element is optional,
+project's standard web assets root directory. This element is optional,
the default is `index.html`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/3.0.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index 22cb2c8..c623b95 100644
--- a/docs/en/3.0.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/docs/en/3.0.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -108,5 +108,7 @@ iOS Quirks
-------------
- iOS doesn't recognize the concept of getting the current acceleration at any given point.
+
- You must watch the acceleration and capture the data at given time intervals.
+
- Thus, the `getCurrentAcceleration` function yields the last value reported from a `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/accelerometer/accelerometer.md b/docs/en/3.0.0/cordova/accelerometer/accelerometer.md
index 31d6012..820a021 100644
--- a/docs/en/3.0.0/cordova/accelerometer/accelerometer.md
+++ b/docs/en/3.0.0/cordova/accelerometer/accelerometer.md
@@ -41,42 +41,48 @@ Objects (Read-Only)
- Acceleration
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git
+ $ cordova plugin rm org.apache.cordova.core.device-motion
- <plugin name="Accelerometer" value="org.apache.cordova.AccelListener" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-### BlackBerry WebWorks
+* Android (in `app/res/xml/config.xml`)
-#### www/plugins.xml
+ <feature name="Accelerometer">
+ <param name="android-package" value="org.apache.cordova.AccelListener" />
+ </feature>
- <plugin name="Accelerometer" value="org.apache.cordova.accelerometer.Accelerometer" />
+* BlackBerry WebWorks
-#### www/config.xml
+ (in www/plugins.xml)
+ <feature name="Accelerometer">
+ <param name="blackberry-package" value="org.apache.cordova.accelerometer.Accelerometer" />
+ </feature>
- <feature id="blackberry.system" required="true" version="1.0.0.0" />
- <feature id="org.apache.cordova" required="true" version="1.0.0" />
+ (in www/config.xml)
+ <feature id="blackberry.system" required="true" version="1.0.0.0" />
+ <feature id="org.apache.cordova" required="true" version="1.0.0" />
-### iOS
+* iOS (in `config.xml`)
-#### config.xml
+ <feature name="Accelerometer">
+ <param name="ios-package" value="CDVAccelerometer" />
+ </feature>
- <plugin name="Accelerometer" value="CDVAccelerometer" />
+* Windows Phone (in `Properties/WPAppManifest.xml`)
-### Windows Phone
+ <Capabilities>
+ <Capability Name="ID_CAP_SENSORS" />
+ </Capabilities>
-#### Properties/WPAppManifest.xml
+ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
- <Capabilities>
- <Capability Name="ID_CAP_SENSORS" />
- </Capabilities>
-
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-
-### Tizen
-
- No permissions are required.
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/camera/camera.getPicture.md b/docs/en/3.0.0/cordova/camera/camera.getPicture.md
index c8f65bf..8e2f8cd 100644
--- a/docs/en/3.0.0/cordova/camera/camera.getPicture.md
+++ b/docs/en/3.0.0/cordova/camera/camera.getPicture.md
@@ -49,13 +49,16 @@ one of the following formats, depending on the specified
`cameraOptions`:
- A `String` containing the base64-encoded photo image.
+
- A `String` representing the image file location on local storage (default).
You can do whatever you want with the encoded image or URI, for
example:
- Render the image in an `<img>` tag, as in the example below
+
- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc.)
+
- Post the data to a remote server
__NOTE:__ Photo resolution on newer devices is quite good. Photos
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/camera/camera.md b/docs/en/3.0.0/cordova/camera/camera.md
index 9b100e4..3e944c8 100644
--- a/docs/en/3.0.0/cordova/camera/camera.md
+++ b/docs/en/3.0.0/cordova/camera/camera.md
@@ -30,55 +30,63 @@ Methods
- camera.getPicture
- camera.cleanup
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git
+ $ cordova plugin rm org.apache.cordova.core.camera
- <plugin name="Camera" value="org.apache.cordova.CameraLauncher" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-#### app/AndroidManifest
+* Android
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+ (in app/res/xml/config.xml)
+ <feature name="Camera">
+ <param name="android-package" value="org.apache.cordova.CameraLauncher" />
+ </feature>
-### BlackBerry WebWorks
+ (in app/AndroidManifest)
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-#### www/plugins.xml
+* BlackBerry WebWorks
- <plugin name="Camera" value="org.apache.cordova.camera.Camera" />
+ (in www/plugins.xml)
+ <feature name="Camera">
+ <param name="blackberry-package" value="org.apache.cordova.camera.Camera" />
+ </feature>
-#### www/config.xml
+ (in www/config.xml)
+ <feature id="blackberry.media.camera" />
- <feature id="blackberry.media.camera" />
+ <rim:permissions>
+ <rim:permit>use_camera</rim:permit>
+ </rim:permissions>
- <rim:permissions>
- <rim:permit>use_camera</rim:permit>
- </rim:permissions>
+* iOS (in `config.xml`)
-### iOS
+ <feature name="Camera">
+ <param name="ios-package" value="CDVCamera" />
+ </feature>
-#### config.xml
+* Windows Phone (in `Properties/WPAppManifest.xml`)
- <plugin name="Camera" value="CDVCamera" />
+ <Capabilities>
+ <Capability Name="ID_CAP_ISV_CAMERA" />
+ <Capability Name="ID_HW_FRONTCAMERA" />
+ </Capabilities>
-### Windows Phone
+ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-#### Properties/WPAppManifest.xml
+* Tizen (in `config.xml`)
- <Capabilities>
- <Capability Name="ID_CAP_ISV_CAMERA" />
- <Capability Name="ID_HW_FRONTCAMERA" />
- </Capabilities>
+ <feature name="http://tizen.org/api/application" required="true"/>
+ <feature name="http://tizen.org/api/application.launch" required="true"/>
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+ Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
-### Tizen
-
-#### config.xml
-
- <feature name="http://tizen.org/api/application" required="true"/>
- <feature name="http://tizen.org/api/application.launch" required="true"/>
-
-Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/camera/parameter/CameraPopoverHandle.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/camera/parameter/CameraPopoverHandle.md b/docs/en/3.0.0/cordova/camera/parameter/CameraPopoverHandle.md
index ff5a9dd..c8e07d2 100644
--- a/docs/en/3.0.0/cordova/camera/parameter/CameraPopoverHandle.md
+++ b/docs/en/3.0.0/cordova/camera/parameter/CameraPopoverHandle.md
@@ -38,6 +38,7 @@ setPosition
Set the position of the popover.
__Parameters:__
+
- `cameraPopoverOptions`: the `CameraPopoverOptions` that specify the new position
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/camera/parameter/cameraOptions.md b/docs/en/3.0.0/cordova/camera/parameter/cameraOptions.md
index a3a7542..f428459 100644
--- a/docs/en/3.0.0/cordova/camera/parameter/cameraOptions.md
+++ b/docs/en/3.0.0/cordova/camera/parameter/cameraOptions.md
@@ -63,6 +63,7 @@ Options
};
- __targetWidth__: Width in pixels to scale image. Must be used with __targetHeight__. Aspect ratio remains constant. _(Number)_
+
- __targetHeight__: Height in pixels to scale image. Must be used with __targetWidth__. Aspect ratio remains constant. _(Number)_
- __mediaType__: Set the type of media to select from. Only works when `PictureSourceType` is `PHOTOLIBRARY` or `SAVEDPHOTOALBUM`. Defined in `nagivator.camera.MediaType` _(Number)_
@@ -74,8 +75,11 @@ Options
};
- __correctOrientation__: Rotate the image to correct for the orientation of the device during capture. _(Boolean)_
+
- __saveToPhotoAlbum__: Save the image to the photo album on the device after capture. _(Boolean)_
+
- __popoverOptions__: iOS-only options that specify popover location in iPad. Defined in `CameraPopoverOptions`.
+
- __cameraDirection__: Choose the camera to use (front- or back-facing). Defined in `navigator.camera.Direction` _(Number)_
Camera.Direction = {
@@ -87,34 +91,47 @@ Android Quirks
--------------
- Ignores the `allowEdit` parameter.
+
- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
BlackBerry Quirks
-----------------
- Ignores the `quality` parameter.
+
- Ignores the `sourceType` parameter.
+
- Ignores the `allowEdit` parameter.
+
- Application must have key injection permissions to close the native Camera application after the user snaps the photo.
+
- Using large image sizes may result in the inability to encode images on later-model devices (e.g. Torch 9800) that feature high-resolution cameras.
+
- `Camera.MediaType` is not supported.
+
- Ignores the `correctOrientation` parameter.
+
- Ignores the `cameraDirection` parameter.
iOS Quirks
--------------
- Set `quality` below 50 to avoid memory errors on some devices.
+
- When using `destinationType.FILE_URI`, photos are saved in the application's temporary directory. You may delete the contents of this directory using the `navigator.fileMgr` APIs if storage space is a concern.
Tizen Quirks
--------------
+
- options not supported
+
- always returns a FILE URI
Windows Phone 7 and 8 Quirks
--------------
- Ignores the `allowEdit` parameter.
+
- Ignores the `correctOrientation` parameter.
+
- Ignores the `cameraDirection` parameter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/compass/compass.clearWatch.md b/docs/en/3.0.0/cordova/compass/compass.clearWatch.md
index dd70cc5..831ca87 100755
--- a/docs/en/3.0.0/cordova/compass/compass.clearWatch.md
+++ b/docs/en/3.0.0/cordova/compass/compass.clearWatch.md
@@ -30,9 +30,10 @@ Supported Platforms
-------------------
- Android
+- BlackBerry 10
- iOS
- Tizen
-- Windows Phone 7 and 8 ( if available in hardware )
+- Windows Phone 7 and 8 (if available in hardware)
- Windows 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/compass/compass.getCurrentHeading.md b/docs/en/3.0.0/cordova/compass/compass.getCurrentHeading.md
index 8ce3f5e..9678c66 100755
--- a/docs/en/3.0.0/cordova/compass/compass.getCurrentHeading.md
+++ b/docs/en/3.0.0/cordova/compass/compass.getCurrentHeading.md
@@ -38,9 +38,10 @@ Supported Platforms
-------------------
- Android
+- BlackBerry 10
- iOS
- Tizen
-- Windows Phone 7 and 8 ( if available in hardware )
+- Windows Phone 7 and 8 (if available in hardware)
- Windows 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/compass/compass.md b/docs/en/3.0.0/cordova/compass/compass.md
index 43ca2bc..fd59c2e 100755
--- a/docs/en/3.0.0/cordova/compass/compass.md
+++ b/docs/en/3.0.0/cordova/compass/compass.md
@@ -39,35 +39,37 @@ Arguments
- compassOptions
- compassHeading
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git
+ $ cordova plugin rm org.apache.cordova.core.device-orientation
- <plugin name="Compass" value="org.apache.cordova.CompassListener" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-### BlackBerry WebWorks
+* Android (in `app/res/xml/config.xml`)
- No permissions are required.
+ <feature name="Compass">
+ <param name="android-package" value="org.apache.cordova.CompassListener" />
+ </feature>
-### iOS
+* iOS (in `config.xml`)
-#### config.xml
+ <feature name="Compass">
+ <param name="ios-package" value="CDVLocation" />
+ </feature>
- <plugin name="Compass" value="CDVLocation" />
+* Windows Phone (in `Properties/WPAppManifest.xml`)
-### Windows Phone
+ <Capabilities>
+ <Capability Name="ID_CAP_SENSORS" />
+ </Capabilities>
-#### Properties/WPAppManifest.xml
+ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
- <Capabilities>
- <Capability Name="ID_CAP_SENSORS" />
- </Capabilities>
-
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-
-### Tizen
-
- No permissions are required.
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/compass/compass.watchHeading.md b/docs/en/3.0.0/cordova/compass/compass.watchHeading.md
index 5f2c8b0..f88c82d 100755
--- a/docs/en/3.0.0/cordova/compass/compass.watchHeading.md
+++ b/docs/en/3.0.0/cordova/compass/compass.watchHeading.md
@@ -44,6 +44,7 @@ Supported Platforms
-------------------
- Android
+- BlackBerry 10
- iOS
- Tizen
- Windows Phone 7 and 8 (if available in hardware)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/compass/parameters/compassHeading.md b/docs/en/3.0.0/cordova/compass/parameters/compassHeading.md
index 7e541b1..bcf1c25 100644
--- a/docs/en/3.0.0/cordova/compass/parameters/compassHeading.md
+++ b/docs/en/3.0.0/cordova/compass/parameters/compassHeading.md
@@ -25,9 +25,12 @@ A `CompassHeading` object is returned to the `compassSuccess` callback function.
Properties
----------
-- __magneticHeading__: The heading in degrees from 0 - 359.99 at a single moment in time. _(Number)_
-- __trueHeading__: The heading relative to the geographic North Pole in degrees 0 - 359.99 at a single moment in time. A negative value indicates that the true heading cannot be determined. _(Number)_
+- __magneticHeading__: The heading in degrees from 0-359.99 at a single moment in time. _(Number)_
+
+- __trueHeading__: The heading relative to the geographic North Pole in degrees 0-359.99 at a single moment in time. A negative value indicates that the true heading cannot be determined. _(Number)_
+
- __headingAccuracy__: The deviation in degrees between the reported heading and the true heading. _(Number)_
+
- __timestamp__: The time at which this heading was determined. _(milliseconds)_
Description
@@ -37,11 +40,14 @@ The `CompassHeading` object is returned to the `compassSuccess` callback functio
Android Quirks
--------------
+
- `trueHeading` is not supported, but reports the same value as `magneticHeading`
+
- `headingAccuracy` is always 0 because there is no difference between the `magneticHeading` and `trueHeading`.
iOS Quirks
----------
- `trueHeading` is only returned when location services are enabled via `navigator.geolocation.watchLocation()`
+
- For iOS 4 devices and above, heading factors in the device's current orientation, not in reference to its absolute position, for apps that supports that orientation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/compass/parameters/compassOptions.md b/docs/en/3.0.0/cordova/compass/parameters/compassOptions.md
index aed37ca..75f4922 100755
--- a/docs/en/3.0.0/cordova/compass/parameters/compassOptions.md
+++ b/docs/en/3.0.0/cordova/compass/parameters/compassOptions.md
@@ -26,16 +26,20 @@ Options
-------
- __frequency__: How often to retrieve the compass heading in milliseconds. _(Number)_ (Default: 100)
+
- __filter__: The change in degrees required to initiate a watchHeading success callback. _(Number)_
Android Quirks
______________
+
- `filter` is not supported.
Tizen Quirks
-----------
+
- `filter` is not supported.
Windows Phone 7 and 8 Quirks
--------------
+
- `filter` is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/connection/connection.md b/docs/en/3.0.0/cordova/connection/connection.md
index 8831dcf..f259d83 100644
--- a/docs/en/3.0.0/cordova/connection/connection.md
+++ b/docs/en/3.0.0/cordova/connection/connection.md
@@ -39,47 +39,56 @@ Constants
- Connection.CELL
- Connection.NONE
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git
+ $ cordova plugin rm org.apache.cordova.core.network-information
- <plugin name="NetworkStatus" value="org.apache.cordova.NetworkManager" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-#### app/AndroidManifest.xml
+* Android
- <uses-permission android:name="android.permission.INTERNET" />
- <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
- <uses-permission android:name="android.permission.READ_PHONE_STATE" />
+ (in app/res/xml/config.xml)
+ <feature name="NetworkStatus">
+ <param name="android-package" value="org.apache.cordova.NetworkManager" />
+ </feature>
-### BlackBerry WebWorks
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.INTERNET" />
+ <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+ <uses-permission android:name="android.permission.READ_PHONE_STATE" />
-#### www/plugins.xml
+* BlackBerry WebWorks
- <plugin name="Network Status" value="org.apache.cordova.network.Network" />
+ (in www/plugins.xml)
+ <feature name="Network Status">
+ <param name="blackberry-package" value="org.apache.cordova.network.Network" />
+ </feature>
-### iOS
+* iOS (in `config.xml`)
-#### config.xml
+ <feature name="NetworkStatus">
+ <param name="ios-package" value="CDVConnection" />
+ </feature>
- <plugin name="NetworkStatus" value="CDVConnection" />
+* Windows Phone (in `Properties/WPAppManifest.xml`)
-### Windows Phone
+ <Capabilities>
+ <Capability Name="ID_CAP_NETWORKING" />
+ </Capabilities>
-#### Properties/WPAppManifest.xml
+ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
- <Capabilities>
- <Capability Name="ID_CAP_NETWORKING" />
- </Capabilities>
+* Tizen (in `config.xml`)
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+ <feature name="http://tizen.org/api/systeminfo" required="true"/>
-### Tizen
+ Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
-#### config.xml
-
- <feature name="http://tizen.org/api/systeminfo" required="true"/>
-
-Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/connection/connection.type.md b/docs/en/3.0.0/cordova/connection/connection.type.md
index 5a51756..c6de634 100644
--- a/docs/en/3.0.0/cordova/connection/connection.type.md
+++ b/docs/en/3.0.0/cordova/connection/connection.type.md
@@ -122,6 +122,7 @@ Windows Phone Quirks
--------------------
- When running in the emulator, always detects `navigator.connection.type` as `Connection.UNKNOWN`.
+
- Windows Phone cannot detect the type of cellular network connection.
- `navigator.connection.type` is set to `Connection.CELL` for all cellular data.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/Contact/contact.md b/docs/en/3.0.0/cordova/contacts/Contact/contact.md
index 574912e..9e953f4 100644
--- a/docs/en/3.0.0/cordova/contacts/Contact/contact.md
+++ b/docs/en/3.0.0/cordova/contacts/Contact/contact.md
@@ -26,25 +26,40 @@ Properties
----------
- __id__: A globally unique identifier. _(DOMString)_
+
- __displayName__: The name of this Contact, suitable for display to end-users. _(DOMString)_
+
- __name__: An object containing all components of a persons name. _(ContactName)_
+
- __nickname__: A casual name by which to address the contact. _(DOMString)_
+
- __phoneNumbers__: An array of all the contact's phone numbers. _(ContactField[])_
+
- __emails__: An array of all the contact's email addresses. _(ContactField[])_
+
- __addresses__: An array of all the contact's addresses. _(ContactAddress[])_
+
- __ims__: An array of all the contact's IM addresses. _(ContactField[])_
+
- __organizations__: An array of all the contact's organizations. _(ContactOrganization[])_
+
- __birthday__: The birthday of the contact. _(Date)_
+
- __note__: A note about the contact. _(DOMString)_
+
- __photos__: An array of the contact's photos. _(ContactField[])_
+
- __categories__: An array of all the user-defined categories associated with the contact. _(ContactField[])_
+
- __urls__: An array of web pages associated with the contact. _(ContactField[])_
Methods
-------
- __clone__: Returns a new `Contact` object that is a deep copy of the calling object, with the `id` property set to `null`.
+
- __remove__: Removes the contact from the device contacts database, otherwise executes an error callback with a `ContactError` object.
+
- __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists.
Details
@@ -197,36 +212,58 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
- __id__: Supported. Assigned by the device when saving the contact.
+
- __displayName__: Supported. Stored in BlackBerry __user1__ field.
+
- __nickname__: Not supported, returning `null`.
+
- __phoneNumbers__: Partially supported. Phone numbers are stored in BlackBerry fields __homePhone1__ and __homePhone2__ if _type_ is 'home', __workPhone1__ and __workPhone2__ if _type_ is 'work', __mobilePhone__ if _type_ is 'mobile', __faxPhone__ if _type_ is 'fax', __pagerPhone__ if _type_ is 'pager', and __otherPhone__ if _type_ is none of the above.
+
- __emails__: Partially supported. The first three email addresses are stored in the BlackBerry __email1__, __email2__, and __email3__ fields, respectively.
+
- __addresses__: Partially supported. The first and second addresses are stored in the BlackBerry __homeAddress__ and __workAddress__ fields, respectively.
+
- __ims__: Not supported, returning `null`.
+
- __organizations__: Partially supported. The __name__ and __title__ of the first organization are stored in the BlackBerry __company__ and __title__ fields, respectively.
+
- __photos__: Partially supported. A single thumbnail-sized photo is supported. To set a contact's photo, pass in a either a base64-encoded image, or a URL pointing to the image. The image is scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a base64-encoded image.
+
- __categories__: Partially supported. Only _Business_ and _Personal_ categories are supported.
+
- __urls__: Partially supported. The first URL is stored in BlackBerry __webpage__ field.
iOS Quirks
----------
- __displayName__: Not supported on iOS, returning `null` unless there is no `ContactName` specified, in which case it returns the composite name, __nickname__ or `""`, respectively.
+
- __birthday__: Must be input as a JavaScript `Date` object, the same way it is returned.
+
- __photos__: Returns a File URL to the image, which is stored in the application's temporary directory. Contents of the temporary directory are removed when the application exits.
+
- __categories__: This property is currently not supported, returning `null`.
Windows Phone 7 and 8 Quirks
-----------
- __displayName__: When creating a contact, the value provided for the display name parameter differs from the display name retrieved when finding the contact.
+
- __urls__: When creating a contact, users can input and save more than one web address, but only one is available is available when searching the contact.
+
- __phoneNumbers__: The _pref_ option is not supported. The _type_ is not supported in a _find_ operation. Only one `phoneNumber` is allowed for each _type_.
+
- __emails__: The _pref_ option is not supported. Home and personal references same email entry. Only one entry is allowed for each _type_.
+
- __addresses__: Supports only work, and home/personal _type_. The home and personal _type_ reference the same address entry. Only one entry is allowed for each _type_.
+
- __organizations__: Only one is allowed, and does not support the _pref_, _type_, and _department_ attributes.
+
- __note__: Not supported, returning `null`.
+
- __ims__: Not supported, returning `null`.
+
- __birthdays__: Not supported, returning `null`.
+
- __categories__: Not supported, returning `null`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/ContactAddress/contactaddress.md b/docs/en/3.0.0/cordova/contacts/ContactAddress/contactaddress.md
index 0258c55..f60ae07 100644
--- a/docs/en/3.0.0/cordova/contacts/ContactAddress/contactaddress.md
+++ b/docs/en/3.0.0/cordova/contacts/ContactAddress/contactaddress.md
@@ -26,12 +26,19 @@ Properties
----------
- __pref__: Set to `true` if this `ContactAddress` contains the user's preferred value. _(boolean)_
+
- __type__: A string indicating what type of field this is, _home_ for example. _(DOMString)_
+
- __formatted__: The full address formatted for display. _(DOMString)_
+
- __streetAddress__: The full street address. _(DOMString)_
+
- __locality__: The city or locality. _(DOMString)_
+
- __region__: The state or region. _(DOMString)_
+
- __postalCode__: The zip code or postal code. _(DOMString)_
+
- __country__: The country name. _(DOMString)_
Details
@@ -144,17 +151,27 @@ Android 2.X Quirks
BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
+
- __pref__: Not supported on BlackBerry devices, returning `false`.
+
- __type__: Partially supported. Only one each of _Work_ and _Home_ type addresses can be stored per contact.
+
- __formatted__: Partially supported. Returns a concatenation of all BlackBerry address fields.
+
- __streetAddress__: Supported. Returns a concatenation of BlackBerry __address1__ and __address2__ address fields.
+
- __locality__: Supported. Stored in BlackBerry __city__ address field.
+
- __region__: Supported. Stored in BlackBerry __stateProvince__ address field.
+
- __postalCode__: Supported. Stored in BlackBerry __zipPostal__ address field.
+
- __country__: Supported.
iOS Quirks
----------
+
- __pref__: Not supported on iOS devices, returning `false`.
+
- __formatted__: Currently not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/ContactField/contactfield.md b/docs/en/3.0.0/cordova/contacts/ContactField/contactfield.md
index 2bb0f38..6507146 100644
--- a/docs/en/3.0.0/cordova/contacts/ContactField/contactfield.md
+++ b/docs/en/3.0.0/cordova/contacts/ContactField/contactfield.md
@@ -28,7 +28,9 @@ Properties
----------
- __type__: A string that indicates what type of field this is, _home_ for example. _(DOMString)_
+
- __value__: The value of the field, such as a phone number or email address. _(DOMString)_
+
- __pref__: Set to `true` if this `ContactField` contains the user's preferred value. _(boolean)_
Details
@@ -150,10 +152,13 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
- __type__: Partially supported. Used for phone numbers.
+
- __value__: Supported.
+
- __pref__: Not supported, returning `false`.
iOS Quirks
-----------
+
- __pref__: Not supported, returning `false`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/3.0.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
index 5a027f5..7cd76dc 100644
--- a/docs/en/3.0.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/docs/en/3.0.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -26,6 +26,7 @@ Properties
----------
- __filter__: The search string used to find contacts. _(DOMString)_ (Default: `""`)
+
- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: false)
Supported Platforms
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/ContactName/contactname.md b/docs/en/3.0.0/cordova/contacts/ContactName/contactname.md
index 85751d9..9dc6c70 100644
--- a/docs/en/3.0.0/cordova/contacts/ContactName/contactname.md
+++ b/docs/en/3.0.0/cordova/contacts/ContactName/contactname.md
@@ -26,10 +26,15 @@ Properties
----------
- __formatted__: The complete name of the contact. _(DOMString)_
+
- __familyName__: The contact's family name. _(DOMString)_
+
- __givenName__: The contact's given name. _(DOMString)_
+
- __middleName__: The contact's middle name. _(DOMString)_
+
- __honorificPrefix__: The contact's prefix (example _Mr._ or _Dr._) _(DOMString)_
+
- __honorificSuffix__: The contact's suffix (example _Esq._). _(DOMString)_
Details
@@ -129,10 +134,15 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
- __formatted__: Partially supported. Returns a concatenation of BlackBerry __firstName__ and __lastName__ fields.
+
- __familyName__: Supported. Stored in BlackBerry __lastName__ field.
+
- __givenName__: Supported. Stored in BlackBerry __firstName__ field.
+
- __middleName__: Not supported, returning `null`.
+
- __honorificPrefix__: Not supported, returning `null`.
+
- __honorificSuffix__: Not supported, returning `null`.
iOS Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/ContactOrganization/contactorganization.md b/docs/en/3.0.0/cordova/contacts/ContactOrganization/contactorganization.md
index 0e2dba7..76f7b86 100644
--- a/docs/en/3.0.0/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/docs/en/3.0.0/cordova/contacts/ContactOrganization/contactorganization.md
@@ -26,9 +26,13 @@ Properties
----------
- __pref__: Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_
+
- __type__: A string that indicates what type of field this is, _home_ for example. _(DOMString)
+
- __name__: The name of the organization. _(DOMString)_
+
- __department__: The department the contract works for. _(DOMString)_
+
- __title__: The contact's title at the organization. _(DOMString)_
Details
@@ -123,7 +127,6 @@ Full Example
</body>
</html>
-
Android 2.X Quirks
------------------
@@ -131,17 +134,27 @@ Android 2.X Quirks
BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
+
- __pref__: Not supported by BlackBerry devices, returning `false`.
+
- __type__: Not supported by BlackBerry devices, returning `null`.
+
- __name__: Partially supported. The first organization name is stored in the BlackBerry __company__ field.
+
- __department__: Not supported, returning `null`.
+
- __title__: Partially supported. The first organization title is stored in the BlackBerry __jobTitle__ field.
iOS Quirks
-----------
+
- __pref__: Not supported on iOS devices, returning `false`.
+
- __type__: Not supported on iOS devices, returning `null`.
+
- __name__: Partially supported. The first organization name is stored in the iOS __kABPersonOrganizationProperty__ field.
+
- __department__: Partially supported. The first department name is stored in the iOS __kABPersonDepartmentProperty__ field.
+
- __title__: Partially supported. The first title is stored in the iOS __kABPersonJobTitleProperty__ field.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/contacts.create.md b/docs/en/3.0.0/cordova/contacts/contacts.create.md
index 93be1aa..aab67d3 100644
--- a/docs/en/3.0.0/cordova/contacts/contacts.create.md
+++ b/docs/en/3.0.0/cordova/contacts/contacts.create.md
@@ -68,7 +68,6 @@ Full Example
console.log("The contact, " + myContact.displayName + ", note: " + myContact.note);
}
-
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/contacts.find.md b/docs/en/3.0.0/cordova/contacts/contacts.find.md
index 9976f46..ed0129e 100644
--- a/docs/en/3.0.0/cordova/contacts/contacts.find.md
+++ b/docs/en/3.0.0/cordova/contacts/contacts.find.md
@@ -50,8 +50,11 @@ Parameters
----------
- __contactFields__: Contact fields to use as a search qualifier. The resulting `Contact` object only features values for these fields. _(DOMString[])_ [Required]
+
- __contactSuccess__: Success callback function invoked with the contacts returned from the database. [Required]
+
- __contactError__: Error callback function, invoked when an error occurs. [Optional]
+
- __contactFindOptions__: Search options to filter contacts. [Optional]
Supported Platforms
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/contacts.md b/docs/en/3.0.0/cordova/contacts/contacts.md
index ec50fd7..9bfb848 100644
--- a/docs/en/3.0.0/cordova/contacts/contacts.md
+++ b/docs/en/3.0.0/cordova/contacts/contacts.md
@@ -49,46 +49,57 @@ Objects
- ContactFindOptions
- ContactError
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git
+ $ cordova plugin rm org.apache.cordova.core.contacts
- <plugin name="Contacts" value="org.apache.cordova.ContactManager" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-#### app/AndroidManifest.xml
+* Android
- <uses-permission android:name="android.permission.GET_ACCOUNTS" />
- <uses-permission android:name="android.permission.READ_CONTACTS" />
- <uses-permission android:name="android.permission.WRITE_CONTACTS" />
+ (in app/res/xml/config.xml)
+ <feature name="Contacts">
+ <param name="android-package" value="org.apache.cordova.ContactManager" />
+ </feature>
-### BlackBerry WebWorks
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.GET_ACCOUNTS" />
+ <uses-permission android:name="android.permission.READ_CONTACTS" />
+ <uses-permission android:name="android.permission.WRITE_CONTACTS" />
-#### www/plugins.xml
+* BlackBerry WebWorks
- <plugin name="Contact" value="org.apache.cordova.pim.Contact" />
+ (in www/plugins.xml)
+ <feature name="Contact">
+ <param name="blackberry-package" value="org.apache.cordova.pim.Contact" />
+ </feature>
-#### www/config.xml
+ (in www/config.xml)
+ <feature id="blackberry.find" required="true" version="1.0.0.0" />
+ <feature id="blackberry.identity" required="true" version="1.0.0.0" />
+ <feature id="blackberry.pim.Address" required="true" version="1.0.0.0" />
+ <feature id="blackberry.pim.Contact" required="true" version="1.0.0.0" />
- <feature id="blackberry.find" required="true" version="1.0.0.0" />
- <feature id="blackberry.identity" required="true" version="1.0.0.0" />
- <feature id="blackberry.pim.Address" required="true" version="1.0.0.0" />
- <feature id="blackberry.pim.Contact" required="true" version="1.0.0.0" />
+* iOS (in `config.xml`)
-### iOS
+ <feature name="Contacts">
+ <param name="ios-package" value="CDVContacts" />
+ </feature>
-#### config.xml
+* Windows Phone
- <plugin name="Contacts" value="CDVContacts" />
+ (in Properties/WPAppManifest.xml)
+ <Capabilities>
+ <Capability Name="ID_CAP_CONTACTS" />
+ </Capabilities>
-### Windows Phone
+ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-#### Properties/WPAppManifest.xml
-
- <Capabilities>
- <Capability Name="ID_CAP_CONTACTS" />
- </Capabilities>
-
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/parameters/contactFindOptions.md b/docs/en/3.0.0/cordova/contacts/parameters/contactFindOptions.md
index 758531c..65ef9d7 100644
--- a/docs/en/3.0.0/cordova/contacts/parameters/contactFindOptions.md
+++ b/docs/en/3.0.0/cordova/contacts/parameters/contactFindOptions.md
@@ -32,4 +32,5 @@ Options
-------
- __filter__: The search string used to filter contacts. _(DOMString)_ (Default: `""`)
+
- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: `false`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/device/device.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/device/device.md b/docs/en/3.0.0/cordova/device/device.md
index 38abb0c..0c9e5f0 100644
--- a/docs/en/3.0.0/cordova/device/device.md
+++ b/docs/en/3.0.0/cordova/device/device.md
@@ -41,52 +41,56 @@ Since `device` is assigned to the `window` object, it is implicitly in the globa
var phoneName = window.device.name;
var phoneName = device.name;
-Permissions
------------
+## Accessing the Feature
-### Android
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
-#### app/res/xml/config.xml
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git
+ $ cordova plugin rm org.apache.cordova.core.device
- <plugin name="Device" value="org.apache.cordova.Device" />
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
-#### app/AndroidManifest.xml
+* Android
- <uses-permission android:name="android.permission.READ_PHONE_STATE" />
+ (in app/res/xml/config.xml)
+ <feature name="Device">
+ <param name="android-package" value="org.apache.cordova.Device" />
+ </feature>
-### BlackBerry WebWorks
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.READ_PHONE_STATE" />
-#### www/plugins.xml
+* BlackBerry WebWorks
- <plugin name="Device" value="org.apache.cordova.device.Device" />
+ (in www/plugins.xml)
+ <feature name="Device">
+ <param name="blackberry-package" value="org.apache.cordova.device.Device" />
+ </feature>
-#### www/config.xml
+ (in www/config.xml)
+ <feature id="blackberry.app" required="true" version="1.0.0.0" />
+ <rim:permissions>
+ <rim:permit>read_device_identifying_information</rim:permit>
+ </rim:permissions>
- <feature id="blackberry.app" required="true" version="1.0.0.0" />
- <rim:permissions>
- <rim:permit>read_device_identifying_information</rim:permit>
- </rim:permissions>
+* Windows Phone (in `Properties/WPAppManifest.xml`)
-### iOS
+ <Capabilities>
+ <Capability Name="ID_CAP_WEBBROWSERCOMPONENT" />
+ <Capability Name="ID_CAP_IDENTITY_DEVICE" />
+ <Capability Name="ID_CAP_IDENTITY_USER" />
+ </Capabilities>
- No permissions are required.
+ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-### Windows Phone
+* Tizen (in `config.xml`)
-#### Properties/WPAppManifest.xml
+ <feature name="http://tizen.org/api/systeminfo" required="true"/>
- <Capabilities>
- <Capability Name="ID_CAP_WEBBROWSERCOMPONENT" />
- <Capability Name="ID_CAP_IDENTITY_DEVICE" />
- <Capability Name="ID_CAP_IDENTITY_USER" />
- </Capabilities>
+ Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-
-### Tizen
-
-#### config.xml
-
- <feature name="http://tizen.org/api/systeminfo" required="true"/>
-
-Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/device/device.model.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/device/device.model.md b/docs/en/3.0.0/cordova/device/device.model.md
index 9ebd1d9..6073fa4 100644
--- a/docs/en/3.0.0/cordova/device/device.model.md
+++ b/docs/en/3.0.0/cordova/device/device.model.md
@@ -92,6 +92,7 @@ Android Quirks
Tizen Quirks
-----------
+
- Returns the device model assigned by the vendor, for example, `TIZEN`
Windows Phone 7 and 8 Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/device/device.name.md b/docs/en/3.0.0/cordova/device/device.name.md
index 1f75f27..73a9fe4 100644
--- a/docs/en/3.0.0/cordova/device/device.name.md
+++ b/docs/en/3.0.0/cordova/device/device.name.md
@@ -97,7 +97,7 @@ Windows Phone 7 and 8 Quirks
- Returns the device model specified by the manufacturer. For example, the Samsung Focus returns `SGH-i917`.
-
Tizen Quirks
-----------
+
- Returns the device model assigned by the vendor, for example, `TIZEN`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/events/events.backbutton.md b/docs/en/3.0.0/cordova/events/events.backbutton.md
index ce99243..346ef95 100644
--- a/docs/en/3.0.0/cordova/events/events.backbutton.md
+++ b/docs/en/3.0.0/cordova/events/events.backbutton.md
@@ -60,7 +60,6 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
-
// Wait for device API libraries to load
//
function onLoad() {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/events/events.batterycritical.md b/docs/en/3.0.0/cordova/events/events.batterycritical.md
index ff79908..c229ec0 100644
--- a/docs/en/3.0.0/cordova/events/events.batterycritical.md
+++ b/docs/en/3.0.0/cordova/events/events.batterycritical.md
@@ -35,6 +35,7 @@ The `batterycritical` handler is passed an object that contains two
properties:
- __level__: The percentage of battery charge (0-100). _(Number)_
+
- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
Applications typically should use `window.addEventListener` to attach
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/events/events.batterylow.md b/docs/en/3.0.0/cordova/events/events.batterylow.md
index 5147e05..24af3b6 100644
--- a/docs/en/3.0.0/cordova/events/events.batterylow.md
+++ b/docs/en/3.0.0/cordova/events/events.batterylow.md
@@ -34,6 +34,7 @@ The `batterylow` handler is passed an object that contains two
properties:
- __level__: The percentage of battery charge (0-100). _(Number)_
+
- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
Applications typically should use `document.addEventListener` to
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/events/events.batterystatus.md b/docs/en/3.0.0/cordova/events/events.batterystatus.md
index 7904f2e..2d38a20 100644
--- a/docs/en/3.0.0/cordova/events/events.batterystatus.md
+++ b/docs/en/3.0.0/cordova/events/events.batterystatus.md
@@ -34,6 +34,7 @@ The battery status handler is passed an object that contains two
properties:
- __level__: The percentage of battery charge (0-100). _(Number)_
+
- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
Applications typically should use `window.addEventListener` to
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/events/events.md b/docs/en/3.0.0/cordova/events/events.md
index bdecd16..e159ba8 100644
--- a/docs/en/3.0.0/cordova/events/events.md
+++ b/docs/en/3.0.0/cordova/events/events.md
@@ -41,45 +41,53 @@ Event Types
- volumedownbutton
- volumeupbutton
-Permissions
------------
-
-### Android
-
-#### app/res/xml/config.xml
-
- <plugin name="Battery" value="org.apache.cordova.BatteryListener" />
-
-#### app/AndroidManifest.xml
+## Accessing the Feature
- <uses-permission android:name="android.permission.BROADCAST_STICKY" />
+As of version 3.0, Cordova implements battery status and other
+device-level APIs as _plugins_. Access to all other events not related
+to battery status are enabled by default. Use the CLI's `plugin`
+command, described in The Command-line Interface, to enable or disable
+battery events:
-### BlackBerry WebWorks
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git
+ $ cordova plugin rm org.apache.cordova.core.battery-status
-#### www/plugins.xml
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
- <plugin name="Battery" value="org.apache.cordova.battery.Battery" />
+* Android
-#### www/config.xml
+ (in app/res/xml/config.xml)
+ <feature name="Battery">
+ <param name="android-package" value="org.apache.cordova.BatteryListener" />
+ </feature>
- <feature id="blackberry.app" required="true" version="1.0.0.0" />
- <feature id="blackberry.app.event" required="true" version="1.0.0.0" />
- <feature id="blackberry.system.event" required="true" version="1.0.0.0" />
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.BROADCAST_STICKY" />
-### iOS
+* BlackBerry WebWorks
-#### config.xml
+ (in www/plugins.xml)
+ <feature name="Battery">
+ <param name="blackberry-package" value="org.apache.cordova.battery.Battery" />
+ </feature>
- <plugin name="Battery" value="CDVBattery" />
+ (in www/config.xml)
+ <feature id="blackberry.app" required="true" version="1.0.0.0" />
+ <feature id="blackberry.app.event" required="true" version="1.0.0.0" />
+ <feature id="blackberry.system.event" required="true" version="1.0.0.0" />
-### Windows Phone
+* iOS (in `config.xml`)
- No permissions are required.
+ <feature name="Battery">
+ <param name="ios-package" value="CDVBattery" />
+ </feature>
-### Tizen
+* Tizen (in `config.xml`)
-#### config.xml
+ <feature name="http://tizen.org/api/systeminfo" required="true"/>
- <feature name="http://tizen.org/api/systeminfo" required="true"/>
+ Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
-Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/events/events.pause.md b/docs/en/3.0.0/cordova/events/events.pause.md
index 2559e89..3cf7e30 100644
--- a/docs/en/3.0.0/cordova/events/events.pause.md
+++ b/docs/en/3.0.0/cordova/events/events.pause.md
@@ -27,7 +27,6 @@ The event fires when an application is put into the background.
Details
-------
-
The `pause` event fires when the native platform puts the application
into the background, typically when the user switches to a different
application.
@@ -91,7 +90,7 @@ iOS Quirks
--------------------------
In the `pause` handler, any calls to the Cordova API or to native
-plug-ins that go through Objective-C do not work, along with any
+plugins that go through Objective-C do not work, along with any
interactive calls, such as alerts or `console.log()`. They are only
processed when the app resumes, on the next run loop.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/directoryentry/directoryentry.md b/docs/en/3.0.0/cordova/file/directoryentry/directoryentry.md
index e21aa5f..cb4c6e6 100644
--- a/docs/en/3.0.0/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/3.0.0/cordova/file/directoryentry/directoryentry.md
@@ -28,8 +28,11 @@ Properties
----------
- __isFile__: Always false. _(boolean)_
+
- __isDirectory__: Always true. _(boolean)_
+
- __name__: The name of the `DirectoryEntry`, excluding the path leading to it. _(DOMString)_
+
- __fullPath__: The full absolute path from the root to the `DirectoryEntry`. _(DOMString)_
__NOTE:__ The following attribute is defined by the W3C specification,
@@ -43,15 +46,25 @@ Methods
The following methods can be invoked on a `DirectoryEntry` object:
- __getMetadata__: Look up metadata about a directory.
+
- __setMetadata__: Set metadata on a directory.
+
- __moveTo__: Move a directory to a different location on the file system.
+
- __copyTo__: Copy a directory to a different location on the file system.
+
- __toURL__: Return a URL to help locate a directory.
+
- __remove__: Delete a directory. The directory must be empty.
+
- __getParent__: Look up the parent directory.
+
- __createReader__: Create a new `DirectoryReader` that can read entries from a directory.
+
- __getDirectory__: Create or look up a directory.
+
- __getFile__: Create or look up a file.
+
- __removeRecursively__: Delete a directory and all of its contents.
Supported Platforms
@@ -71,6 +84,7 @@ Look up metadata about a directory.
__Parameters:__
- __successCallback__: A callback function to execute with a `Metadata` object. _(Function)_
+
- __errorCallback__: A callback function to execute if an error occurs when retrieving the `Metadata`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -89,13 +103,15 @@ __Quick Example__
setMetadata
----------------
-Set metadata on a directory.
-__Currently works only on iOS.__ - this will set the extended attributes of a directory.
+Sets a directory's extended attributes, or metadata. _Currently works
+only on iOS._
__Parameters:__
- __successCallback__: A callback that executes when the metadata is successfully set. _(Function)_
+
- __errorCallback__: A callback that executes when the metadata fails to be set. _(Function)_
+
- __metadataObject__: An object that contains the metadata's keys and values. _(Object)_
__Quick Example__
@@ -119,31 +135,31 @@ __Quick Example__
function setFolderMetadata(localFileSystem, subFolder, metadataKey, metadataValue)
{
- var onSetMetadataWin = function() {
- console.log("success setting metadata")
- }
+ var onSetMetadataWin = function() {
+ console.log("success setting metadata")
+ }
var onSetMetadataFail = function() {
- console.log("error setting metadata")
+ console.log("error setting metadata")
}
- var onGetDirectoryWin = function(parent) {
- var data = {};
- data[metadataKey] = metadataValue;
- parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
- }
- var onGetDirectoryFail = function() {
- console.log("error getting dir")
- }
+ var onGetDirectoryWin = function(parent) {
+ var data = {};
+ data[metadataKey] = metadataValue;
+ parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
+ }
+ var onGetDirectoryFail = function() {
+ console.log("error getting dir")
+ }
- var onFSWin = function(fileSystem) {
- fileSystem.root.getDirectory(subFolder, {create: true, exclusive: false}, onGetDirectoryWin, onGetDirectoryFail);
- }
+ var onFSWin = function(fileSystem) {
+ fileSystem.root.getDirectory(subFolder, {create: true, exclusive: false}, onGetDirectoryWin, onGetDirectoryFail);
+ }
- var onFSFail = function(evt) {
- console.log(evt.target.error.code);
- }
+ var onFSFail = function(evt) {
+ console.log(evt.target.error.code);
+ }
- window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
+ window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
}
setFolderMetadata(LocalFileSystem.PERSISTENT, "Backups", "com.apple.MobileBackup", 1);
@@ -154,8 +170,11 @@ moveTo
Move a directory to a different location on the file system. An error results if the app attempts to:
- move a directory inside itself or to any child at any depth.
+
- move a directory into its parent if a name different from its current directory is not provided.
+
- move a directory to a path occupied by a file.
+
- move a directory to a path occupied by a directory that is not empty.
Moving a directory on top of an existing empty directory attempts to
@@ -164,8 +183,11 @@ delete and replace that directory.
__Parameters:__
- __parent__: The parent directory to which to move the directory. _(DirectoryEntry)_
+
- __newName__: The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
+
- __successCallback__: A callback that executes with the `DirectoryEntry` object for the new directory. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to move the directory. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -178,7 +200,7 @@ __Quick Example__
alert(error.code);
}
- function moveDir(entry) {
+ function moveDir(entry) {
var parent = document.getElementById('parent').value,
parentName = parent.substring(parent.lastIndexOf('/')+1),
newName = document.getElementById('newName').value,
@@ -194,6 +216,7 @@ copyTo
Copy a directory to a different location on the file system. An error results if the app attempts to:
- copy a directory inside itself at any depth.
+
- copy a directory into its parent if a name different from its current directory is not provided.
Directory copies are always recursive, and copy all contents of the directory.
@@ -201,21 +224,24 @@ Directory copies are always recursive, and copy all contents of the directory.
__Parameters:__
- __parent__: The parent directory to which to copy the directory. _(DirectoryEntry)_
+
- __newName__: The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
+
- __successCallback__: A callback that executes with the `DirectoryEntry` object for the new directory. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to copy the underlying directory. Invoked with a `FileError` object. _(Function)_
__Quick Example__
- function win(entry) {
- console.log("New Path: " + entry.fullPath);
- }
+ function win(entry) {
+ console.log("New Path: " + entry.fullPath);
+ }
- function fail(error) {
- alert(error.code);
- }
+ function fail(error) {
+ alert(error.code);
+ }
- function copyDir(entry) {
+ function copyDir(entry) {
var parent = document.getElementById('parent').value,
parentName = parent.substring(parent.lastIndexOf('/')+1),
newName = document.getElementById('newName').value,
@@ -242,11 +268,13 @@ remove
Deletes a directory. An error results if the app attempts to:
- delete a directory that is not empty.
+
- delete the root directory of a filesystem.
__Parameters:__
- __successCallback__: A callback that executes after the directory is deleted. Invoked with no parameters. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to delete the directory. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -270,6 +298,7 @@ Look up the parent `DirectoryEntry` containing the directory.
__Parameters:__
- __successCallback__: A callback that is passed the directory's parent `DirectoryEntry`. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to retrieve the parent `DirectoryEntry`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -305,8 +334,11 @@ Creates or looks up an existing directory. An error results if the app attempts
__Parameters:__
- __path__: The path to the directory to be looked up or created. Either an absolute path, or a relative path from this `DirectoryEntry`. _(DOMString)_
+
- __options__: Options to specify whether the directory is to be created if it doesn't exist. _(Flags)_
+
- __successCallback__: A callback that executes with a `DirectoryEntry` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when creating or looking up the directory. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -332,8 +364,11 @@ Creates or looks up a file. An error results if the app attempts to:
__Parameters:__
- __path__: The path to the file to be looked up or created. Either an absolute path, or a relative path from this `DirectoryEntry`. _(DOMString)_
+
- __options__: Options to specify whether the file is created if it doesn't exist. _(Flags)_
+
- __successCallback__: A callback that is passed a `FileEntry` object. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when creating or looking up the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -361,6 +396,7 @@ be deleted. An error results if the app attempts to:
__Parameters:__
- __successCallback__: A callback that executes after the `DirectoryEntry` has been deleted. Invoked with no parameters. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when attempting to delete the `DirectoryEntry`. Invoked with a `FileError` object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/directoryreader/directoryreader.md b/docs/en/3.0.0/cordova/file/directoryreader/directoryreader.md
index b37edb9..8146726 100644
--- a/docs/en/3.0.0/cordova/file/directoryreader/directoryreader.md
+++ b/docs/en/3.0.0/cordova/file/directoryreader/directoryreader.md
@@ -47,6 +47,7 @@ Read the entries in this directory.
__Parameters:__
- __successCallback__: A callback that is passed an array of `FileEntry` and `DirectoryEntry` objects. _(Function)_
+
- __errorCallback__: A callback that executes if an error occurs when retrieving the directory listing. Invoked with a `FileError` object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/cordova/file/file.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/file.md b/docs/en/3.0.0/cordova/file/file.md
index 52c24ba..64ad381 100644
--- a/docs/en/3.0.0/cordova/file/file.md
+++ b/docs/en/3.0.0/cordova/file/file.md
@@ -41,43 +41,57 @@ Objects
- LocalFileSystem
- Metadata
-Permissions
------------
-
-### Android
-
-#### app/res/xml/config.xml
-
- <plugin name="File" value="org.apache.cordova.FileUtils" />
- <plugin name="FileTransfer" value="org.apache.cordova.FileTransfer" />
-
-#### app/AndroidManifest.xml
-
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-
-### BlackBerry WebWorks
-
-#### www/plugins.xml
-
- <plugin name="File" value="org.apache.cordova.file.FileManager" />
- <plugin name="FileTransfer" value="org.apache.cordova.http.FileTransfer" />
-
-#### www/config.xml
-
- <feature id="blackberry.io.file" required="true" version="1.0.0.0" />
- <feature id="blackberry.utils" required="true" version="1.0.0.0" />
- <feature id="blackberry.io.dir" required="true" version="1.0.0.0" />
- <rim:permissions>
- <rim:permit>access_shared</rim:permit>
- </rim:permissions>
-
-### iOS
-
-#### config.xml
-
- <plugin name="File" value="CDVFile" />
- <plugin name="FileTransfer" value="CDVFileTransfer" />
-
-### Windows Phone
-
- No permissions are required.
+## Accessing the Feature
+
+As of version 3.0, Cordova implements device-level APIs as _plugins_.
+Use the CLI's `plugin` command, described in The Command-line
+Interface, to add or remove this feature for a project:
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
+ $ cordova plugin rm org.apache.cordova.core.file
+
+These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:
+
+* Android
+
+ (in app/res/xml/config.xml)
+ <feature name="File">
+ <param name="android-package" value="org.apache.cordova.FileUtils" />
+ </feature>
+ <feature name="FileTransfer">
+ <param name="android-package" value="org.apache.cordova.FileTransfer" />
+ </feature>
+
+ (in app/AndroidManifest.xml)
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+
+* BlackBerry WebWorks
+
+ (in www/plugins.xml)
+ <feature name="File">
+ <param name="blackberry-package" value="org.apache.cordova.file.FileManager" />
+ </feature>
+ <feature name="FileTransfer">
+ <param name="blackberry-package" value="org.apache.cordova.http.FileTransfer" />
+ </feature>
+
+ (in www/config.xml)
+ <feature id="blackberry.io.file" required="true" version="1.0.0.0" />
+ <feature id="blackberry.utils" required="true" version="1.0.0.0" />
+ <feature id="blackberry.io.dir" required="true" version="1.0.0.0" />
+ <rim:permissions>
+ <rim:permit>access_shared</rim:permit>
+ </rim:permissions>
+
+* iOS (in `config.xml`)
+
+ <feature name="File">
+ <param name="ios-package" value="CDVFile" />
+ </feature>
+ <feature name="FileTransfer">
+ <param name="ios-package" value="CDVFileTransfer" />
+ </feature>
+
+Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.
[2/6] Update 3.0.0 from edge directory.
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/ios/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/ios/plugin.md b/docs/en/3.0.0/guide/platforms/ios/plugin.md
index 7256de1..404cb13 100644
--- a/docs/en/3.0.0/guide/platforms/ios/plugin.md
+++ b/docs/en/3.0.0/guide/platforms/ios/plugin.md
@@ -21,7 +21,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
A plugin is an Objective-C class that extends the `CDVPlugin` class.
-Each plugin class must be registered using the config.xml file, as a <plugin> tag under the <plugins> key.
+Each plugin class must be registered as a `<feature>` tag in the
+`config.xml` file. It is through this mechanism that JavaScript's `exec`
+method's `service` parameter maps to an Objective-C class.
## Plugin Class Mapping
@@ -33,28 +35,39 @@ This marshals a request from the `UIWebView` to the iOS native side,
more or less boiling down to calling the `action` method on the
`service` class, with the arguments passed in the `args` array.
-The plugin must be added under the `<plugins>` tag of your Cordova-iOS
+Specifiy the plugin as a `<feature>` tag in your Cordova-iOS
application's project's `config.xml` file.
<feature name="LocalStorage">
<param name="ios-package" value="CDVLocalStorage" />
</feature>
-The feature name='name' should match what you use in the JavaScript
-`exec` call, and the value matches the name of the plugin's
-Objective-C class. param name should always be "ios-package".
-Otherwise the plugin may compile but would not be
+The feature `name` attribute should match what you use in the JavaScript
+`exec` call's `service` parameter, and the `value` attribute should match the name of the plugin's
+Objective-C class. `<param name>` should always be i`"ios-package"`.
+If you do not follow this setup, the plugin may compile but will not be
reachable by Cordova.
## Plugin Initialization and Lifetime
-There is one instance of a plugin object that is created per-UIWebView, and the lifetime of the instance is tied to the UIWebView. Plugins are not instantiated until they are first referenced by a call from JS, unless the `onload` attribute set within config.xml. E.g.:
+One instance of a plugin object is created for the life of each
+`UIWebView`. Plugins are not instantiated until they are first
+referenced by a call from JavaScript, unless `<param>` with an `onload`
+`name` attribute is set to `"true"` in `config.xml`. E.g.:
- <plugin name="Echo" value="Echo" onload="true" />
+ <feature name="Echo">
+ <param name="ios-package" value="Echo" />
+ <param name="onload" value="true" />
+ </feature>
-There is *no* designated initializer for plugins. Instead, plugins should use the `pluginInitialize` method for their start-up logic.
+There is _no_ designated initializer for plugins. Instead, plugins
+should use the `pluginInitialize` method for their start-up logic.
-Plugins with long-running requests, background activity (e.g. playing media), listeners or internal state should implement the `onReset` method and stop or clean up those activities. This method is run when the `UIWebView` navigates to a new page or refreshes, which reloads the JavaScript.
+Plugins with long-running requests, background activity (e.g. playing
+media), listeners or internal state should implement the `onReset`
+method and stop or clean up those activities. This method is run when
+the `UIWebView` navigates to a new page or refreshes, which reloads
+the JavaScript.
## Writing an iOS Cordova Plugin
@@ -76,7 +89,9 @@ What gets dispatched to the plugin via JavaScript's `exec` function gets passed
}
1. [CDVInvokedUrlCommand.h](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVInvokedUrlCommand.h)
+
2. [CDVPluginResult.h](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVPluginResult.h)
+
3. [CDVCommandDelegate.h](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVCommandDelegate.h)
## iOS CDVPluginResult message types
@@ -99,9 +114,11 @@ callback does not fire.
## Echo Plugin iOS Plugin
-We would add the following to the `<plugins>` tag of the project's `config.xml` file:
+We would add the following to the project's `config.xml` file:
- <plugin name="Echo" value="Echo" />
+ <feature name="Echo">
+ <param name="ios-package" value="Echo" />
+ </feature>
Then we would add the following files (`Echo.h` and `Echo.m`) to the Plugins folder inside our Cordova-iOS
application folder:
@@ -140,7 +157,7 @@ application folder:
@end
Let's take a look at the code. At the top we have all of the necessary
-Cordova imports. Our class extends from `CDVPlugin` - very important.
+Cordova imports. Our class extends from `CDVPlugin` (very important).
This plugin only supports one action, the `echo` action. First, we
grab the echo string using the `objectAtIndex` method on our `args`,
@@ -180,8 +197,9 @@ call, you should use a background thread. For example:
See other methods that you can override in:
-1. [CDVPlugin.h](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVPlugin.h)
-2. [CDVPlugin.m](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVPlugin.m)
+* [CDVPlugin.h](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVPlugin.h)
+
+* [CDVPlugin.m](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVPlugin.m)
For example, you can hook into the `pause`, `resume`, app terminate and `handleOpenURL` events.
@@ -198,4 +216,5 @@ running in the iOS 6 Simulator.
## Common Pitfalls
* Don't forget to add your plugin's mapping to config.xml. If you forget, an error is logged in the Xcode console.
+
* Don't forget to add any hosts you connect to in the whitelist, as described in Domain Whitelist Guide. If you forget, an error is logged in the Xcode console.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/ios/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/ios/upgrading.md b/docs/en/3.0.0/guide/platforms/ios/upgrading.md
index 0a8330f..b2ce50b 100644
--- a/docs/en/3.0.0/guide/platforms/ios/upgrading.md
+++ b/docs/en/3.0.0/guide/platforms/ios/upgrading.md
@@ -19,64 +19,93 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Upgrading iOS
-This guide shows how to modify iOS projects to upgrade from older versions of Cordova.
-Most of these instructions apply to projects created with an older set
-of command-line tools that precede the `cordova` CLI utility. See The
-Cordova Command-line Interface for information how to update the
-version of the CLI.
+This guide shows how to modify iOS projects to upgrade from older
+versions of Cordova. Most of these instructions apply to projects
+created with an older set of command-line tools that precede the
+`cordova` CLI utility. See The Command-line Interface for information
+how to update the version of the CLI.
-Please note that **Xcode 4.5 is required**. To submit to the Apple App Store, you must use the latest shipped version of the iOS SDK, which is iOS 6. The iOS 6 SDK requires Xcode 4.5.
+__NOTE:__ Xcode 4.5 is required. To submit to the Apple App Store, you
+must use the latest shipped version of the iOS SDK, which is iOS 6.
+The iOS 6 SDK requires Xcode 4.5.
## Upgrade to the CLI (3.0.0) from 2.9.0 ##
1. Create a new Apache Cordova 3.0.0 project using the cordova CLI, as
- described in The Cordova Command-line Interface.
+ described in The Command-line Interface.
+
2. Add your platforms the the cordova project, for example: `cordova
platform add ios`.
-3. Copy the contents of the project's `www` folder to the `www` folder
+
+3. Copy the contents of the project's `www` directory to the `www` directory
at the root of the cordova project you just created.
+
4. Copy or overwrite any native assets from your original project
(`Resources`, etc.), making sure to add any
new files to the `.xcodeproj` project. The iOS project builds
inside the `platforms\ios` directory.
-5. Copy your config.xml into the www folder, and remove any plugin definitions. You will modify settings here instead of the platform folder.
+
+5. Copy your `config.xml` into the `www` directory, and remove any plugin
+ definitions. Modify settings here instead of the platform folder.
+
6. Use the cordova CLI tool to install any plugins you need. Note that
the CLI handles all core APIs as plugins, so they may need to be
added. Only 3.0.0 plugins are compatible with the CLI.
-7. Build and test.
+7. Build and test.
## Upgrading 2.9.0 projects to 3.0.0 ##
-1. **Download and extract the Cordova 3.0.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-3.0.0)
-2. **Quit Xcode** if it is running.
-3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova.js** (note that it does not have a version suffix anymore, the version is in the file itself in the header) file from the new project into your **www** folder, and delete your **www/cordova.js** file
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file
-7. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder
+1. Download and extract the Cordova 3.0.0 source to a permanent folder location on your hard drive, for example to `~/Documents/Cordova-3.0.0`.
+
+2. Quit Xcode if it is running.
-NOTE: Starting with Cordova 3.0.0, projects do not come with any plugins, you will have to install the ones you require for your project using the `plugman` CLI utility - see the "Using Plugman to Manage Plugins".
+3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova.js` (note that it does not have a version suffix anymore, the version is in the file itself in the header) file from the new project into your `www` directory, and delete your `www/cordova.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova.js` file.
+
+7. Delete your `CordovaLib` directory, and copy the `CordovaLib` directory from the new project into your project's root directory.
+
+__NOTE:__ Starting with Cordova 3.0.0, projects do not come with any
+plugins, you will have to install the ones you require for your
+project using the `plugman` CLI utility. See Using Plugman to Manage
+Plugins.
## Upgrading 2.8.0 projects to 2.9.0 ##
-1. **Download and extract the Cordova 2.9.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.9.0)
-2. **Quit Xcode** if it is running.
-3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova.js** (note that it does not have a version suffix anymore, the version is in the file itself in the header) file from the new project into your **www** folder, and delete your **www/cordova.js** file
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file
-7. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder
+1. Download and extract the Cordova 2.9.0 source to a permanent folder location on your hard drive, for example to `~/Documents/Cordova-2.9.0`.
+
+2. Quit Xcode if it is running.
+
+3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova.js` (note that it does not have a version suffix anymore, the version is in the file itself in the header) file from the new project into your `www` directory, and delete your `www/cordova.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova.js` file.
+
+7. Delete your `CordovaLib` directory, and copy the `CordovaLib` directory from the new project into your project's root directory.
## Upgrading 2.7.0 projects to 2.8.0 ##
-1. **Download and extract the Cordova 2.8.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.8.0)
-2. **Quit Xcode** if it is running.
-3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova.js** (note that it does not have a version suffix anymore, the version is in the file itself in the header) file from the new project into your **www** folder, and delete your **www/cordova-2.7.0.js** file
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova.js** file
-7. Update any <plugin> tags that are in your **config.xml** to <feature> tags. Note that existing <plugin> tags will still work, but are deprecated. You can copy this information in the **config.xml** for a new project. For example:
+1. Download and extract the Cordova 2.8.0 source to a permanent folder location on your hard drive, for example to `~/Documents/Cordova-2.8.0`.
+
+2. Quit Xcode if it is running.
+
+3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova.js` (note that it does not have a version suffix anymore, the version is in the file itself in the header) file from the new project into your `www` directory, and delete your `www/cordova-2.7.0.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova.js` file.
+
+7. Update any `<plugin>` tags that are in your `config.xml` to `<feature>` tags. Note that existing `<plugin>` tags will still work, but are deprecated. You can copy this information in the `config.xml` for a new project. For example:
<plugins>
<plugin name="LocalStorage" value="CDVLocalStorage" />
@@ -89,181 +118,287 @@ NOTE: Starting with Cordova 3.0.0, projects do not come with any plugins, you wi
</feature>
<!-- other <feature> tags -->
-8. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder
+
+8. Delete your `CordovaLib` directory, and copy the `CordovaLib` directory from the new project into your project's root directory.
+
9. Add these two frameworks to your project:
OpenAL
ImageIO
-
-10. Update your project's target **Build Settings**. Under **Linking** -> **Other Linker Flags**, edit **"-Obj-C"** to be **"-ObjC"**
-
-11. Update your project's target **Build Settings**. Under **Linking** -> **Other Linker Flags**, change **"-all\_load"** to be **"-force\_load ${BUILT\_PRODUCTS\_DIR}/libCordova.a"**. You would only need to do this if you have the problem defined in [this issue.](https://issues.apache.org/jira/browse/CB-3458)
+
+10. Update your project's target __Build Settings__. Under __Linking → Other Linker Flags__, edit __"-Obj-C"__ to be __"-ObjC"__.
+
+11. Update your project's target __Build Settings__. Under __Linking → Other Linker Flags__, change __"-all\_load"__ to be `-force\_load ${BUILT\_PRODUCTS\_DIR}/libCordova.a`. You would only need to do this if you have the problem defined in [this issue.](https://issues.apache.org/jira/browse/CB-3458).
## Upgrading 2.6.0 projects to 2.7.0 ##
-1. **Download and extract the Cordova 2.7.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.7.0)
-2. **Quit Xcode** if it is running.
-3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-4. **Create a new project**, as described in iOS Command-line Tools. you need the assets from this new project.
-5. **Copy** the **www/cordova-2.7.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.6.0.js** file
-6. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova-2.7.0.js** file
-7. Update (or replace, if you never changed the file) your **AppDelegate.m** file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=5c05ac80e056753c0e8736f887ba9f28d5b0774c;hp=623ad8ec3c46f656ea18c6c3a190d650dd64e479;hb=c6e71147386d4ad94b07428952d1aae0a9cbf3f5;hpb=c017fda8af00375a453cf27cfc488647972e9a23))
-8. In your **config.xml** file, [remove this line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=537705d76a5ef6bc5e57a8ebfcab78c02bb4110b;hp=8889726d9a8f8c530fe1371c56d858c34552992a;hb=064239b7b5fa9a867144cf1ee8b2fb798ce1f988;hpb=c9f233250d4b800f3412eeded811daaafb17b2cc).
-9. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder
+1. Download and extract the Cordova 2.7.0 source to a permanent folder location on your hard drive, for example to `~/Documents/Cordova-2.7.0`.
+
+2. Quit Xcode if it is running.
+
+3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+
+4. Create a new project, as described in iOS Command-line Tools. you need the assets from this new project.
+
+5. Copy the `www/cordova-2.7.0.js` file from the new project into your `www` directory, and delete your `www/cordova-2.6.0.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-2.7.0.js` file.
+
+7. Update (or replace, if you never changed the file) your `AppDelegate.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=5c05ac80e056753c0e8736f887ba9f28d5b0774c;hp=623ad8ec3c46f656ea18c6c3a190d650dd64e479;hb=c6e71147386d4ad94b07428952d1aae0a9cbf3f5;hpb=c017fda8af00375a453cf27cfc488647972e9a23)).
+
+8. In your `config.xml` file, [remove this line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=537705d76a5ef6bc5e57a8ebfcab78c02bb4110b;hp=8889726d9a8f8c530fe1371c56d858c34552992a;hb=064239b7b5fa9a867144cf1ee8b2fb798ce1f988;hpb=c9f233250d4b800f3412eeded811daaafb17b2cc).
+
+9. Delete your `CordovaLib` directory, and copy the `CordovaLib` directory from the new project into your project's root directory.
## Upgrading 2.5.0 projects to 2.6.0 ##
-1. **Download and extract the Cordova 2.6.0 source** to a **permanent folder location** on your hard drive (say to `~/Documents/Cordova-2.6.0`)
-2. **Quit Xcode** if it is running.
-3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the project's `www/cordova-2.6.0.js` file into your `www` folder, and delete your `www/cordova-2.5.0.js` file.
-6. **Update** the Cordova script reference in your `www/index.html` file (along with any other files that reference the script) to refer to the new `cordova-2.6.0.js` file.
-7. Update (or replace, if you never changed the file) your `AppDelegate.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=124a56bb4f361e95616f44d6d6f5a96ffa439b60;hp=318f79326176be8f16ebc93bad85dd745f4205b6;hb=a28c7712810a63396e9f32fa4eb94fe3f8b93985;hpb=36acdf55e4cab52802d73764c8a4b5b42cf18ef9))
+1. Download and extract the Cordova 2.6.0 source to a permanent folder location on your hard drive, for example to `~/Documents/Cordova-2.6.0`.
+
+2. Quit Xcode if it is running.
+
+3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the project's `www/cordova-2.6.0.js` file into your `www` directory, and delete your `www/cordova-2.5.0.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (along with any other files that reference the script) to refer to the new `cordova-2.6.0.js` file.
+
+7. Update (or replace, if you never changed the file) your `AppDelegate.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=124a56bb4f361e95616f44d6d6f5a96ffa439b60;hp=318f79326176be8f16ebc93bad85dd745f4205b6;hb=a28c7712810a63396e9f32fa4eb94fe3f8b93985;hpb=36acdf55e4cab52802d73764c8a4b5b42cf18ef9)).
+
8. In your `config.xml` file, [add this new line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=1555b5e81de326a07efe0bccaa5f5e2326b07a9a;hp=0652d60f8d35ac13c825c572dca6ed01fea4a540;hb=95f16a6dc252db0299b8e2bb53797995b1e39aa1;hpb=a2de90b8f5f5f68bd9520bcbbb9afa3ac409b96d).
+
9. In your `config.xml` file, [add this new line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=d307827b7e67301171a913417fb10003d43ce39d;hp=04260aa9786d6d74ab20a07c86d7e8b34e31968c;hb=97b89edfae3527828c0ca6bb2f6d58d9ded95188;hpb=942d33c8e7174a5766029ea1232ba2e0df745c3f).
-10. In your `config.xml` file, [UIWebViewBounce has ben changed to DisallowOverscroll - and default values are different](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=8889726d9a8f8c530fe1371c56d858c34552992a;hp=d307827b7e67301171a913417fb10003d43ce39d;hb=57982de638a4dce6ae130a26662591741b065f00;hpb=ec411f18309d577b4debefd9a2f085ba719701d5).
-10. In your `config.xml` file, the **EnableLocation** preference has been **deprecated**.
-11. Delete your `CordovaLib` folder, and copy the `CordovaLib` folder from the new project into your project's root folder.
+
+10. In your `config.xml` file, [UIWebViewBounce has been changed to DisallowOverscroll, and default values are different](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=8889726d9a8f8c530fe1371c56d858c34552992a;hp=d307827b7e67301171a913417fb10003d43ce39d;hb=57982de638a4dce6ae130a26662591741b065f00;hpb=ec411f18309d577b4debefd9a2f085ba719701d5).
+
+10. In your `config.xml` file, the `EnableLocation` preference has been deprecated.
+
+11. Delete your `CordovaLib` directory, and copy the `CordovaLib` directory from the new project into your project's root directory.
## Upgrading 2.4.0 projects to 2.5.0 ##
-1. **Download and extract the Cordova 2.5.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.5.0)
-2. **Quit Xcode** if it is running.
-3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova-2.5.0.js** file from the new project into your **www** folder and delete your **www/cordova-2.4.0.js** file
-6. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **cordova-2.5.0.js** file
-7. Update (or replace, if you never changed the file) your `AppDelegate.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=318f79326176be8f16ebc93bad85dd745f4205b6;hp=6dc7bfc84f0ecede4cc43d2a3256ef7c5383b9fe;hb=4001ae13fcb1fcbe73168327630fbc0ce44703d0;hpb=299a324e8c30065fc4511c1fe59c6515d4842f09))
+1. Download and extract the Cordova 2.5.0 source to a permanent folder location on your hard drive, for example to `~/Documents/Cordova-2.5.0`.
+
+2. Quit Xcode if it is running.
+
+3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova-2.5.0.js` file from the new project into your `www` directory and delete your `www/cordova-2.4.0.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-2.5.0.js` file.
+
+7. Update (or replace, if you never changed the file) your `AppDelegate.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=318f79326176be8f16ebc93bad85dd745f4205b6;hp=6dc7bfc84f0ecede4cc43d2a3256ef7c5383b9fe;hb=4001ae13fcb1fcbe73168327630fbc0ce44703d0;hpb=299a324e8c30065fc4511c1fe59c6515d4842f09)).
+
8. In your `config.xml` file, [add these new lines](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=903944c4b1e58575295c820e154be2f5f09e6314;hp=721c734120b13004a4a543ee25f4287e541f34be;hb=ae467249b4a256bd31ee89aea7a06f4f2316b8ac;hpb=9e39f7ef8096fb15b38121ab0e245a3a958d9cbb).
+
9. In your `config.xml` file, [edit the root element, change it from cordova to widget](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=64e71636f5dd79fa0978a97b9ff5aa3860a493f5;hp=d8579352dfb21c14e5748e09b2cf3f4396450163;hb=0e711f8d09377a7ac10ff6be4ec17d22cdbee88d;hpb=57c3c082ed9be41c0588d0d63a1d2bfcd2ed878c).
+
10. In your `config.xml` file, [remove the OpenAllWhitelistURLsInWebView preference](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=721c734120b13004a4a543ee25f4287e541f34be;hp=7d67508b70914aa921a16e79f79c00512502a8b6;hb=187bf21b308551bfb4b98b1a5e11edf04f699791;hpb=03b8854bdf039bcefbe0212db937abd81ac675e4).
-11. Delete your **cordova** folder, and copy the **cordova** folder from the new project into your project's root folder **(in 2.5.0, this has updated scripts)**
-12. Delete your **CordovaLib** folder, and copy the **CordovaLib** folder from the new project into your project's root folder
+
+11. Delete your `cordova` directory, and copy the `cordova` directory from the new project into your project's root directory. In 2.5.0, this has updated scripts.
+
+12. Delete your `CordovaLib` directory, and copy the `CordovaLib` directory from the new project into your project's root directory.
## Upgrading 2.3.0 projects to 2.4.0 ##
-1. **Download and extract the Cordova 2.4.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.4.0)
-2. **Quit Xcode** if it is running.
-3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova-2.4.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.3.0.js** file
-6. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **cordova-2.4.0.js** file
+1. Download and extract the Cordova 2.4.0 source to a permanent folder location on your hard drive, for example to `~/Documents/Cordova-2.4.0`.
+
+2. Quit Xcode if it is running.
+
+3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova-2.4.0.js` file from the new project into your `www` directory, and delete your `www/cordova-2.3.0.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-2.4.0.js` file.
+
7. Update (or replace, if you never changed the files) your `MainViewController.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/MainViewController.m;h=5f9eeac15c2437cd02a6eb5835b48374e9b94100;hp=89da1082d06ba5e5d0dffc5b2e75a3a06d5c2aa6;hb=b4a2e4ae0445ba7aec788090dce9b822d67edfd8;hpb=a484850f4610e73c7b20cd429a7794ba829ec997)).
-8. Update (or replace, if you never changed the file) your `AppDelegate.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=6dc7bfc84f0ecede4cc43d2a3256ef7c5383b9fe;hp=1ca3dafeb354c4442b7e149da4f281675aa6b740;hb=6749c17640c5fed8a7d3a0b9cca204b89a855baa;hpb=deabeeb6fcb35bac9360b053c8bf902b45e6de4d))
+
+8. Update (or replace, if you never changed the file) your `AppDelegate.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=6dc7bfc84f0ecede4cc43d2a3256ef7c5383b9fe;hp=1ca3dafeb354c4442b7e149da4f281675aa6b740;hb=6749c17640c5fed8a7d3a0b9cca204b89a855baa;hpb=deabeeb6fcb35bac9360b053c8bf902b45e6de4d)).
+
9. In your `config.xml` file, [add this new line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=7d67508b70914aa921a16e79f79c00512502a8b6;hp=337d38da6f40c7432b0bce05aa3281d797eec40a;hb=6749c17640c5fed8a7d3a0b9cca204b89a855baa;hpb=deabeeb6fcb35bac9360b053c8bf902b45e6de4d).
-10. Delete your **cordova** folder, and copy the **cordova** folder from the new project into your project's root folder **(in 2.4.0, this has fixed scripts)**
-11. Delete your **CordovaLib** folder, and copy the **CordovaLib** folder from the new project into your project's root folder
-12. Add AssetsLibrary.framework as a resource to your project. (Go [here](https://developer.apple.com/library/ios/#recipes/xcode_help-project_editor/Articles/AddingaLibrarytoaTarget.html) for instructions on how to do so.)
+
+10. Delete your `cordova` directory, and copy the `cordova` directory from the new project into your project's root directory. In 2.4.0, this has fixed scripts.
+
+11. Delete your `CordovaLib` directory, and copy the `CordovaLib` directory from the new project into your project's root directory.
+
+12. Add AssetsLibrary.framework as a resource to your project. (Go [here](https://developer.apple.com/library/ios/#recipes/xcode_help-project_editor/Articles/AddingaLibrarytoaTarget.html) for instructions on how to do so.).
## Upgrading 2.2.0 projects to 2.3.0 ##
-1. **Download and extract the Cordova 2.3.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.3.0)
-2. **Quit Xcode** if it is running.
-3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova-2.3.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.2.0.js** file
-6. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **cordova-2.3.0.js** file
+1. Download and extract the Cordova 2.3.0 source to a permanent folder location on your hard drive, for example to `~/Documents/Cordova-2.3.0`.
+
+2. Quit Xcode if it is running.
+
+3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova-2.3.0.js` file from the new project into your `www` directory, and delete your `www/cordova-2.2.0.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-2.3.0.js` file.
+
7. Update (or replace, if you never changed the file) your `MainViewController.m` according to the one from the new project.
-8. Delete your **cordova** folder, and copy the **cordova** folder from the new project into your project's root folder **(in 2.3.0, this has new scripts)**
-9. Delete your **CordovaLib** folder, and copy the **CordovaLib** folder from the new project into your project's root folder
-10. Convert your `Cordova.plist` file to `config.xml`, by running the script **bin/cordova\_plist\_to\_config\_xml** on your project file.
-11. Add the InAppBrowser plugin to your `config.xml`, by adding this tag under **<cordova><plugins>**:
+
+8. Delete your `cordova` directory, and copy the `cordova` directory from the new project into your project's root directory. In 2.3.0, this has new scripts.
+
+9. Delete your `CordovaLib` directory, and copy the `CordovaLib` directory from the new project into your project's root directory.
+
+10. Convert your `Cordova.plist` file to `config.xml`, by running the script `bin/cordova\_plist\_to\_config\_xml` on your project file.
+
+11. Add the InAppBrowser plugin to your `config.xml`, by adding this tag under `<cordova><plugins>`:
<plugin name="InAppBrowser" value="CDVInAppBrowser" />
-12. Note that Objective-C plugins are **not** whitelisted anymore. To whitelist your connections with the app whitelist, you will need to set the “User-Agent” header of the connection to the same user-agent as the main Cordova WebView.
-You can get this by accessing the **userAgent** property off the main view-controller. The main view-controller (CDVViewController) also has a **URLisAllowed** method for you to check whether a URL will pass the whitelist.
+
+12. Note that Objective-C plugins are _not_ whitelisted anymore. To whitelist your connections with the app whitelist, you will need to set the `User-Agent` header of the connection to the same user-agent as the main Cordova WebView.
+You can get this by accessing the `userAgent` property off the main view-controller. The main view-controller (CDVViewController) also has a `URLisAllowed` method for you to check whether a URL will pass the whitelist.
+
13. Device API changes:
- * For iOS, device.platform used to return “iPhone”, “iPad” or “iPod Touch” — now it returns (correctly) “iOS”.
- * For iOS, device.name (now deprecated for all platforms) used to return the name of the user’s device (e.g ‘Shazron’s iPhone 5′) — now it returns what device.platform used to return: ”iPhone”, “iPad” or “iPod Touch”.
- * For all platforms, there is a new property called device.model — this returns the specific device model, e.g “iPad2,5″ (for other platforms, this returns what device.name used to return).
+ * For iOS, device.platform used to return `iPhone`, `iPad` or `iPod Touch`; now it returns (correctly) `iOS`.
+ * For iOS, device.name (now deprecated for all platforms) used to return the name of the user’s device (e.g ‘Shazron’s iPhone 5′); now it returns what device.platform used to return: `iPhone`, `iPad` or `iPod Touch`.
+ * For all platforms, there is a new property called device.model; this returns the specific device model, e.g `iPad2,5` (for other platforms, this returns what device.name used to return).
## Upgrading 2.1.0 projects to 2.2.0 ##
-1. **Download and extract the Cordova 2.2.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.2.0)
-2. **Quit Xcode** if it is running.
-3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-5. **Copy** the **www/cordova-2.2.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.1.0.js** file
-6. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **cordova-2.2.0.js** file
+1. Download and extract the Cordova 2.2.0 source to a permanent folder location on your hard drive, for example to `~/Documents/Cordova-2.2.0`.
+
+2. Quit Xcode if it is running.
+
+3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+
+4. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+5. Copy the `www/cordova-2.2.0.js` file from the new project into your `www` directory, and delete your `www/cordova-2.1.0.js` file.
+
+6. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-2.2.0.js` file.
+
7. Update (or replace, if you never changed the file) your `MainViewController.m` according to the one from the new project:
- Updated → viewWillAppear
-8. Copy the **cordova** folder from the new project into your project's root folder **(in 2.2.0, this has an updated 'emulate' script)**
-9. Next, update your CordovaLib sub-project reference. Beginning with Cordova 2.1.0, we are not using the CORDOVALIB Xcode variable anymore when referencing where CordovaLib resides, the reference is an absolute file reference now.
- 1. Launch **Terminal.app**
- 2. Go to the location where you installed Cordova (see Step 1), in the **bin** sub-folder
- 3. Run the script below where the first parameter is the path to your project's **.xcodeproj** file:
+
+8. Copy the `cordova` directory from the new project into your project's root directory. In 2.2.0, this has an updated 'emulate' script.
+
+9. Next, update your `CordovaLib` sub-project reference. Beginning with Cordova 2.1.0, we are not using the CORDOVALIB Xcode variable anymore when referencing where `CordovaLib` resides, the reference is an absolute file reference now.
+ 1. Launch Terminal.app
+ 2. Go to the location where you installed Cordova (see Step 1), in the `bin` subdirectory
+ 3. Run the script below where the first parameter is the path to your project's `.xcodeproj` file:
`update_cordova_subproject path/to/your/project/xcodeproj`
-__NOTE:__ In 2.2.0, the `bin/create` script copy in the CordovaLib sub-project into your project. To have the same kind of setup, just copy in the right CordovaLib into your project folder, and update the CordovaLib sub-project location (relative to the project) in the Xcode File Inspector.
+__NOTE:__ In 2.2.0, the `bin/create` script copy in the `CordovaLib` sub-project into your project. To have the same kind of setup, just copy in the right `CordovaLib` into your project folder, and update the `CordovaLib` sub-project location (relative to the project) in the Xcode File Inspector.
## Upgrading 2.0.0 projects to 2.1.0 ##
-With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit → Refactor → Convert to Objective-C ARC...**, **de-select libCordova.a**, then run the wizard to completion.
+With Cordova 2.1.0, `CordovaLib` has been upgraded to use __Automatic Reference Counting (ARC)__. You don't need to upgrade to __ARC__ to use CordovaLib, but if you want to upgrade your project to use __ARC__, please use the Xcode migration wizard from the menu: __Edit → Refactor → Convert to Objective-C ARC...__, de-select libCordova.a, then run the wizard to completion.
+
+1. Download and extract the Cordova 2.1.0 source to a permanent folder location on your hard drive, for example to `~/Documents/Cordova-2.1.0`.
+
+2. Quit Xcode if it is running.
+
+3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+
+5. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+6. Copy the `www/cordova-2.1.0.js` file from the new project into your `www` directory, and delete your `www/cordova-2.0.0.js` file.
+
+7. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-2.1.0.js` file.
-1. **Download and extract the Cordova 2.1.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.1.0)
-2. **Quit Xcode** if it is running.
-3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-5. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-6. **Copy** the **www/cordova-2.1.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.0.0.js** file
-7. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **cordova-2.1.0.js** file
8. Update (or replace, if you never changed the file) your `AppDelegate.m` according to the one from the new project:
- - Edited -> application:didFinishLaunchingWithOptions:
- - Added -> application:supportedInterfaceOrientationsForWindow:
+ - Edited → application:didFinishLaunchingWithOptions:
+ - Added → application:supportedInterfaceOrientationsForWindow:
+
9. Update (or replace, if you never changed the file) your `MainViewController.m` according to the one from the new project:
- - Added -> viewWillAppear
-10. Copy the **cordova** folder from the new project into your project's root folder **(in 2.1.0, this has the updated scripts to support paths with spaces)**
-11. Remove the **VERSION** file reference from your **project** (_not_ the one in CordovaLib)
-12. Next, update your CordovaLib sub-project reference. Beginning with Cordova 2.1.0, we are not using the CORDOVALIB Xcode variable anymore when referencing where CordovaLib resides, the reference is an absolute file reference now.
- 1. Launch **Terminal.app**
- 2. Go to the location where you installed Cordova **(see Step 1)**, in the **bin** sub-folder
- 3. Run the script below where the first parameter is the path to your project's **.xcodeproj** file:
+ - Added → viewWillAppear
+
+10. Copy the `cordova` directory from the new project into your project's root directory. In 2.1.0, this has the updated scripts to support paths with spaces.
+
+11. Remove the `VERSION` file reference from your project (_not_ the one in `CordovaLib`).
+
+12. Next, update your `CordovaLib` sub-project reference. Beginning with Cordova 2.1.0, we are not using the CORDOVALIB Xcode variable anymore when referencing where `CordovaLib` resides, the reference is an absolute file reference now.
+ 1. Launch Terminal.app
+ 2. Go to the location where you installed Cordova (see Step 1), in the `bin` subdirectory
+ 3. Run the script below where the first parameter is the path to your project's `.xcodeproj` file:
`update_cordova_subproject path/to/your/project/xcodeproj`
## Upgrading 1.9.0 projects to 2.0.0 ##
-1. **Install** Cordova 2.0.0
-2. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
-3. **Copy** the **www/cordova-2.0.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.9.0.js** file
-4. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **cordova-2.0.0.js** file
-5. Copy the **cordova** folder from the new project into your project's root folder (if you want the project command-line tools)
-6. **Add** a new entry under **Plugins** in your `Cordova.plist` file (under the **Supporting Files** group) - the key is **Device** and the value is **CDVDevice**
-7. Remove `Cordova.framework`
-8. Remove `verify.sh` from the **Supporting Files** group
-9. Select the **project icon** in the Project Navigator, select your project **Target**, then select the **Build Settings** tab
-10. Search for **Preprocessor Macros**, then remove all **CORDOVA_FRAMEWORK=1** values
-11. Locate the **CordovaLib** folder that was installed in your hard-drive under your home folder's **Documents** sub-folder.
-12. Locate the `CordovaLib.xcodeproj` file in the **CordovaLib** folder, then **drag and drop** the file into your project - it should appear as a **sub-project**.
-13. **Build** your project, you should get some **errors** relating to **#import** directives
-14. For the **#import errors**, change any **quote-based** imports in this style:
+1. Install Cordova 2.0.0.
+
+2. Create a new project, as described in iOS Command-line Tools. You need the assets from this new project.
+
+3. Copy the `www/cordova-2.0.0.js` file from the new project into your `www` directory, and delete your `www/cordova-1.9.0.js` file.
+
+4. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-2.0.0.js` file.
+
+5. Copy the `cordova` directory from the new project into your project's root directory (if you want the project command-line tools).
+
+6. Add a new entry under `Plugins` in your `Cordova.plist` file, under
+ the __Supporting Files__ group. The key is `Device` and the value
+ is `CDVDevice`.
+
+7. Remove `Cordova.framework`.
+
+8. Remove `verify.sh` from the __Supporting Files__ group.
+
+9. Select the project icon in the Project Navigator, select your project __Target__, then select the __Build Settings__ tab.
+
+10. Search for __Preprocessor Macros__, then remove all __CORDOVA_FRAMEWORK=1__ values.
+
+11. Locate the `CordovaLib` directory that was installed in your hard-drive under your home folder's `Documents` subdirectory.
+
+12. Locate the `CordovaLib.xcodeproj` file in the `CordovaLib` directory, then drag and drop the file into your project. It should appear as a sub-project.
+
+13. Build your project, you should get some errors relating to `#import` directives.
+
+14. For the `#import` errors, change any quote-based imports in this style:
#import "CDV.h"
- to this **brackets-based** style:
+ to this brackets-based style:
#import <Cordova/CDV.h>
- and remove any **#ifdef** wrappers around any Cordova imports, they are not needed anymore (the imports are **unified** now)
-15. **Build** your project again, and it should not have any **#import** errors.
-16. Select the **project icon** in the Project Navigator, select your project **Target**, then select the **Build Phases** tab
-17. Expand the **Target Dependencies** phase, then select the **+** button
-18. Select the **CordovaLib** target, then select the **Add** button
-19. Expand the **first** **Link Binary with Libraries** phase (it should already contain a bunch of frameworks), then select the **+** button
-20. Select the `libCordova.a` static library, then select the **Add** button
-21. Delete the **Run Script** phase.
-22. Select the **project icon** in the Project Navigator, select your project **Target**, then select the **Build Settings** tab
-23. Search for **Other Linker Flags**, and add the values **-all_load** and **-Obj-C**
-24. Expand the **CordovaLib** sub-project.
-25. Locate the **VERSION** file, drag it into your main project (we want to create a link to it, not a copy)
-26. Select the **Create groups for any added folders** radiobutton, then select the **Finish** button
-27. Select the **VERSION** file that you just dragged in a previous step
-28. Type the **Option-Command-1** key combination to show the **File Inspector** (or menuitem **View -> Utilities -> Show File Inspector**)
-29. Choose **Relative to CORDOVALIB** in the **File Inspector** for the drop-down menu for **Location**
-30. Set the Xcode preference **Xcode Preferences -> Locations -> Derived Data -> Advanced...** to **Unique** (this is so the unified headers can be found)
-31. Select the **project icon** in the Project Navigator, select your **Target**, then select the **Build Settings** tab
-32. Search for **Header Search Paths**. For that setting, add these three values below (with quotes):
+ and remove any `#ifdef` wrappers around any Cordova imports, they are not needed anymore (the imports are now unified)
+
+15. Build your project again, and it should not have any `#import` errors.
+
+16. Select the __project icon__ in the Project Navigator, select your project __Target__, then select the __Build Phases__ tab.
+
+17. Expand the __Target Dependencies__ phase, then select the __+__ button.
+
+18. Select the `CordovaLib` target, then select the __Add__ button.
+
+19. Expand the first __Link Binary with Libraries__ phase (it should already contain a bunch of frameworks), then select the __+__ button.
+
+20. Select the `libCordova.a` static library, then select the __Add__ button.
+
+21. Delete the __Run Script__ phase.
+
+22. Select the __project icon__ in the Project Navigator, select your project __Target__, then select the __Build Settings__ tab.
+
+23. Search for __Other Linker Flags__, and add the values __-all_load__ and __-Obj-C__.
+
+24. Expand the `CordovaLib` sub-project.
+
+25. Locate the `VERSION` file, drag it into your main project (we want to create a link to it, not a copy).
+
+26. Select the __Create groups for any added folders__ radio button, then select the __Finish__ button.
+
+27. Select the `VERSION` file that you just dragged in a previous step.
+
+28. Type the __Option-Command-1__ key combination to show the __File Inspector__ (or menuitem __View → Utilities → Show File Inspector__).
+
+29. Choose __Relative to CORDOVALIB__ in the __File Inspector__ for the drop-down menu for __Location__.
+
+30. Set the Xcode preference __Xcode Preferences → Locations → Derived Data → Advanced...__ to __Unique__, so that the unified headers can be found.
+
+31. Select the __project icon__ in the Project Navigator, select your __Target__, then select the __Build Settings__ tab.
+
+32. Search for __Header Search Paths__. For that setting, append these three values, including quotes:
"$(TARGET_BUILD_DIR)/usr/local/lib/include"
@@ -271,203 +406,319 @@ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Referenc
"$(BUILT_PRODUCTS_DIR)"
-33. Search for **Other Linker Flags**. For that setting, add this value below:
+33. Search for __Other Linker Flags__. For that setting, append this value:
-weak_framework CoreFoundation
-34. **Build** your project, it should compile and link with **no issues**.
-35. **Select your project** from the **Scheme** drop-down, and then select **iPhone 5.1 Simulator**
-36. Select the **Run** button
+34. Build your project, it should compile and link with __no issues__.
+
+35. Select your project from the __Scheme__ drop-down, and then select __iPhone 5.1 Simulator__.
-__NOTE:__ If your project is **not working** as expected in the Simulator, please **take a note of any errors** in the **console log in Xcode** for clues.
+36. Select the __Run__ button.
+
+__NOTE:__ If your project is not working as expected in the Simulator, please take a note of any errors in the console log in Xcode for clues.
## Upgrading 1.8.x projects to 1.9.0 ##
-1. **Install** Cordova 1.9.0
-2. **Create a new project** - you will have to grab assets from this new project
-3. **Copy** the **www/cordova-1.9.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.8.x.js** file
-4. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **cordova-1.9.0.js** file
+1. Install Cordova 1.9.0.
+
+2. Create a new project. You will need some of the assets from this new project.
+
+3. Copy the `www/cordova-1.9.0.js` file from the new project into your `www` directory, and delete your `www/cordova-1.8.x.js` file.
+
+4. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-1.9.0.js` file.
-__NOTE:__ 1.9.0 supports the new **BackupWebStorage** boolean `Cordova.plist` setting. It's enabled by default, so set it to
-`false` to disable it, especially on iOS 6. See [Release Notes - Safari and UIKit Section](https://developer.apple.com/library/prerelease/ios/#releasenotes/General/RN-iOSSDK-6_0/_index.html)
+__NOTE:__ 1.9.0 supports the new `BackupWebStorage` boolean `Cordova.plist` setting. It's enabled by default, so set it to
+`false` to disable it, especially on iOS 6. See [Release Notes: Safari and UIKit Section](https://developer.apple.com/library/prerelease/ios/#releasenotes/General/RN-iOSSDK-6_0/_index.html)
## Upgrading 1.7.0 projects to 1.8.x ##
-1. **Install** Cordova 1.8.0
-2. **Create a new project** - you will have to grab assets from this new project
-3. **Copy** the **www/cordova-1.8.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.7.x.js** file
-4. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **cordova-1.8.0.js** file
+1. Install Cordova 1.8.0.
+
+2. Create a new project. You will need some of the assets from this new project.
+
+3. Copy the `www/cordova-1.8.0.js` file from the new project into your `www` directory, and delete your `www/cordova-1.7.x.js` file.
+
+4. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-1.8.0.js` file.
+
+If you intend on using the Capture API, you will need the new __iPad retina-display__ assets:
-If you intend on using the **Capture API**, you will need the new **iPad retina-display** assets:
+1. Copy the `Resources/Capture.bundle` item from the new project into your project folder, over-writing your existing `Resources/Capture.bundle` item.
-1. **Copy** the `Resources/Capture.bundle` item from the new project into your project folder, over-writing your existing `Resources/Capture.bundle` item
-2. In your project, select the `Capture.bundle` item into your Project Navigator in Xcode, type the **Delete** key, then select **Remove Reference** from the resulting dialog.
-3. Drag the new `Capture.bundle` from Step 1 above into your Project Navigator in Xcode, then select the **Create groups for any added folders** radio button
+2. In your project, select the `Capture.bundle` item into your Project Navigator in Xcode, type the __Delete__ key, then select __Remove Reference__ from the resulting dialog.
+
+3. Drag the new `Capture.bundle` from Step 1 above into your Project Navigator in Xcode, then select the __Create groups for any added folders__ radio button.
## Upgrading 1.6.x projects to 1.7.0 ##
-1. **Install** Cordova 1.7.0
-2. **Create a new project** - you will have to grab assets from this new project
-3. **Copy** the **www/cordova-1.7.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.6.0.js** file
-4. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **cordova-1.7.0.js** file
+1. Install Cordova 1.7.0.
+
+2. Create a new project. You will need some of the assets from this new project.
+
+3. Copy the `www/cordova-1.7.0.js` file from the new project into your `www` directory, and delete your `www/cordova-1.6.0.js` file.
+
+4. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-1.7.0.js` file.
## Upgrading 1.5.0 projects to 1.6.x ##
-1. **Install** Cordova 1.6.1
-2. **Make a backup** of `AppDelegate.m`, `AppDelegate.h`, `MainViewController.m`, `MainViewController.h`, and `Cordova.plist` in your project
-3. **Create a new project** - you will have to grab assets from this new project
-4. **Copy** these files from the **new** project into your 1.5.0-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+1. Install Cordova 1.6.1.
+
+2. Make a backup of `AppDelegate.m`, `AppDelegate.h`, `MainViewController.m`, `MainViewController.h`, and `Cordova.plist` in your project.
+
+3. Create a new project. You will need some of the assets from this new project.
+
+4. Copy these files from the new project into your 1.5.0-based project folder on disk, replacing any old files (backup your files first from step 2 above):
AppDelegate.h
AppDelegate.m
MainViewController.h
MainViewController.m
Cordova.plist
-5. **Add** all the new **MainViewController** and **AppDelegate** files into your Xcode project
-6. **Copy** the **www/cordova-1.6.1.js** file from the new project into your **www** folder, and delete your **www/cordova-1.5.0.js** file
-7. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **cordova-1.6.1.js** file
-8. **Add** the new `Cordova.plist` file into your project - this is because the core plugin service names needed to be changed to match the ones from Android and BlackBerry, for a unified Cordova JavaScript file (cordova-js).
-9. **Integrate** any settings, **Plugins** and **ExternalHosts** entries that you had in your **backed-up Cordova.plist** into the new `Cordova.plist`
-10. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files. Any **UIWebViewDelegate** or **CDVCommandDelegate** code in `AppDelegate.m` will need to go into MainViewController.m now (see commented out sections in that file)
-11. **Integrate** any project-specific code that you have in your **backed-up MainViewController.h and MainViewController.m** into the new MainViewController files
-12. Click on the **project icon** in the Project Navigator, select your **Project**, then select the **Build Settings** tab
-13. Enter **Compiler for C/C++/Objective-C** in the search field
-14. Select the **Apple LLVM Compiler 3.1** value
+
+5. Add all the new `MainViewController` and `AppDelegate` files into your Xcode project.
+
+6. Copy the `www/cordova-1.6.1.js` file from the new project into your `www` directory, and delete your `www/cordova-1.5.0.js` file.
+
+7. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `cordova-1.6.1.js` file.
+
+8. Add the new `Cordova.plist` file into your project. This is
+ necessary because the core plugin service names must change to
+ match the ones from Android and BlackBerry, for a unified Cordova
+ JavaScript file (`cordova-js`).
+
+9. Integrate any settings, __Plugins__ and __ExternalHosts__ entries that you had in your __backed-up Cordova.plist__ into the new `Cordova.plist`.
+
+10. Integrate any project-specific code that you have in your backed-up `AppDelegate.h` and `AppDelegate.m` into the new AppDelegate files. Any `UIWebViewDelegate` or `CDVCommandDelegate` code in `AppDelegate.m` will need to go into `MainViewController.m` now (see commented out sections in that file).
+
+11. Integrate any project-specific code that you have in your backed-up `MainViewController.h` and `MainViewController.m` into the new MainViewController files.
+
+12. Click on the project icon in the Project Navigator, select your __Project__, then select the __Build Settings__ tab.
+
+13. Enter __Compiler for C/C++/Objective-C__ in the search field.
+
+14. Select the __Apple LLVM Compiler 3.1__ value.
## Upgrading 1.4.x projects to 1.5.0 ##
-1. **Install** Cordova 1.5.0
-2. **Create a new project** and run it once - you will have to grab assets from this new project
-3. **Copy** the **www/cordova-1.5.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.4.x.js** file
-4. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new Cordova **cordova-1.5.0.js** file
-5. Find `PhoneGap.framework` in your Project Navigator, select it
-6. Type the **Delete** key and delete the `PhoneGap.framework` reference in the Project Navigator
-7. Type the **Option-Command-A** key combination, which should drop down a sheet to add files to your project (the **Add Files...** sheet). Make sure the **Created groups for any added folders** radio button is selected
-8. Type the **Shift-Command-G** key combination, which should drop down another sheet for you to go to a folder (the **Go to the folder:** sheet)
-9. Enter **/Users/Shared/Cordova/Frameworks/Cordova.framework** in the **Go to the folder:** sheet and then press the **Go** button
-10. Press the **Add** button in the **Add Files...** sheet
-11. Select `Cordova.framework` in the Project Navigator
-12. Type the **Option-Command-1** key combination to show the **File Inspector**
-13. Choose **Absolute Path** in the **File Inspector** for the drop-down menu for **Location**
-14. Type the **Option-Command-A** key combination, which should drop down a sheet to add files to your project (the **Add Files...** sheet). Make sure the **Created groups for any added folders** radio button is selected
-15. Type the **Shift-Command-G** key combination, which should drop down another sheet for you to go to a folder (the **Go to the folder:** sheet)
-16. Enter **~/Documents/CordovaLib/Classes/deprecated** in the **Go to the folder:** sheet and then press the **Go** button
-17. Press the **Add** button in the **Add Files...** sheet
-18. In your **AppDelegate.h, AppDelegate.m, and MainViewController.h** files - replace the whole **#ifdef PHONEGAP_FRAMEWORK** block with:
+1. Install Cordova 1.5.0.
+
+2. Create a new project and run it once. You will need some of the assets from this new project.
+
+3. Copy the `www/cordova-1.5.0.js` file from the new project into your `www` directory, and delete your `www/phonegap-1.4.x.js` file.
+
+4. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new Cordova `cordova-1.5.0.js` file.
+
+5. Find `PhoneGap.framework` in your Project Navigator, select it.
+
+6. Type the __Delete__ key and delete the `PhoneGap.framework` reference in the Project Navigator.
+
+7. Type the __Option-Command-A__ key combination, which should drop down a sheet to add files to your project (the __Add Files...__ sheet). Make sure the __Created groups for any added folders__ radio button is selected.
+
+8. Type the __Shift-Command-G__ key combination, which should drop down another sheet for you to go to a folder (the __Go to the folder:__ sheet).
+
+9. Enter `/Users/Shared/Cordova/Frameworks/Cordova.framework` in the __Go to the folder:__ sheet and then press the __Go__ button.
+
+10. Press the __Add__ button in the __Add Files...__ sheet.
+
+11. Select `Cordova.framework` in the Project Navigator.
+
+12. Type the __Option-Command-1__ key combination to show the __File Inspector__.
+
+13. Choose __Absolute Path__ in the __File Inspector__ for the drop-down menu for __Location__.
+
+14. Type the __Option-Command-A__ key combination, which should drop down a sheet to add files to your project (the __Add Files...__ sheet). Make sure the __Created groups for any added folders__ radio button is selected.
+
+15. Type the __Shift-Command-G__ key combination, which should drop down another sheet for you to go to a folder (the __Go to the folder:__ sheet).
+
+16. Enter `~/Documents/CordovaLib/Classes/deprecated` in the __Go to the folder:__ sheet and then press the __Go__ button.
+
+17. Press the __Add__ button in the __Add Files...__ sheet.
+
+18. In your `AppDelegate.h`, `AppDelegate.m`, and `MainViewController.h` files, replace the whole `#ifdef PHONEGAP_FRAMEWORK` block with:
#import "CDVDeprecated.h"
-19. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **Build Settings** tab
-20. Search for **Framework Search Paths**
-21. Replace the existing value with **/Users/Shared/Cordova/Frameworks**
-22. Search for **Preprocessor Macros**
-23. For the first (combined) value, replace the value with **CORDOVA_FRAMEWORK=YES**
-24. Select the **Build Phases** tab
-25. Expand **Run Script**
-26. Replace any occurrences of **PhoneGap** with **Cordova**
-27. Find your `PhoneGap.plist` file in the Project Navigator, and click on the filename once to enter name edit mode
-28. Rename `PhoneGap.plist` to `Cordova.plist`
-29. Right-click on `Cordova.plist` and choose **Open As --> Source Code**
-30. Press **Option-Command-F**, choose **Replace** from the drop-down on the top left of the Source window
-31. Enter `com.phonegap` for the Find string, and `org.apache.cordova` for the Replace string - then press the **Replace All** button
-32. Enter **PG** for the Find string, and **CDV** for the Replace string - then press the **Replace All** button
-33. Press **Command-B** to build, you will still have deprecations that you can get rid of in the future (see `CDVDeprecated.h` - replace classes in your code that use PG* to CDV*, for example)
+
+19. Click on the __project icon__ in the Project Navigator, select your __Target__, then select the __Build Settings__ tab.
+
+20. Search for __Framework Search Paths__.
+
+21. Replace the existing value with `/Users/Shared/Cordova/Frameworks`.
+
+22. Search for __Preprocessor Macros__.
+
+23. For the first (combined) value, replace the value with __CORDOVA_FRAMEWORK=YES__.
+
+24. Select the __Build Phases__ tab.
+
+25. Expand __Run Script__.
+
+26. Replace any occurrences of __PhoneGap__ with __Cordova__.
+
+27. Find your `PhoneGap.plist` file in the Project Navigator, and click on the filename once to enter name edit mode.
+
+28. Rename `PhoneGap.plist` to `Cordova.plist`.
+
+29. Right-click on `Cordova.plist` and choose __Open As → Source Code__.
+
+30. Press __Option-Command-F__, choose __Replace__ from the drop-down on the top left of the Source window.
+
+31. Enter `com.phonegap` for the Find string, and `org.apache.cordova`
+ for the Replace string, then press the __Replace All__ button.
+
+32. Enter __PG__ for the Find string, and __CDV__ for the Replace
+ string, then press the __Replace All__ button.
+
+33. Press __Command-B__ to build, you will still have deprecations
+ that you can get rid of in the future (see `CDVDeprecated.h`. For
+ example, replace classes in your code that use PG* to CDV*).
## Upgrading 1.4.0 projects to 1.4.1 ##
-1. **Install** Cordova 1.4.1
-2. **Make a backup** of `MainViewController.m`
-3. **Create a new project** - you will have to grab assets from this new project
-4. **Copy** the `MainViewController.m` file from the **new** project into your 1.4.0-based project folder on disk, **replacing** the old file (**backup** your files first from step 2 above).
-5. **Add** the `MainViewController.m` file into your Xcode project
-6. **Integrate** any project-specific code that you have in your backed-up `MainViewController.m` into the new file
-7. Updating the `phonegap-1.4.0.js` file is optional, nothing has changed in the JavaScript between 1.4.0 and 1.4.1
+1. Install Cordova 1.4.1.
+
+2. Make a backup of `MainViewController.m`.
+
+3. Create a new project. You will need some of the assets from this new project.
+
+4. Copy the `MainViewController.m` file from the new project into your 1.4.0-based project folder on disk, replacing the old file (backup your files first from step 2 above).
+
+5. Add the `MainViewController.m` file into your Xcode project.
+
+6. Integrate any project-specific code that you have in your backed-up `MainViewController.m` into the new file.
+
+7. Updating the `phonegap-1.4.0.js` file is optional, nothing has changed in the JavaScript between 1.4.0 and 1.4.1.
## Upgrading 1.3.0 projects to 1.4.0 ##
-1. **Install** Cordova 1.4.0
-2. **Make a backup** of `AppDelegate.m` and `AppDelegate.h` in your project
-3. **Create a new project** - you will have to grab assets from this new project
-4. **Copy** these files from the **new** project into your 1.3.0-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+1. Install Cordova 1.4.0.
+
+2. Make a backup of `AppDelegate.m` and `AppDelegate.h` in your project.
+
+3. Create a new project. You will need some of the assets from this new project.
+
+4. Copy these files from the new project into your 1.3.0-based project folder on disk, replacing any old files (backup your files first from step 2 above):
AppDelegate.h
AppDelegate.m
MainViewController.h
MainViewController.m
MainViewController.xib
-5. **Add** all the **MainViewController** files into your Xcode project
-6. **Copy** the **www/phonegap-1.4.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.3.0.js** file
-7. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **phonegap-1.4.0.js** file
-8. **Add** a new entry under **Plugins** in your `PhoneGap.plist` file - key is `com.phonegap.battery` and the value is **PGBattery**
-9. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files
+
+5. Add all the `MainViewController` files into your Xcode project.
+
+6. Copy the `www/phonegap-1.4.0.js` file from the new project into your `www` directory, and delete your `www/phonegap-1.3.0.js` file.
+
+7. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `phonegap-1.4.0.js` file.
+
+8. Add a new entry under `Plugins` in your `PhoneGap.plist` file. The
+ key is `com.phonegap.battery` and the value is `PGBattery`.
+
+9. Integrate any project-specific code that you have in your backed-up `AppDelegate.h` and `AppDelegate.m` into the new AppDelegate files.
## Upgrading 1.2.0 projects to 1.3.0 ##
-1. **Install** Cordova 1.3.0
-2. **Make a backup** of `AppDelegate.m` and `AppDelegate.h` in your project
-3. **Create a new project** - you will have to grab assets from this new project
-4. **Copy** these files from the **new** project into your 1.2.0-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+1. Install Cordova 1.3.0.
+
+2. Make a backup of `AppDelegate.m` and `AppDelegate.h` in your project.
+
+3. Create a new project. You will need some of the assets from this new project.
+
+4. Copy these files from the new project into your 1.2.0-based project folder on disk, replacing any old files (backup your files first from step 2 above):
AppDelegate.h
AppDelegate.m
MainViewController.h
MainViewController.m
MainViewController.xib
-5. **Add** all the **MainViewController** files into your Xcode project
-6. **Copy** the **www/phonegap-1.3.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.2.0.js** file
-7. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **phonegap-1.3.0.js** file
-8. **Add** a new entry under **Plugins** in your `PhoneGap.plist` file - key is `com.phonegap.battery` and the value is **PGBattery**
-9. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files
+
+5. Add all the `MainViewController` files into your Xcode project.
+
+6. Copy the `www/phonegap-1.3.0.js` file from the new project into your `www` directory, and delete your `www/phonegap-1.2.0.js` file.
+
+7. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `phonegap-1.3.0.js` file.
+
+8. Add a new entry under `Plugins` in your `PhoneGap.plist` file. The
+ key is `com.phonegap.battery` and the value is `PGBattery`.
+
+9. Integrate any project-specific code that you have in your backed-up `AppDelegate.h` and `AppDelegate.m` into the new AppDelegate files.
## Upgrading 1.1.0 projects to 1.2.0 ##
-1. **Install** Cordova 1.2.0
-2. **Make a backup** of `AppDelegate.m` and `AppDelegate.h` in your project
-3. **Create a new project** - you will have to grab assets from this new project
-4. **Copy** these files from the **new** project into your 1.1.0-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+1. Install Cordova 1.2.0.
+
+2. Make a backup of `AppDelegate.m` and `AppDelegate.h` in your project.
+
+3. Create a new project. You will need some of the assets from this new project.
+
+4. Copy these files from the new project into your 1.1.0-based project folder on disk, replacing any old files (backup your files first from step 2 above):
AppDelegate.h
AppDelegate.m
MainViewController.h
MainViewController.m
MainViewController.xib
-5. **Add** all the **MainViewController** files into your Xcode project
-6. **Copy** the **www/phonegap-1.2.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.1.0.js** file
-7. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **phonegap-1.2.0.js** file
-8. **Add** a new entry under **Plugins** in your `PhoneGap.plist` file - key is `com.phonegap.battery` and the value is **PGBattery**
-9. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files
+
+5. Add all the `MainViewController` files into your Xcode project.
+
+6. Copy the `www/phonegap-1.2.0.js` file from the new project into your `www` directory, and delete your `www/phonegap-1.1.0.js` file.
+
+7. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `phonegap-1.2.0.js` file.
+
+8. Add a new entry under `Plugins` in your `PhoneGap.plist` file. The
+ key is `com.phonegap.battery` and the value is `PGBattery`.
+
+9. Integrate any project-specific code that you have in your backed-up `AppDelegate.h` and `AppDelegate.m` into the new AppDelegate files.
## Upgrading 1.0.0 projects to 1.1.0 ##
-1. **Install** Cordova 1.1.0
-2. **Make a backup** of `AppDelegate.m` and `AppDelegate.h` in your project
-3. **Create a new project** - you will have to grab assets from this new project
-4. **Copy** these files from the **new** project into your 1.0.0-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+1. Install Cordova 1.1.0.
+
+2. Make a backup of `AppDelegate.m` and `AppDelegate.h` in your project.
+
+3. Create a new project. You will need some of the assets from this new project.
+
+4. Copy these files from the new project into your 1.0.0-based project folder on disk, replacing any old files (backup your files first from step 2 above):
AppDelegate.h
AppDelegate.m
MainViewController.h
MainViewController.m
MainViewController.xib
-5. **Add** all the **MainViewController** files into your Xcode project
-6. **Copy** the **www/phonegap-1.1.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.0.0.js** file
-7. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **phonegap-1.1.0.js** file
-8. **Add** a new entry under **Plugins** in your `PhoneGap.plist` file - key is `com.phonegap.battery` and the value is **PGBattery**
-9. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files
+
+5. Add all the `MainViewController` files into your Xcode project.
+
+6. Copy the `www/phonegap-1.1.0.js` file from the new project into your `www` directory, and delete your `www/phonegap-1.0.0.js` file.
+
+7. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `phonegap-1.1.0.js` file.
+
+8. Add a new entry under `Plugins` in your `PhoneGap.plist` file. The
+ key is `com.phonegap.battery` and the value is `PGBattery`.
+
+9. Integrate any project-specific code that you have in your backed-up `AppDelegate.h` and `AppDelegate.m` into the new AppDelegate files.
## Upgrading 0.9.6 projects to 1.0.0 ##
-1. **Install** Cordova 1.0.0
-2. **Make a backup** of `AppDelegate.m` and `AppDelegate.h` in your project
-3. **Create a new project** - you will have to grab assets from this new project
-4. **Copy** these files from the **new** project into your 0.9.6-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+1. Install Cordova 1.0.0.
+
+2. Make a backup of `AppDelegate.m` and `AppDelegate.h` in your project.
+
+3. Create a new project. You will need some of the assets from this new project.
+
+4. Copy these files from the new project into your 0.9.6-based project folder on disk, replacing any old files (backup your files first from step 2 above):
AppDelegate.h
AppDelegate.m
MainViewController.h
MainViewController.m
MainViewController.xib
-5. **Add** all the **MainViewController** files into your Xcode project
-6. **Copy** the **www/phonegap-1.0.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-0.9.6.js** file
-7. **Update** the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new **phonegap-1.0.0.js** file
-8. **Add** a new entry under **Plugins** in your `PhoneGap.plist` file - key is `com.phonegap.battery` and the value is **PGBattery**
-9. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files
+
+5. Add all the `MainViewController` files into your Xcode project.
+
+6. Copy the `www/phonegap-1.0.0.js` file from the new project into your `www` directory, and delete your `www/phonegap-0.9.6.js` file.
+
+7. Update the Cordova script reference in your `www/index.html` file (and any other files that contain the script reference) to point to the new `phonegap-1.0.0.js` file.
+
+8. Add a new entry under `Plugins` in your `PhoneGap.plist` file. The
+ key is `com.phonegap.battery` and the value is `PGBattery`.
+
+9. Integrate any project-specific code that you have in your backed-up `AppDelegate.h` and `AppDelegate.m` into the new AppDelegate files.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3fb6feae/docs/en/3.0.0/guide/platforms/ios/webview.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/ios/webview.md b/docs/en/3.0.0/guide/platforms/ios/webview.md
index 18caa27..31998f8 100644
--- a/docs/en/3.0.0/guide/platforms/ios/webview.md
+++ b/docs/en/3.0.0/guide/platforms/ios/webview.md
@@ -31,27 +31,43 @@ based Cleaver implementation.
## Prerequisites
-1. **Cordova 2.3.0** or greater
-2. **Xcode 4.5** or greater
-3. `config.xml` file (from a newly created iOS project)
+* Cordova 2.3.0 or greater
+
+* Xcode 4.5 or greater
+
+* `config.xml` file (from a newly created iOS 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`)
-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 **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. 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):
+1. Download and extract the Cordova source to a permanent folder location on your hard drive, for example to `~/Documents/Cordova`.
+
+2. Quit Xcode if it is running.
+
+3. Using Terminal.app, navigate to the directory where you put the downloaded source above.
+
+4. Copy the `config.xml` file into your project folder on disk (see the Prerequisites above).
+
+5. Drag and drop the `config.xml` file into the Project Navigator of Xcode.
+
+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` subdirectory).
+
+8. Select `CordovaLib.xcodeproj` in the Project Navigator.
+
+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 the following __frameworks__. Optionally in the Project Navigator, move them under the __Frameworks__ group):
AddressBook.framework
AddressBookUI.framework
@@ -64,28 +80,34 @@ based Cleaver implementation.
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
+
+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
-1. Add this **header**:
+1. Add this header:
#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];
@@ -109,17 +131,21 @@ based Cleaver implementation.
viewController.view.frame = CGRectMake(0, 0, 320, 480);
-7. **Add** Cleaver to your view:
+7. Add Cleaver to your view:
[myView addSubview:viewController.view];
## Adding your HTML, CSS and JavaScript assets
-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`.
+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 initially created, or use the defaults (see previous section) when you instantiate the `CDVViewController`.
/*
if you created a folder called 'myfolder' and