You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/06/12 19:50:36 UTC
[01/46] docs commit: add stubs
Updated Branches:
refs/heads/master 3e06f383f -> db36946f3
add stubs
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/1cf6a8c2
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/1cf6a8c2
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/1cf6a8c2
Branch: refs/heads/master
Commit: 1cf6a8c239b81147ac5f0a3a2fe334f7758d7afb
Parents: dc55db0
Author: Mike Sierra <le...@gmail.com>
Authored: Wed Apr 24 12:30:40 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Wed Apr 24 12:30:40 2013 -0400
----------------------------------------------------------------------
.gitignore | 3 +++
docs/en/edge/guide/overview/cli.md | 22 ++++++++++++++++++++++
docs/en/edge/guide/overview/index.md | 22 ++++++++++++++++++++++
3 files changed, 47 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/1cf6a8c2/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index da8f866..9d3614a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,6 @@
tmp/
public/
release/
+TAGS
+,*
+_*
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/1cf6a8c2/docs/en/edge/guide/overview/cli.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/cli.md b/docs/en/edge/guide/overview/cli.md
new file mode 100644
index 0000000..862fb08
--- /dev/null
+++ b/docs/en/edge/guide/overview/cli.md
@@ -0,0 +1,22 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Primer on Command-line Deployment
+=================================
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/1cf6a8c2/docs/en/edge/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/index.md b/docs/en/edge/guide/overview/index.md
new file mode 100644
index 0000000..bc10128
--- /dev/null
+++ b/docs/en/edge/guide/overview/index.md
@@ -0,0 +1,22 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Overview
+========
+
[09/46] numerous nonlinear global edits
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/upgrading/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/ios/index.md b/docs/en/edge/guide/upgrading/ios/index.md
index 1e4610a..e35fd0d 100644
--- a/docs/en/edge/guide/upgrading/ios/index.md
+++ b/docs/en/edge/guide/upgrading/ios/index.md
@@ -42,29 +42,29 @@ Please note that **Xcode 4.5 is required**. To submit to the Apple App Store, yo
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**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project
-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))
-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
+4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools. You need to use 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))
+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
## Upgrading Cordova 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**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project
+4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools. You need to use 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
-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))
-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
+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))
+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.)
## Upgrading Cordova 2.2.0 projects to 2.3.0 ##
@@ -72,14 +72,14 @@ Please note that **Xcode 4.5 is required**. To submit to the Apple App Store, yo
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**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project
+4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools. You need to use 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
-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>**:
+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>**:
<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.
@@ -94,38 +94,38 @@ You can get this by accessing the **userAgent** property off the main view-contr
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**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project
+4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools. You need to use 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
-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)**
+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
+ 2. Go to the location where you installed Cordova (see Step 1), in the **bin** sub-folder
3. Run the script below where the first parameter is the path to your project's **.xcodeproj** file:
`update_cordova_subproject path/to/your/project/xcodeproj`
-**Note** that in 2.2.0, the **bin/create** script will copy in the CordovaLib sub-project into your project now. 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 Cordova 2.0.0 projects to 2.1.0 ##
-With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit -> Refactor -> Convert to Objective-C ARC…**, **de-select libCordova.a**, then run the wizard to completion.
+With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit → Refactor → Convert to Objective-C ARC...**, **de-select libCordova.a**, then run the wizard to completion.
1. **Download and extract the Cordova 2.1.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.1.0)
2. **Quit Xcode** if it is running.
3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
-5. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project
+5. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools. You need to use 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:
+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:
-9. Update (or replace, if you never changed the file) your **MainViewController.m** according to the one from the new project:
+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)
+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
@@ -136,17 +136,17 @@ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Referenc
## Upgrading Cordova 1.9.0 projects to 2.0.0 ##
1. **Install** Cordova 2.0.0
-2. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project
+2. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools. You need to use 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
+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**.
+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:
@@ -158,23 +158,23 @@ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Referenc
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. Press the key combination **Option-Command-1** 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):
+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. Press 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):
"$(TARGET_BUILD_DIR)/usr/local/lib/include"
@@ -182,56 +182,52 @@ 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, add this value below:
-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"**
+35. **Select your project** from the **Scheme** drop-down, and then select **iPhone 5.1 Simulator**
36. Select the **Run** button
-**NOTE:**<br />
-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.
+__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 Cordova 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
+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 setting
-in `Cordova.plist`. By default, this setting is enabled, 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 Cordova 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
+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:
-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 Xcode into your Project Navigator, and press the **Delete** key, then select **Remove Reference** from the dialog that pops up.
-3. Drag the new **Capture.bundle** from Step 1. above into Xcode into your Project Navigator, and select the **Create groups for any added folders** radio-button
+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 Xcode into your Project Navigator, and press the **Delete** key, then select **Remove Reference** from the dialog that pops up.
+3. Drag the new `Capture.bundle` from Step 1. above into Xcode into your Project Navigator, and select the **Create groups for any added folders** radio button
## Upgrading Cordova 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
+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 Cordova 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
+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):
+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
@@ -240,69 +236,69 @@ If you intend on using the **Capture API**, you will need the new **iPad retina-
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
+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
## Upgrading Cordova 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. Press the **Delete** key and delete the **"PhoneGap.framework"** reference in the Project Navigator
-7. Press the key combination **Option-Command-A**, 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. Press the key combination **Shift-Command-G**, 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. Press the key combination **Option-Command-1** to show the **File Inspector**
-13. Choose **"Absolute Path"** in the **File Inspector** for the drop-down menu for **Location**
-14. Press the key combination **Option-Command-A**, 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. Press the key combination **Shift-Command-G**, 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**
+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. Press the **Delete** key and delete the `PhoneGap.framework` reference in the Project Navigator
+7. Press 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. Press 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. Press 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. Press 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. Press 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"**
+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)
+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)
## Upgrading Cordova 1.4.0 projects to 1.4.1 ##
1. **Install** Cordova 1.4.1
-2. **Make a backup** of **MainViewController.m**
+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
+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 Cordova 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
+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):
+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
@@ -311,16 +307,16 @@ If you intend on using the **Capture API**, you will need the new **iPad retina-
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
+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
## Upgrading Cordova 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
+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):
+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
@@ -329,16 +325,16 @@ If you intend on using the **Capture API**, you will need the new **iPad retina-
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
+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
## Upgrading Cordova 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
+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):
+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
@@ -347,16 +343,16 @@ If you intend on using the **Capture API**, you will need the new **iPad retina-
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
+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
## Upgrading Cordova 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
+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):
+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
@@ -365,16 +361,16 @@ If you intend on using the **Capture API**, you will need the new **iPad retina-
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
+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
## Upgrading Cordova 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
+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):
+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
@@ -383,6 +379,6 @@ If you intend on using the **Capture API**, you will need the new **iPad retina-
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
+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
[34/46] docs commit: splashcreen
Posted by mw...@apache.org.
splashcreen
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/44d1cb23
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/44d1cb23
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/44d1cb23
Branch: refs/heads/master
Commit: 44d1cb239976f32c4a8010adba5f56ed3de42a1e
Parents: 03ce2ca
Author: Mike Sierra <le...@gmail.com>
Authored: Sun May 19 15:46:50 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Sun May 19 15:46:50 2013 -0400
----------------------------------------------------------------------
.../cordova/splashscreen/splashscreen.hide.md | 11 +++--
.../edge/cordova/splashscreen/splashscreen.md | 48 ++++++++++----------
.../cordova/splashscreen/splashscreen.show.md | 4 +-
3 files changed, 31 insertions(+), 32 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/44d1cb23/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/splashscreen/splashscreen.hide.md b/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
index 0a198bb..c4abcba 100644
--- a/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
+++ b/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,7 @@ Dismiss the splash screen.
Description
-----------
-navigator.splashscreen.hide() dismisses the applications splash screen.
+This method dismisses the application's splash screen.
Supported Platforms
-------------------
@@ -71,9 +71,10 @@ Full Example
iOS Quirk
------------
-1. In your **config.xml**, you need to [modify the value](guide_project-settings_index.md.html#Project%20Settings) for **"AutoHideSplashScreen”** to false
-
-2. Then, if you want to delay hiding the splash screen for 2 seconds, you can do this in your **deviceready** event handler:
+The [`config.xml` file's setting](guide_project-settings_index.md.html#Project%20Settings) for
+`AutoHideSplashScreen` must be `false`. To delay hiding the splash
+screen for two seconds, add a timer such as the following in the
+`deviceready` event handler:
setTimeout(function() {
navigator.splashscreen.hide();
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/44d1cb23/docs/en/edge/cordova/splashscreen/splashscreen.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/splashscreen/splashscreen.md b/docs/en/edge/cordova/splashscreen/splashscreen.md
index d939d9d..2feaecc 100644
--- a/docs/en/edge/cordova/splashscreen/splashscreen.md
+++ b/docs/en/edge/cordova/splashscreen/splashscreen.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Splashscreen
==========
-> Enables developers to show/hide the application's splash screen.
+> Displays and hides the application's splash screen.
Methods
-------
@@ -48,36 +48,34 @@ Setup
### Android
-1. Copy your splash screen image into the res/drawable directories of your Android project. The sizes of each image should be:
+1. Copy the splash screen image into the Android project's `res/drawable` directory. The size for each image should be:
- - xlarge (xhdpi): at least 960 x 720
- - large (hdpi): at least 640 x 480
- - medium (mdpi): at least 470 x 320
- - small (ldpi): at least 426 x 320
+ - xlarge (xhdpi): at least 960 × 720
+ - large (hdpi): at least 640 × 480
+ - medium (mdpi): at least 470 × 320
+ - small (ldpi): at least 426 × 320
- It is highly recommended that you use a [9-patch image](https://developer.android.com/tools/help/draw9patch.html) for your splash screen.
+ You should use a [9-patch image](https://developer.android.com/tools/help/draw9patch.html) for your splash screen.
-2. In the onCreate method of the class that extends DroidGap add the following two lines:
+2. In the `onCreate` method of the class that extends `DroidGap`, add the following two lines:
super.setIntegerProperty("splashscreen", R.drawable.splash);
super.loadUrl(Config.getStartUrl(), 10000);
- The first line 'super.setIntegerProperty' sets the image to be displayed as the splashscreen. If you have named your image anything other than splash.png you will have to modify this line.
- The second line is the normal 'super.loadUrl' line but it has a second parameter which is the timeout value for the splash screen. In this example the splash screen will display for 10 seconds. If you want to dismiss the splash screen once you get the "deviceready" event you should call the navigator.splashscreen.hide() method.
+ The first line sets the image to display as the splashscreen. If you name your image anything other than `splash.png`, you need to modify this line.
+ The second line is the normal `super.loadUrl` line, but it has a second parameter that specifies a timeout value for the splash screen. In this example the splash screen displays for 10 seconds. To dismiss the splash screen once the app receives the `deviceready` event, call the `navigator.splashscreen.hide()` method.
### iOS
-1. Copy your splash screen images into the **Resources/splash** directory of your iOS project. Only add the images for the devices you want to support (iPad screen size or iPhone screen size). The sizes of each image should be:
-
- - Default-568h@2x~iphone.png (640x1136 pixels)
- - Default-Landscape@2x~ipad.png (2048x1496 pixels)
- - Default-Landscape~ipad.png (1024x748 pixels)
- - Default-Portrait@2x~ipad.png (1536x2008 pixels)
- - Default-Portrait~ipad.png (768x1004 pixels)
- - Default@2x~iphone.png (640x960 pixels)
- - Default~iphone.png (320x480 pixels)
-
-
-
-
-
+Copy your splash screen images into the iOS project's
+`Resources/splash` directory. Only add the images for the devices you
+want to support, such as iPad or iPhone. The size of each image
+should be:
+
+- Default-568h@2x~iphone.png (640x1136 pixels)
+- Default-Landscape@2x~ipad.png (2048x1496 pixels)
+- Default-Landscape~ipad.png (1024x748 pixels)
+- Default-Portrait@2x~ipad.png (1536x2008 pixels)
+- Default-Portrait~ipad.png (768x1004 pixels)
+- Default@2x~iphone.png (640x960 pixels)
+- Default~iphone.png (320x480 pixels)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/44d1cb23/docs/en/edge/cordova/splashscreen/splashscreen.show.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/splashscreen/splashscreen.show.md b/docs/en/edge/cordova/splashscreen/splashscreen.show.md
index e50e623..188d415 100644
--- a/docs/en/edge/cordova/splashscreen/splashscreen.show.md
+++ b/docs/en/edge/cordova/splashscreen/splashscreen.show.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,7 @@ Displays the splash screen.
Description
-----------
-navigator.splashscreen.show() displays the applications splash screen.
+This method displays the application's splash screen.
Supported Platforms
-------------------
[13/46] docs commit: various inline formatting
Posted by mw...@apache.org.
various inline formatting
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/3986e794
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/3986e794
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/3986e794
Branch: refs/heads/master
Commit: 3986e7945fbd742831d8384799af6a42298731f9
Parents: 85730c3
Author: Mike Sierra <le...@gmail.com>
Authored: Mon Apr 29 13:41:09 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon Apr 29 13:41:09 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/getting-started/android/index.md | 8 ++++----
docs/en/edge/guide/getting-started/ios/index.md | 12 ++++++------
docs/en/edge/guide/upgrading/blackberry/index.md | 4 ++--
3 files changed, 12 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3986e794/docs/en/edge/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/android/index.md b/docs/en/edge/guide/getting-started/android/index.md
index 60812d8..d652ab4 100644
--- a/docs/en/edge/guide/getting-started/android/index.md
+++ b/docs/en/edge/guide/getting-started/android/index.md
@@ -67,11 +67,11 @@ platforms are deprecated as they dip below 5% on Google's
3B. Set up your PATH environment variable on Windows
---------------------------------------
-- From the Desktop, right-click My Computer and click Properties.
-- Click Advanced System Settings link in the left column.
-- In the System Properties window, click the Environment Variables button.
+- From the Desktop, right-click __My Computer__ and click __Properties__.
+- Click the __Advanced System Settings__ link in the left column.
+- In the __System Properties__ window, click the __Environment Variables__ button.
- Select the PATH variable from the System variables section.
-- Select the Edit button.
+- Select the __Edit__ button.
- You need to add the path to your Android SDK platform-tools and tools directory. This example uses `C:\Development\android-sdk-windows` as the SDK's install directory. Append the following into the text box:
`;C:\Development\android-sdk-windows\platform-tools;C:\Development\android-sdk-windows\tools`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3986e794/docs/en/edge/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/ios/index.md b/docs/en/edge/guide/getting-started/ios/index.md
index 02ac381..1fa7d6b 100644
--- a/docs/en/edge/guide/getting-started/ios/index.md
+++ b/docs/en/edge/guide/getting-started/ios/index.md
@@ -239,8 +239,8 @@ references the deprecated invokeString API:
Some users have encountered compilation errors relating to missing headers. This refers to a problem in the build location and is fixed via Xcode preferences.
- 1. Within the Xcode menus select **Xcode>Preferences>Locations**.
- 2. In the Derived Data section click the Advanced button and select Unique as the Build Location as shown:
+ 1. Within the Xcode menus select **Xcode → Preferences → Locations**.
+ 2. In the __Derived Data__ section click the __Advanced__ button and select __Unique__ as the __Build Location_ as shown:
This is the default setting for a new Xcode install, but it may be set differently if you upgraded from an older version of Xcode.
@@ -251,7 +251,7 @@ references the deprecated invokeString API:
**Include Cordova**
- All of the code for the sample application is contained within the www directory in the Xcode project structure. The starting page is named index.html. Any page that uses Cordova must include the cordova-*.js file for the associated Cordova version and platform. The format of the JavaScript file name is cordova-x.y.z where x represents the major version number, y the minor version and z any point release. For example, the Cordova 2.2.0 file was named cordova-2.2.0.js. The sample HelloWorld application includes this file from index.html.
+ All of the code for the sample application is contained within the `www` directory in the Xcode project structure. The starting page is named index.html. Any page that uses Cordova must include the cordova-*.js file for the associated Cordova version and platform. The format of the JavaScript file name is cordova-x.y.z where x represents the major version number, y the minor version and z any point release. For example, the Cordova 2.2.0 file was named cordova-2.2.0.js. The sample HelloWorld application includes this file from index.html.
<script type="text/javascript" src="cordova-2.2.0.js"></script>
<script type="text/javascript" src="js/index.js"></script>
@@ -261,9 +261,9 @@ references the deprecated invokeString API:
**Wait for deviceReady Event**
- When loading a page, Cordova’s deviceReady event must fire before you can access any of the platform features via the Cordova JavaScript APIs. Within the sample application this is set up within the app object found within the js/index.js file. The app.initialze() call at the bottom of the index.html file (visible in the previous code example) sets in motion the binding of events to receive and respond to the deviceReady event.
+ When loading a page, Cordova’s `deviceReady` event must fire before you can access any of the platform features via the Cordova JavaScript APIs. Within the sample application this is set up within the app object found within the js/index.js file. The app.initialze() call at the bottom of the `index.html` file (visible in the previous code example) sets in motion the binding of events to receive and respond to the `deviceReady` event.
- Another common method of initializing a page is to add an event listener for the deviceReady event within the handler for the body onload event as shown in the code snippet below:
+ Another common way to initialize a page is to add a `deviceReady` event listener from the body's `onload` event handler as shown below:
<head>
<script type="text/javascript" src="cordova-x.x.x.js"></script>
@@ -290,7 +290,7 @@ references the deprecated invokeString API:
###Code Your Application
- Replace the sample code in the www directory of a new project with the HTML, JavaScript and CSS code for your application. The name of the initial file to load when the app is launched should be index.html (advanced users can change this if necessary). As demonstrated in the HelloWorld sample application, subdirectories within the www directory are permitted. Note that the www directory is readonly, you can not write information to this directory during app execution. If you need to store information use the Cordova File or Storage APIs.
+ Replace the sample code in the `www` directory of a new project with the HTML, JavaScript and CSS code for your application. The name of the initial file to load when the app is launched should be `index.html` (advanced users can change this if necessary). As demonstrated in the HelloWorld sample application, subdirectories within the `www` directory are permitted. Note that the `www` directory is readonly, you can not write information to this directory during app execution. If you need to store information use the Cordova File or Storage APIs.
You can use many mobile JavaScript frameworks with Cordova to create the UI and page navigation of your application. Popular ones include:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3986e794/docs/en/edge/guide/upgrading/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/blackberry/index.md b/docs/en/edge/guide/upgrading/blackberry/index.md
index 1e65812..bc4b31e 100644
--- a/docs/en/edge/guide/upgrading/blackberry/index.md
+++ b/docs/en/edge/guide/upgrading/blackberry/index.md
@@ -24,7 +24,7 @@ This document is for people who need to upgrade their Cordova versions from an o
## Upgrade to 2.0.0 from 1.9.0 ##
-Updating just the www folder:
+Updating just the `www` folder:
1. Open your `www/` folder, which contains your app.
2. Remove and update the .jar file in the `ext/` folder.
@@ -69,7 +69,7 @@ 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` folder:
1. Open your `www/` folder, which contains your app.
2. Remove and update the .jar file in the `ext/` folder.
[17/46] edits up to menu button event
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureVideo.md b/docs/en/edge/cordova/media/capture/captureVideo.md
index f729f16..fba61fe 100644
--- a/docs/en/edge/cordova/media/capture/captureVideo.md
+++ b/docs/en/edge/cordova/media/capture/captureVideo.md
@@ -22,7 +22,7 @@ capture.captureVideo
> Start the video recorder application and return information about captured video clip file(s).
- navigator.device.capture.captureVideo(
+ navigator.device.capture.captureVideo(
CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureVideoOptions options]
);
@@ -83,11 +83,11 @@ Full Example
var i, len;
for (i = 0, len = mediaFiles.length; i < len; i += 1) {
uploadFile(mediaFiles[i]);
- }
+ }
}
// Called if something bad happens.
- //
+ //
function captureError(error) {
var msg = 'An error occurred during capture: ' + error.code;
navigator.notification.alert(msg, null, 'Uh oh!');
@@ -96,7 +96,7 @@ Full Example
// A button will call this function
//
function captureVideo() {
- // Launch device video recording application,
+ // Launch device video recording application,
// allowing user to capture up to 2 video clips
navigator.device.capture.captureVideo(captureSuccess, captureError, {limit: 2});
}
@@ -116,7 +116,7 @@ Full Example
function(error) {
console.log('Error uploading file ' + path + ': ' + error.code);
},
- { fileName: name });
+ { fileName: name });
}
</script>
@@ -136,7 +136,7 @@ Bada 2.x Quirks
Bada supports _captureVideo_ just like the other platforms. However there is _another_ mode where you can capture a video or an image straight in the webview without launching any camera apps. In order to do that you need to:
-1. create a _<div>_ element somewhere in your document and give it an id (such as "preview").
+1. create a _<div>_ element somewhere in your document and give it an id (such as "preview").
<div id="preview"></div>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.getCurrentPosition.md b/docs/en/edge/cordova/media/media.getCurrentPosition.md
index a228d61..1aecb0f 100644
--- a/docs/en/edge/cordova/media/media.getCurrentPosition.md
+++ b/docs/en/edge/cordova/media/media.getCurrentPosition.md
@@ -33,7 +33,7 @@ Parameters
Description
-----------
-Function `media.getCurrentPosition` is an asynchronous function that returns the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object.
+Function `media.getCurrentPosition` is an asynchronous function that returns the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object.
Supported Platforms
-------------------
@@ -69,7 +69,6 @@ Quick Example
);
}, 1000);
-
Full Example
------------
@@ -128,7 +127,7 @@ Full Example
}
// Pause audio
- //
+ //
function pauseAudio() {
if (my_media) {
my_media.pause();
@@ -136,7 +135,7 @@ Full Example
}
// Stop audio
- //
+ //
function stopAudio() {
if (my_media) {
my_media.stop();
@@ -151,15 +150,15 @@ Full Example
console.log("playAudio():Audio Success");
}
- // onError Callback
+ // onError Callback
//
function onError(error) {
- alert('code: ' + error.code + '\n' +
+ alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
// Set audio position
- //
+ //
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/media.getDuration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.getDuration.md b/docs/en/edge/cordova/media/media.getDuration.md
index c3393a8..40d8b2b 100644
--- a/docs/en/edge/cordova/media/media.getDuration.md
+++ b/docs/en/edge/cordova/media/media.getDuration.md
@@ -24,7 +24,6 @@ Returns the duration of an audio file.
media.getDuration();
-
Description
-----------
@@ -61,7 +60,6 @@ Quick Example
}
}, 100);
-
Full Example
------------
@@ -120,7 +118,7 @@ Full Example
}
// Pause audio
- //
+ //
function pauseAudio() {
if (my_media) {
my_media.pause();
@@ -128,7 +126,7 @@ Full Example
}
// Stop audio
- //
+ //
function stopAudio() {
if (my_media) {
my_media.stop();
@@ -143,15 +141,15 @@ Full Example
console.log("playAudio():Audio Success");
}
- // onError Callback
+ // onError Callback
//
function onError(error) {
- alert('code: ' + error.code + '\n' +
+ alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
// Set audio position
- //
+ //
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/media.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.md b/docs/en/edge/cordova/media/media.md
index 5532b96..5559f8f 100644
--- a/docs/en/edge/cordova/media/media.md
+++ b/docs/en/edge/cordova/media/media.md
@@ -24,7 +24,6 @@ Media
var media = new Media(src, mediaSuccess, [mediaError], [mediaStatus]);
-
Note: The current implementation does not adhere to a W3C specification for media capture, and is provided for convenience only. A future implementation will adhere to the latest W3C specification and may deprecate the current APIs.
Parameters
@@ -133,7 +132,6 @@ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en
No permissions are required.
-
### Windows Phone Quirks
Only one media file can be played back at a time.
- There are strict restrictions as to how your application interacts with other media. See http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx
+ There are strict restrictions as to how your application interacts with other media. See 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/6899777b/docs/en/edge/cordova/media/media.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.pause.md b/docs/en/edge/cordova/media/media.pause.md
index d3a7f1f..c937e66 100644
--- a/docs/en/edge/cordova/media/media.pause.md
+++ b/docs/en/edge/cordova/media/media.pause.md
@@ -24,7 +24,6 @@ Pauses playing an audio file.
media.pause();
-
Description
-----------
@@ -63,10 +62,9 @@ Quick Example
// Pause after 10 seconds
setTimeout(function() {
media.pause();
- }, 10000);
+ }, 10000);
}
-
Full Example
------------
@@ -125,7 +123,7 @@ Full Example
}
// Pause audio
- //
+ //
function pauseAudio() {
if (my_media) {
my_media.pause();
@@ -133,7 +131,7 @@ Full Example
}
// Stop audio
- //
+ //
function stopAudio() {
if (my_media) {
my_media.stop();
@@ -148,15 +146,15 @@ Full Example
console.log("playAudio():Audio Success");
}
- // onError Callback
+ // onError Callback
//
function onError(error) {
- alert('code: ' + error.code + '\n' +
+ alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
// Set audio position
- //
+ //
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/media.play.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.play.md b/docs/en/edge/cordova/media/media.play.md
index e402ca1..cc6abf9 100644
--- a/docs/en/edge/cordova/media/media.play.md
+++ b/docs/en/edge/cordova/media/media.play.md
@@ -24,7 +24,6 @@ Starts or resumes playing an audio file.
media.play();
-
Description
-----------
@@ -61,7 +60,6 @@ Quick Example
my_media.play();
}
-
Full Example
------------
@@ -121,7 +119,7 @@ Full Example
}
// Pause audio
- //
+ //
function pauseAudio() {
if (my_media) {
my_media.pause();
@@ -129,7 +127,7 @@ Full Example
}
// Stop audio
- //
+ //
function stopAudio() {
if (my_media) {
my_media.stop();
@@ -144,15 +142,15 @@ Full Example
console.log("playAudio():Audio Success");
}
- // onError Callback
+ // onError Callback
//
function onError(error) {
- alert('code: ' + error.code + '\n' +
+ alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
// Set audio position
- //
+ //
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
@@ -189,7 +187,6 @@ iOS Quirk
var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
myMedia.play({ playAudioWhenScreenIsLocked : false })
-
- __order of file search__
When only a file name or simple path is provided, iOS will search in the www for the file and then in the application documents/tmp directory.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/media.release.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.release.md b/docs/en/edge/cordova/media/media.release.md
index e452716..fb4f82a 100644
--- a/docs/en/edge/cordova/media/media.release.md
+++ b/docs/en/edge/cordova/media/media.release.md
@@ -24,7 +24,6 @@ Releases the underlying operating systems audio resources.
media.release();
-
Description
-----------
@@ -109,7 +108,7 @@ Full Example
}
// Pause audio
- //
+ //
function pauseAudio() {
if (my_media) {
my_media.pause();
@@ -117,7 +116,7 @@ Full Example
}
// Stop audio
- //
+ //
function stopAudio() {
if (my_media) {
my_media.stop();
@@ -132,15 +131,15 @@ Full Example
console.log("playAudio():Audio Success");
}
- // onError Callback
+ // onError Callback
//
function onError(error) {
- alert('code: ' + error.code + '\n' +
+ alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
// Set audio position
- //
+ //
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/media.seekTo.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.seekTo.md b/docs/en/edge/cordova/media/media.seekTo.md
index d5cc515..96cbfc0 100644
--- a/docs/en/edge/cordova/media/media.seekTo.md
+++ b/docs/en/edge/cordova/media/media.seekTo.md
@@ -29,11 +29,10 @@ Parameters
- __milliseconds__: The position to set the playback position within the audio in milliseconds. .
-
Description
-----------
-Function `media.seekTo` is an asynchronous function that updates the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object.
+Function `media.seekTo` is an asynchronous function that updates the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object.
Supported Platforms
-------------------
@@ -57,7 +56,6 @@ Quick Example
my_media.seekTo(10000);
}, 5000);
-
Full Example
------------
@@ -116,7 +114,7 @@ Full Example
}
// Stop audio
- //
+ //
function stopAudio() {
if (my_media) {
my_media.stop();
@@ -131,15 +129,15 @@ Full Example
console.log("playAudio():Audio Success");
}
- // onError Callback
+ // onError Callback
//
function onError(error) {
- alert('code: ' + error.code + '\n' +
+ alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
// Set audio position
- //
+ //
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.startRecord.md b/docs/en/edge/cordova/media/media.startRecord.md
index ebdca73..b0dee1b 100644
--- a/docs/en/edge/cordova/media/media.startRecord.md
+++ b/docs/en/edge/cordova/media/media.startRecord.md
@@ -24,7 +24,6 @@ Starts recording an audio file.
media.startRecord();
-
Description
-----------
@@ -43,7 +42,7 @@ Quick Example
-------------
// Record audio
- //
+ //
function recordAudio() {
var src = "myrecording.mp3";
var mediaRec = new Media(src,
@@ -61,7 +60,6 @@ Quick Example
mediaRec.startRecord();
}
-
Full Example
------------
@@ -78,7 +76,7 @@ Full Example
document.addEventListener("deviceready", onDeviceReady, false);
// Record audio
- //
+ //
function recordAudio() {
var src = "myrecording.amr";
var mediaRec = new Media(src, onSuccess, onError);
@@ -110,15 +108,15 @@ Full Example
console.log("recordAudio():Audio Success");
}
- // onError Callback
+ // onError Callback
//
function onError(error) {
- alert('code: ' + error.code + '\n' +
+ alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
// Set audio position
- //
+ //
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/media.stop.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.stop.md b/docs/en/edge/cordova/media/media.stop.md
index 76d0953..777dea7 100644
--- a/docs/en/edge/cordova/media/media.stop.md
+++ b/docs/en/edge/cordova/media/media.stop.md
@@ -24,7 +24,6 @@ Stops playing an audio file.
media.stop();
-
Description
-----------
@@ -63,7 +62,7 @@ Quick Example
// Pause after 10 seconds
setTimeout(function() {
my_media.stop();
- }, 10000);
+ }, 10000);
}
Full Example
@@ -124,7 +123,7 @@ Full Example
}
// Pause audio
- //
+ //
function pauseAudio() {
if (my_media) {
my_media.pause();
@@ -132,7 +131,7 @@ Full Example
}
// Stop audio
- //
+ //
function stopAudio() {
if (my_media) {
my_media.stop();
@@ -147,15 +146,15 @@ Full Example
console.log("playAudio():Audio Success");
}
- // onError Callback
+ // onError Callback
//
function onError(error) {
- alert('code: ' + error.code + '\n' +
+ alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
// Set audio position
- //
+ //
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/media.stopRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.stopRecord.md b/docs/en/edge/cordova/media/media.stopRecord.md
index f646642..fb2ddd0 100644
--- a/docs/en/edge/cordova/media/media.stopRecord.md
+++ b/docs/en/edge/cordova/media/media.stopRecord.md
@@ -24,7 +24,6 @@ Stops recording an audio file.
media.stopRecord();
-
Description
-----------
@@ -43,7 +42,7 @@ Quick Example
-------------
// Record audio
- //
+ //
function recordAudio() {
var src = "myrecording.mp3";
var mediaRec = new Media(src,
@@ -66,7 +65,6 @@ Quick Example
}, 10000);
}
-
Full Example
------------
@@ -83,7 +81,7 @@ Full Example
document.addEventListener("deviceready", onDeviceReady, false);
// Record audio
- //
+ //
function recordAudio() {
var src = "myrecording.mp3";
var mediaRec = new Media(src, onSuccess, onError);
@@ -115,15 +113,15 @@ Full Example
console.log("recordAudio():Audio Success");
}
- // onError Callback
+ // onError Callback
//
function onError(error) {
- alert('code: ' + error.code + '\n' +
+ alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
// Set audio position
- //
+ //
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.beep.md b/docs/en/edge/cordova/notification/notification.beep.md
index e9cc33c..6bccfd0 100644
--- a/docs/en/edge/cordova/notification/notification.beep.md
+++ b/docs/en/edge/cordova/notification/notification.beep.md
@@ -111,7 +111,7 @@ iPhone Quirks
Windows Phone 7 and 8 Quirks
-------------
-- Cordova lib includes a generic beep file that is used.
+- Cordova lib includes a generic beep file that is used.
Tizen Quirks
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.confirm.md b/docs/en/edge/cordova/notification/notification.confirm.md
index dca3cc8..63e13c7 100755
--- a/docs/en/edge/cordova/notification/notification.confirm.md
+++ b/docs/en/edge/cordova/notification/notification.confirm.md
@@ -122,7 +122,6 @@ Windows Phone 7 and 8 Quirks
- You can bind `window.confirm` by assigning `window.confirm = navigator.notification.confirm;`.
- Calls to `alert` and `confirm` are non-blocking and result is only available asynchronously.
-
Bada 2.x Quirks
---------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/splashscreen/splashscreen.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/splashscreen/splashscreen.md b/docs/en/edge/cordova/splashscreen/splashscreen.md
index 53df714..93519c8 100644
--- a/docs/en/edge/cordova/splashscreen/splashscreen.md
+++ b/docs/en/edge/cordova/splashscreen/splashscreen.md
@@ -22,7 +22,6 @@ Splashscreen
> Enables developers to show/hide the application's splash screen.
-
Methods
-------
@@ -80,6 +79,5 @@ Setup
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/storage/database/database.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/database/database.md b/docs/en/edge/cordova/storage/database/database.md
index a52c8e1..8e84e45 100644
--- a/docs/en/edge/cordova/storage/database/database.md
+++ b/docs/en/edge/cordova/storage/database/database.md
@@ -25,8 +25,8 @@ Contains methods that allow the user to manipulate the Database
Methods
-------
-- __transaction__: Runs a database transaction.
-- __changeVersion__: method allows scripts to atomically verify the version number and change it at the same time as doing a schema update.
+- __transaction__: Runs a database transaction.
+- __changeVersion__: method allows scripts to atomically verify the version number and change it at the same time as doing a schema update.
Details
-------
@@ -90,7 +90,7 @@ Full Example
db.transaction(populateDB, errorCB, successCB);
}
- // Populate the database
+ // Populate the database
//
function populateDB(tx) {
tx.executeSql('DROP TABLE IF EXISTS DEMO');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/storage/localstorage/localstorage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/localstorage/localstorage.md b/docs/en/edge/cordova/storage/localstorage/localstorage.md
index 9f24c98..837302b 100644
--- a/docs/en/edge/cordova/storage/localstorage/localstorage.md
+++ b/docs/en/edge/cordova/storage/localstorage/localstorage.md
@@ -27,7 +27,7 @@ Provides access to a W3C Storage interface (http://dev.w3.org/html5/webstorage/#
Methods
-------
-- __key__: Returns the name of the key at the position specified.
+- __key__: Returns the name of the key at the position specified.
- __getItem__: Returns the item identified by it's key.
- __setItem__: Saves and item at the key provided.
- __removeItem__: Removes the item identified by it's key.
@@ -114,7 +114,6 @@ Full Example
</body>
</html>
-
Windows Phone 7 Quirks
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
index 4cbaf68..5a04a8f 100644
--- a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
+++ b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
@@ -26,13 +26,13 @@ Properties
-------
- __insertId__: the row ID of the row that the SQLResultSet object's SQL statement inserted into the database
-- __rowsAffected__: the number of rows that were changed by the SQL statement. If the statement did not affect any rows then it is set to 0.
+- __rowsAffected__: the number of rows that were changed by the SQL statement. If the statement did not affect any rows then it is set to 0.
- __rows__: a SQLResultSetRowList representing the rows returned. If no rows are returned the object will be empty.
Details
-------
-When you call the SQLTransaction executeSql method its callback methods will be called with a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowsAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.
+When you call the SQLTransaction executeSql method its callback methods is called with a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowsAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.
Supported Platforms
-------------------
@@ -83,7 +83,7 @@ Full Example
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Populate the database
+ // Populate the database
//
function populateDB(tx) {
tx.executeSql('DROP TABLE IF EXISTS DEMO');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
index 351a5d0..74fa5af 100644
--- a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
+++ b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
@@ -83,7 +83,7 @@ Full Example
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Populate the database
+ // Populate the database
//
function populateDB(tx) {
tx.executeSql('DROP TABLE IF EXISTS DEMO');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
index f26d77e..f1348f3 100644
--- a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
+++ b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
@@ -30,7 +30,7 @@ Methods
Details
-------
-When you call a Database objects transaction method it's callback methods will be called with a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
+When you call a Database objects transaction method, its callback methods is called with a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
Supported Platforms
-------------------
@@ -84,7 +84,7 @@ Full Example
db.transaction(populateDB, errorCB, successCB);
}
- // Populate the database
+ // Populate the database
//
function populateDB(tx) {
tx.executeSql('DROP TABLE IF EXISTS DEMO');
[05/46] many copy edits; nonlinear search/destroy edits;
needs a more controlled pass
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/windows-phone-7/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/windows-phone-7/index.md b/docs/en/edge/guide/getting-started/windows-phone-7/index.md
index 7cf023a..6f0ec3d 100644
--- a/docs/en/edge/guide/getting-started/windows-phone-7/index.md
+++ b/docs/en/edge/guide/getting-started/windows-phone-7/index.md
@@ -34,54 +34,54 @@ Video Tutorials:
- Windows 7 or Windows Vista with SP2
-Note: Running in VM has issues, if you are on a Mac, you will need to setup a bootcamp partition with Windows 7 or Vista
-
-Necessary for Installing on Device and Submitting to Market Place:
-
-- Become an [App Hub member](http://create.msdn.com/en-US/home/membership).
+__NOTE:__ Running in VM does not work well. If you are on a Mac, you need to set up a bootcamp partition with Windows 7 or Vista.
+- Become an [App Hub member](http://create.msdn.com/en-US/home/membership). You need to do so to install onto a device and submit the application to the market place.
2. Install SDK + Cordova
----------------------------
- Download and install [Windows Phone SDK](http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=27570/)
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the subfolder: lib\windows-phone\
-- copy the file CordovaStarter-x.x.x.zip to the folder : \My Documents\Visual Studio 2010\Templates\ProjectTemplates\
-( if the template file does not exist, you will need to build it. See 2.1 below )
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-phone` subfolder.
+- Copy the `CordovaStarter-x.x.x.zip` to the `\My Documents\Visual Studio 2010\Templates\ProjectTemplates\` folder.
+(If the template file does not exist, you need to build it as described in 2.1 below.)
if you have just installed VisualStudio, you should launch it once to create this folder
-if you prefer, you may add the project instead to the "Silverlight for Windows Phone" subfolder of "Visual C#". This is up to you, and only affects where the project template is shown when creating a new project. Also, You may need to create this folder.
+if you prefer, you may add the project instead to the "Silverlight for Windows Phone" subfolder of "Visual C#". This is up to you, and only affects where the project template is shown when creating a new project. Also, You may need to create this folder.
2.1. Building the template
-----------------------------
-( note, this step may not be required. If the lib\windows-phone directory already contains a file CordovaStarter-x.x.x.zip then you may skip this step )
-- Open the file lib\windows-phone\templates\standalone\CordovaSolution.sln in Visual Studio Express for Windows Phone
-- From the file menu, select 'Export Template...'
-- Choose template type 'Project template'
-- Give the exported template a name, ex. CordovaStarter-2.1.0 will produce CordovaStarter-2.1.0.zip
-- Optionally, you may add a description, icon image, and Preview image. These are what is displayed in Visual Studio in the 'New Project' dialog.-
-- Note: If you select ( 'Automatically import the template ... ') then you will not need to copy the .zip file over as outlined in step 2.
-- Press 'Finish'
+__NOTE:__ Skip this step if the `lib\windows-phone` directory already contains a `CordovaStarter-x.x.x.zip` file.
+
+- Open the `lib\windows-phone\templates\standalone\CordovaSolution.sln` in Visual Studio Express for Windows Phone
+- Select __Export Template...__ from the __File__ menu.
+- Choose template type __Project template__
+- Supply a name of the exported template, such as `CordovaStarter-2.1.0` to produce a `CordovaStarter-2.1.0.zip` file.
+- Optionally, add a description, icon image, or Preview image. These are displayed in Visual Studio's __New Project__ dialog.
+- __NOTE:__ If you select __Automatically import the template...__, then you don't need to copy the `.zip` file over as outlined in step 2.
+- Press __Finish__.
-3. Setup New Project
+
+
+3. Set up New Project
--------------------
- Open Visual Studio Express for Windows Phone and choose **New Project**.
-- Select **CordovaStarter**. ( the version number will be displayed in the template description )
-- - note: If you do not see it, you may have to select the top level 'Visual C#' to see it
-- Give your project a name, and select OK.
+- Select **CordovaStarter**. (The version number displays in the template description.)
+- - __NOTE:__ If you do not see it, you may have to select the top-level 'Visual C#'.
+- Give your 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.
+- Any content that you add needs to be a part of the Visual Studio project, and it must be set as content.
@@ -89,8 +89,8 @@ if you prefer, you may add the project instead to the "Silverlight for Windows P
5. Build and Deploy to Emulator
-------------------------------
-- Make sure to have **Windows Phone Emulator** selected in the top drop-down menu.
-- Hit the green **play button** beside the Windows Phone Emulator drop-down menu to start debugging or press F5.
+- 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 else type __F5__.
@@ -99,11 +99,11 @@ if you prefer, you may add the project instead to the "Silverlight for Windows P
6. Build your project for the device
------------------------------------
-In order to test your application on a device, the device must be registered. Click [here](http://msdn.microsoft.com/en-us/library/gg588378(v=VS.92).aspx) to read documentation on deploying and testing on your Windows Phone.
+To test your application on a device, the device must be registered. MSDN provides [documentation](http://msdn.microsoft.com/en-us/library/gg588378(v=VS.92).aspx) to help deploy and test your Windows Phone.
- Make sure your phone is connected, and the screen is unlocked
- In Visual Studio, select 'Windows Phone Device' from the top drop-down menu.
-- Hit the green **play button** beside the drop-down menu to start debugging or press F5.
+- 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/726c9630/docs/en/edge/guide/getting-started/windows-phone-8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/windows-phone-8/index.md b/docs/en/edge/guide/getting-started/windows-phone-8/index.md
index 4f6aa5d..4e9406f 100644
--- a/docs/en/edge/guide/getting-started/windows-phone-8/index.md
+++ b/docs/en/edge/guide/getting-started/windows-phone-8/index.md
@@ -22,12 +22,12 @@ Getting Started with Windows Phone 8
This guide describes how to set up your development environment for Cordova and run a sample application. Note that Cordova used to be called PhoneGap, so some of the sites still use the old PhoneGap name.
-Note: Applications built with Apache Cordova for Windows Phone 8 will only run on Windows Phone 8 devices. If you are looking to target both 7.5 AND 8 devices, then you should be using Apache Cordova for Windows Phone 7, which does not have all the new shiny features included in IE10, but implements the same APIs.
+__NOTE:__ Applications built with Apache Cordova for Windows Phone 8 run only on Windows Phone 8 devices. If you want to target both 7.5 'and' 8 devices, then use Apache Cordova for Windows Phone 7, which does not have all the advanced features included in IE10, but implements the same APIs.
1. System Requirements
---------------
-- Operating System:
+- Operating System:
- Windows 8 or Windows 8 Pro
- The 64-bit version (x64) of Windows is required for the SDK.
- The Pro version is recommended so you can run a device emulator.
@@ -38,7 +38,7 @@ Note: Applications built with Apache Cordova for Windows Phone 8 will only run o
- 64-bit (x64) CPU
- Windows Phone 8 Emulator
- - The phone emulator uses Hyper-V, so this list includes those pre-reqs.
+ - The phone emulator uses Hyper-V, so this list includes those pre-requisites.
- Windows 8 Pro 64-bit edition or greater
- Requires a processor that supports virtualization and [Second Level Address Translation (SLAT)](http://en.wikipedia.org/wiki/Second_Level_Address_Translation)
- See the [list of Intel processors that support VT-x (virtualization) and EPT (SLAT)](http://ark.intel.com/Products/VirtualizationTechnology)
@@ -49,57 +49,75 @@ Note: Applications built with Apache Cordova for Windows Phone 8 will only run o
- 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 and/or submit it to Market Place.
-Note: Running the SDK in Virtual Machine might present some challenges. You can read this blog post that gives insight on the solutions to develop for [Windows Phone on a Mac](http://aka.ms/BuildaWP8apponaMac).
+__NOTE:__ Running the SDK in Virtual Machine might present some challenges. You can read this blog post that gives insight on the solutions to develop for [Windows Phone on a Mac](http://aka.ms/BuildaWP8apponaMac).
2. Install SDK + Cordova
----------------------------
- Download and install [Windows Phone SDK](http://www.microsoft.com/en-us/download/details.aspx?id=35471)
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the subfolder: lib\windows-phone-8\
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-phone-8` subfolder.
- copy the file CordovaWP8AppFull-x.x.x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\
2.1. Building the template
-----------------------------
-Note: this step may not be required. If the lib\windows-phone directory already contains a file CordovaStarter-x.x.x.zip then you may skip this step.
+__NOTE:__ this step may not be required. If the lib\windows-phone directory already contains a file CordovaStarter-x.x.x.zip then you may skip this step.
In order to simplify the development process, Cordova comes with a Visual Studio template that allows creating a Cordova application rapidly. This template can be modified if needed and the below steps indicate how to proceed if you want to modify and re-generate the template.
-- Open the file lib\windows-phone\templates\standalone\CordovaSolution.sln in Visual Studio Express for Windows Phone
-- From the file menu, select 'Export Template...'
-- Choose template type 'Project template'
-- Give the exported template a name, ex. CordovaStarter-2.1.0 will produce CordovaStarter-2.1.0.zip
-- Optionally, you may add a description, icon image, and Preview image. These are what is displayed in Visual Studio in the 'New Project' dialog.-
-- Note: If you select ( 'Automatically import the template ... ') then you will not need to copy the .zip file over as outlined in step 2.
-- Press 'Finish'
+- Open the `lib\windows-phone\templates\standalone\CordovaSolution.sln` file in Visual Studio Express for Windows Phone.
+- Select __Export Template...__ from the __File__ menu.
+- Choose template type __Project template__
+- Give the exported template a name, such as `CordovaStarter-2.1.0`, which produces a `CordovaStarter-2.1.0.zip` archive.
+- Optionally, you may add a description, icon image, and preview image. These display in Visual Studio's __New Project__ dialog.
+- __NOTE:__ If you select __Automatically import the template...__, then you don't need to copy the `.zip` file over as outlined in step 2.
+- Press __Finish__
2.2 About the different templates
--------------------
-Apache Cordova for Windows Phone 8 supports 2 different types of templates.
-
-The 'Full' template includes a pre-built dll containing all the framework code for Apache Cordova. This template will create a project that is easy to update, as you can simply replace the JavaScript and .dll in your project and rebuild when a new version comes out. The downside of this approach is that because the dll contains ALL of the Cordova API, it requires all available permissions even if the APIs are not called. When you submit an app to the App store, Microsoft will run a static analyzer against your application, and detect that you require all available permissions, and place a disclaimer on you app that is presented to the user when they choose to install your app. Users may be discouraged if they see a required permission that does not make sense ( ie, why does this drawing program need access to my media library and contacts ).
-
-The 'Stand-Alone' template includes ALL the source code for Apache Cordova. This project is easier to fine-tune to use just the features you need, thereby working around the permissions issues of the 'Full' template, however this type of project will be more difficult to update, as you will need to update individual files within your project and manage any dependancies yourself. In order to exclude an API you are not using, you can simply right-click-select the Command class file in Visual Studio and choose 'do not include in project'.
-
-
-3. Setup New Project
+Apache Cordova for Windows Phone 8 supports 2 different types of templates.
+
+The 'Full' template includes a pre-built 'dll' that contains all the
+framework code for Apache Cordova. This template creates a project
+that is easy to update, as you can simply replace the JavaScript and
+'.dll' in your project and rebuild as new versions are released. The
+downside of this approach is that because the dll contains 'all' of
+the Cordova API, it requires all available permissions even if the
+APIs are not called. When you submit an app to the App store,
+Microsoft runs a static analyzer against your application, detects
+that you require all available permissions, and places a disclaimer on
+your app that is presented to the user when they choose to install
+your app. Users may be discouraged if they see a required permission
+that does not make sense ( ie, why does this drawing program need
+access to my media library and contacts ).
+
+The 'Stand-Alone' template includes _all_ the source code for Apache
+Cordova. This project is easier to fine-tune to use just the features
+you need, thereby working around the permissions issues of the 'Full'
+template, however this type of project is more difficult to update, as
+you update individual files within your project and manage any
+dependancies yourself. In order to exclude an unused API, simply
+right-click-select the __Command__ class file in Visual Studio and
+choose __do not include in project__.
+
+3. Set up New Project
--------------------
- Open Visual Studio Express for Windows Phone and choose **New Project**.
-- Select **CordovaWP8AppFull** or **CordovaWP8AppStandalone**. ( the version number will be displayed in the template description )
-- Give your project a name, and select OK.
+- Select **CordovaWP8AppFull** or **CordovaWP8AppStandalone**. (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.
+- Any content that you add here needs to be a part of the Visual Studio project, and it must be set as content.
@@ -107,8 +125,8 @@ The 'Stand-Alone' template includes ALL the source code for Apache Cordova. Thi
5. Build and Deploy to Emulator
-------------------------------
-- Make sure to have **Windows Phone Emulator** selected in the top drop-down menu.
-- Hit the green **play button** beside the Windows Phone Emulator drop-down menu to start debugging or press F5.
+- 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__.
@@ -118,9 +136,9 @@ The 'Stand-Alone' template includes ALL the source code for Apache Cordova. Thi
In order to test your application on a device, the device must be registered. Click [here](http://msdn.microsoft.com/en-us/library/gg588378(v=VS.92).aspx) to read documentation on deploying and testing on your Windows Phone 8.
-- Make sure your phone is connected, and the screen is unlocked
+- Make sure your phone is connected, and the screen is unlocked.
- In Visual Studio, select 'Device' from the top drop-down menu.
-- Hit the green **play button** beside the drop-down menu to start debugging or press F5.
+- Press the green **play** button next to the main drop-down menu to start debugging, or type __F5__.
@@ -128,7 +146,7 @@ In order to test your application on a device, the device must be registered. Cl
Done!
-----
-Further Reading
+Further Reading
-------
For more details on the specific differences between IE10 and WebKit browsers, and how to support both MS has a helpful [guide here](http://blogs.windows.com/windows_phone/b/wpdev/archive/2012/11/15/adapting-your-webkit-optimized-site-for-internet-explorer-10.aspx)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/plugin-development/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/android/index.md b/docs/en/edge/guide/plugin-development/android/index.md
index e262c8a..01ab080 100644
--- a/docs/en/edge/guide/plugin-development/android/index.md
+++ b/docs/en/edge/guide/plugin-development/android/index.md
@@ -23,27 +23,29 @@ Writing a plugin requires an understanding of the architecture of Cordova-Androi
of an Android WebView with hooks attached to it. These plugins are represented as class mappings in the config.xml
file.
-A plugin will consist of at least a single Java class that extends the `CordovaPlugin` class. A plugin must override one
-of the `execute` methods from `CordovaPlugin`. In addition to this, there is a best practice that
-the plugin should handle pause and resume events, and should handle message passing between plugins.
-Plugins with long-running requests, background activity (e.g. playing media), 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.
+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 payback, 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.
-## Plugin Class Mapping
+## Plugin Class Mapping
The JavaScript portion of a plugin always uses the `cordova.exec` method as follows:
exec(<successFunction>, <failFunction>, <service>, <action>, [<args>]);
-This will marshal a request from the WebView to the Android native
-side, more or less boiling down to calling the `action` method on the
+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.
<plugin name="<service_name>" value="<full_name_including_namespace>"/>
-The service name should match what you use in the JavaScript `exec` call, and the value will be the full name of the Java class including the namespace. Without this added, the plugin may compile but
-will not be reachable by Cordova.
+The service name should match the one used in the JavaScript `exec`
+call, and the value is the Java classes full name, including the
+namespace. Otherwise the plugin may compile but still be unreachable
+by Cordova.
## Writing an Android Java Plugin
@@ -65,11 +67,13 @@ implementations look like this:
return false; // Returning false results in a "MethodNotFound" error.
}
-We compare the value of the `action` parameter, and dispatch
-the request off to a (private) method in the class, optionally passing
+We compare the value of the `action` parameter, and dispatch the
+request off to a (private) method in the class, optionally passing
some of the parameters to the method.
-When catching exceptions and returning errors, it's important that the error we return to JavaScript match the Java exception as much as possible, for clarity.
+When catching exceptions and returning errors, it's important for the
+sake of clarity that errors returned to JavaScript match Java's
+exception names as much as possible.
### Threading
@@ -135,7 +139,7 @@ application:
@Override
public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
if (action.equals("echo")) {
- String message = args.getString(0);
+ String message = args.getString(0);
this.echo(message, callbackContext);
return true;
}
@@ -143,7 +147,7 @@ application:
}
private void echo(String message, CallbackContext callbackContext) {
- if (message != null && message.length() > 0) {
+ if (message != null && message.length() > 0) {
callbackContext.success(message);
} else {
callbackContext.error("Expected one non-empty string argument.");
@@ -151,38 +155,38 @@ application:
}
}
-Let's take a look at the code. At the top we have all of the necessary
-Cordova `imports`. Our class extends from `CordovaPlugin`. We override
-the execute() method in order to recieve messages from exec(). Our method
-first compares against `action`: this plugin only supports
-one action, the `echo` action. Any other action will return false, which
-results in an error of type `INVALID_ACTION` - this will translate
-into an error callback invocation on the JavaScript side. Next, we grab
-the echo string using the `getString` method on our `args`, telling it
-we want to get the 0th parameter in the parameter array. We do a bit of
-parameter checking: make sure it is not `null`, and make sure it is not
-a zero-length string. If it is, we call callbackContext.error() (which,
-by now, you should know will invoke the error callback). If all of those
-checks pass, then we call callbackContext.success(), and pass in the
-`message` string we received as a parameter. This will finally translate
-into a success callback invocation on the JavaScript side. It will also
-pass the `message` parameter as a parameter into the JavaScript success
-callback function.
+Let's take a look at the code. The necessary Cordova `imports` are at
+the top. Our class extends from `CordovaPlugin`. We override the
+execute() method in order to recieve messages from exec(). Our method
+first compares against `action`: this plugin only supports one action,
+the `echo` action. Any other action returns false, which results in an
+error of type `INVALID_ACTION`, which translates into an error
+callback invocation on the JavaScript side. Next, we grab the echo
+string using the `getString` method on our `args`, telling it we want
+to get the 0th parameter in the parameter array. We do a bit of
+parameter checking: make sure it is not `null`, and make sure it is
+not a zero-length string. If it is, we call `callbackContext.error()`
+(which, by now, you should know invokes the error callback). If all of
+those checks pass, then we call `callbackContext.success()` and pass
+in the `message` string we received as a parameter. This finally
+translates into a success callback invocation on the JavaScript
+side. It also passes the `message` parameter as a parameter into the
+JavaScript success callback function.
## Debugging Plugins
-Eclipse can be used to debug an Android project, and the plugins can be debugged if the Java source is included in the project. Only the latest version of the Android Dev Tools is known to allow source code attachment to JAR dependencies, this is not fully supported at this time.
+Eclipse can be used to debug an Android project, and the plugins can be debugged if the Java source is included in the project. Only the latest version of the Android Developer Tools is known to allow source code attachment to JAR dependencies, so this is not fully supported at this time.
## Common Pitfalls
* 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 the methods that `ctx` has exist on the `Context`, so both `getContext()` and `getActivity()` are capable of returning the proper object required.
+* 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
One of the best ways to prepare yourself to write your own plugin is to
-have a [look at other plugins that already exist](https://github.com/apache/cordova-android/tree/master/framework/src/org/apache/cordova).
+[look over existing plugins](https://github.com/apache/cordova-android/tree/master/framework/src/org/apache/cordova).
You should also read through the comments in [CordovaPlugin.java](https://github.com/apache/cordova-android/blob/master/framework/src/org/apache/cordova/api/CordovaPlugin.java).
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/plugin-development/bada/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/bada/index.md b/docs/en/edge/guide/plugin-development/bada/index.md
index 3e059a8..a33b98c 100644
--- a/docs/en/edge/guide/plugin-development/bada/index.md
+++ b/docs/en/edge/guide/plugin-development/bada/index.md
@@ -22,13 +22,13 @@ Developing a Plugin on Bada
Plugins are only supported on Bada 2.0 and above. Bada 1.2 does not support plugins.
-The Bada implementation is a full javascript implementation. Therefore, adding a custom plugin involves updating CordovaJS with your plugin code. Follow these steps to add a simple _Hello World_ plugin:
+The Bada implementation is a full JavaScript implementation. Therefore, adding a custom plugin involves updating CordovaJS with your plugin code. Follow these steps to add a simple _Hello World_ plugin:
1. Clone the CordovaJS repository
git clone https://git-wip-us.apache.org/repos/asf/cordova-js.git
-2. Create a new javascript file under __lib/bada/plugin/bada/__ and name it _HelloWorld.js_. Add the following content:
+2. Create a new JavaScript file under __lib/bada/plugin/bada/__ and name it _HelloWorld.js_. Add the following content:
function HelloWorld() {
}
@@ -40,11 +40,11 @@ The Bada implementation is a full javascript implementation. Therefore, adding a
module.exports = new HelloWorld();
3. Add a link to your newly created plugin in __lib/bada/platform.js__ under the objects property:
-
+
objects: {
...
HelloWorld: {
- 'cordova/plugin/bada/HelloWorld'
+ 'cordova/plugin/bada/HelloWorld'
},
...
}
@@ -55,7 +55,7 @@ The Bada implementation is a full javascript implementation. Therefore, adding a
...
"HelloWorld": require('cordova/plugin/bada/HelloWorld')
};
-5. Now you can write your user-facing javascript however you like but remember that in order for your plugin to execute you need to call the following method
+5. Now you can write your user-facing JavaScript however you like but remember that in order for your plugin to execute you need to call the following method
exec(success, fail, 'HelloWorld', 'printHello', ['Jackson!']);
@@ -65,10 +65,10 @@ The Bada implementation is a full javascript implementation. Therefore, adding a
'printHello' is your plugin action
Finally, the last argument is your plugin parameters (if any).
-6. Run the following command to generate the new common javascript (make sure you have the jake npm module installed)
+6. Run the following command to generate the new common JavaScript (make sure you have the jake npm module installed)
jake
-7. Copy the newly generated javascript under __pkg/cordova.bada.js__ to your Bada project under __Res/js__
+7. Copy the newly generated JavaScript under __pkg/cordova.bada.js__ to your Bada project under __Res/js__
6. That is it! You can now add new Bada plugins and implement the many features that are not currently supported by Cordova Bada.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/plugin-development/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/blackberry/index.md b/docs/en/edge/guide/plugin-development/blackberry/index.md
index 84394e8..d7c8dea 100644
--- a/docs/en/edge/guide/plugin-development/blackberry/index.md
+++ b/docs/en/edge/guide/plugin-development/blackberry/index.md
@@ -22,19 +22,23 @@ Developing a Plugin on BlackBerry
## How to make the Echo plugin on Blackberry
-In this article, we will explore how to develop the Echo plugin on BlackBerry. If you haven't read the
-top level article about the JavaScript part of the plugin, it would be best if you read that first
-and then this article. In addition, please download the [Cordova Blackberry repo](https://git-wip-us.apache.org/repos/asf?p=cordova-blackberry-webworks.git;a=summary).
-
-To note, the Cordova-BlackBerry project allows you to deploy to BlackBerry devices like the
-Torch, Bold, etc and as well as the Playbook. There exists a distinction between deploying to
-normal BlackBerry hand held devices (ie, Torch and Bold) and the Playbook. The code base between
-the two are separate so when you develop for one, you have to duplicate your efforts for the other!
-Therefore in this article, the focus will be on the hand held devices and not the tablet. In the future,
-this guide should cover both platforms.
-
-Continuing on from the previous article, the Echo plugin is essentially returning whatever message a user
-provides to the `window.echo` function.
+This guide explores how to develop the Echo plugin on BlackBerry.
+If you haven't read the top-level guide about the JavaScript part of
+the plugin, it would be best if you read that first and then this
+guide. In addition, please download the [Cordova Blackberry
+repo](https://git-wip-us.apache.org/repos/asf?p=cordova-blackberry-webworks.git;a=summary).
+
+The Cordova-BlackBerry project allows you to deploy to BlackBerry
+devices such a the Torch and Bold, as well as the Playbook. There's a
+difference between deploying to normal BlackBerry handheld devices and
+the Playbook. They use two different code bases, so when you develop
+for one, you have to duplicate your efforts for the other! This guide
+focuses on the handheld devices rather than the tablet. (In the future,
+this guide should cover both platforms.)
+
+Continuing on from the previous guide, the Echo plugin essentially
+returns whatever message a user provides to the `window.echo`
+function.
The Echo function:
@@ -46,9 +50,11 @@ The Echo function:
## Modifying plugins.xml
-This file resides in your project's www folder and contains all of the references to the plugins that
-your Cordova project uses. We are going to add an additional reference so that when cordova.exec is called,
-Cordova will know how to map the "Echo" argument of `cordova.exec` to the Echo class that we want to write natively.
+Your project's `www/plugins.xml` folder 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>
...
@@ -58,20 +64,24 @@ Cordova will know how to map the "Echo" argument of `cordova.exec` to the Echo c
## 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 BlackBerry. cd into the folder
-structure until you reach the path: `framework/ext/src/org/apache/cordova`. At this point, you'll see
-all of the plugin folders and inside each folder is the plugins' source code. So, we will add
-the folder 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`.
+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
+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
+`framework/ext/src/org/apache/cordova/echo` and create a file called
+`Echo.java` at `framework/ext/src/org/apache/cordova/echo/Echo.java`.
## Writing Echo.java
-The basic idea of writing a plugin is to create a class that extends the Plugin class and have
-a method called execute to return a PluginResult class. Any call to cordova.exec will pass in
-the action that we want to execute within the class as well as the arguments. In this case,
-"echo" is the action we want to execute within the class "Echo" and [str] are the arguments we are passing in.
+The basic idea behind writing a plugin is to create a class that
+extends the Plugin class and have a method called `execute` to return
+a `PluginResult` class. Any call to `cordova.exec` passes in the
+action to execute within the class, as well as the arguments. In this
+case, "echo" is the action we want to execute within the class "Echo"
+and [str] are the arguments we are passing in.
package org.apache.cordova.echo;
@@ -82,7 +92,7 @@ the action that we want to execute within the class as well as the arguments. In
import org.apache.cordova.json4j.JSONObject;
/**
* A simple plugin to demonstrate how to build a plugin for Blackberry
- * Basically echos back the msg that a user calls to this plugin
+ * Basically echos back the msg that a user calls to this plugin
*/
public final class Echo extends Plugin {
@@ -93,7 +103,7 @@ the action that we want to execute within the class as well as the arguments. In
if(action.equals(echo)){
try {
String theMsg = args.getString(0);
- if(theMsg!= null || theMsg.length()>0){
+ if(theMsg!= null || theMsg.length()>0){
result = new PluginResult(PluginResult.Status.OK, theMsg);
}else{
result = new PluginResult(PluginResult.Status.ERROR, "Nothing to echo.");
@@ -108,29 +118,36 @@ the action that we want to execute within the class as well as the arguments. In
}
-So if we look at the code above, we can see that within the execute method, we are first looking for
-what actions are coming in. The Echo plugin has only one action, "echo" so we will be only checking for
-that. If our plugin had more actions, it's simply a matter of adding more if-conditionals to check
-for those actions.
-
-We are then going to grab the message coming in from the arguments which is supplied by the args parameter.
-We can grab the first argument by simply doing `String theMsg = args.getString(0);`.
-
-We will do some error checking and if the message looks okay, we will instantiate a new PluginResult with
-an ok status: PluginResult.Status.OK and return the message: theMsg. After this, we will then return the
-result which will then pass back to JavaScript to be fired in the success callback. If something should fail,
-we can return various status exceptions like PluginResult.Status.ERROR, PluginResult.Status.JSON_EXCEPTION,
-or PluginResult.Status.INVALID_ACTION. When these types of results are passed back, they will fire the fail
-callback in JavaScript.
+So if we look at the code above, we can see that within the execute
+method, we are first looking for what actions are coming in. The Echo
+plugin has only one action, "echo", so we will be only checking for
+that. If our plugin had more actions, it's simply a matter of adding
+more conditional tests to check for those actions.
+
+We are then going to grab the message coming in from the arguments
+which is supplied by the args parameter. We can grab the first
+argument by simply doing `String theMsg = args.getString(0);`.
+
+We will do some error checking and if the message looks okay, we will
+instantiate a new PluginResult with an ok status:
+`PluginResult.Status.OK` and return the message: `theMsg`. After this,
+we return the result which to be passed back to JavaScript to be fired
+in the success callback. If something fails, we can return various
+status exceptions like `PluginResult.Status.ERROR`,
+`PluginResult.Status.JSON_EXCEPTION`, or
+`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
-The addition of the Echo.java needs to be updated in your project so to build the .jar file, cd
-to the root directory of the BlackBerry WebWorks repo. Use the ant command:
+The added `Echo.java` needs to be updated in your project. To build
+the `.jar` file, Navigate to the BlackBerry WebWorks repo's root
+directory and run the `ant` command:
ant update -Dproject.path="~/path_to_my_project"
-This will build a new .jar file in the build/ext folder. Copy the `build/ext/cordova.jar` file into your
-project/www/ext folder.
+This builds a new `.jar` file in the `build/ext` directory. Copy the
+`build/ext/cordova.jar` file into your `project/www/ext` directory.
-If all goes well, that should allow you to use the Echo plugin in BlackBerry.
+If all goes well, that allows you to use the Echo plugin in
+BlackBerry.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/plugin-development/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/index.md b/docs/en/edge/guide/plugin-development/index.md
index 2c6f0cf..6201c95 100644
--- a/docs/en/edge/guide/plugin-development/index.md
+++ b/docs/en/edge/guide/plugin-development/index.md
@@ -23,18 +23,17 @@ A Cordova plugin bridges a bit of functionality between the WebView
powering a Cordova application and the native platform the Cordova
application is running on. Plugins are composed of a single JavaScript
interface used across all platforms, and native implementations
-following platform-specific Plugin interfaces that the JavaScript will
-call into. It should be noted that all of the core Cordova APIs are
-implemented using this exact architecture.
+following platform-specific Plugin interfaces that the JavaScript
+calls into. All of the core Cordova APIs are implemented using this
+architecture.
-This guide will go through each step necessary to write a simple Echo
-Plugin. The Echo Plugin will pass a string from JavaScript and send it
-into the native environment for the supported platforms. The native code
-will then return the same string back into the callbacks inside the
-plugin's JavaScript.
+This guide steps the process of writing a simple Echo Plugin that
+passes a string from JavaScript and sends it into the native
+environment for the supported platforms. The native code then returns
+the same string back to the callbacks inside the plugin's JavaScript.
-This guide should give anyone the necessary overview and level of
-detail to write more complex plugins.
+This guide provides enough overview on which you can build to write
+more complex plugins.
## JavaScript
@@ -54,20 +53,19 @@ thing you _must_ use to communicate between the Cordova JavaScript
The parameters explained in more detail:
1. `function(winParam) {}` - Success function callback. Assuming your
- `exec` call completes successfully, this function will be invoked
- (optionally with any parameters you pass back to it)
+ `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 will be invoked (optionally
- with an error parameter)
+ 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
- will be mapped to a native class. More on this in the native guides
- below
+ 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. For more detail
- please check out the native guides located at the end of this article.
-5. `[/* arguments */]` - Arguments to get passed into the native
- environment
+ platform, essentially maps to a class's method.
+ The native guides listed below provide details.
+5. `[/* arguments */]` - Arguments to pass into the native environment.
### Echo Plugin JavaScript Example
@@ -93,15 +91,15 @@ which is the first parameter into the `window.echo` function.
The success callback passed into `exec` is simply a reference to the
callback function that `window.echo` takes. We do a bit more for the
error callback: if the native side fires off the error callback, we
-simply invoke the success callback and pass into it a "default" string.
+simply invoke the success callback and pass into it a "default"
+string.
## Native
-Once you have defined a JavaScript for your plugin, you need to
-complement it with at least one native implementation. Below are
-specific guides for each platform Cordova supports. The below guides
-will continue on building the simple Echo Plugin example we started in
-this guide.
+Once you define JavaScript for your plugin, you need to complement it
+with at least one native implementation. Details to do so for each
+platform are listed below. These guides continue to build on the
+simple Echo Plugin example discussed above.
- Developing a Plugin on Android
- Developing a Plugin on Bada
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/plugin-development/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/ios/index.md b/docs/en/edge/guide/plugin-development/ios/index.md
index f1de066..09b0f0c 100644
--- a/docs/en/edge/guide/plugin-development/ios/index.md
+++ b/docs/en/edge/guide/plugin-development/ios/index.md
@@ -23,19 +23,25 @@ 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.
-## Plugin Class Mapping
+## Plugin Class Mapping
The JavaScript portion of a plugin always uses the `cordova.exec` method as follows:
exec(<successFunction>, <failFunction>, <service>, <action>, [<args>]);
-This will marshal 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.
+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 the `config.xml` file in your Cordova-iOS application's project folder.
+The plugin must be added under the `<plugins>` tag of your Cordova-iOS
+application's project's `config.xml` file.
<plugin name="service_name" value="PluginClassName" />
-The key `service_name` should match what you use in the JavaScript `exec` call, and the value will be the name of the Objective-C class of the plugin. Without this added, the plugin may compile but will not be reachable by Cordova.
+The key `service_name` should match what you use in the JavaScript
+`exec` call, and the value matches the name of the plugin's
+Objective-C class. Otherwise the plugin may compile but would not be
+reachable by Cordova.
## Plugin Initialization and Lifetime
@@ -45,7 +51,7 @@ There is one instance of a plugin object that is created per-UIWebView, and the
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
@@ -61,28 +67,32 @@ What gets dispatched to the plugin via JavaScript's `exec` function gets passed
if (myarg != nil) {
pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK];
- } else {
+ } else {
pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Arg was null"];
}
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
-
+
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
-Using CDVPluginResult you can return a variety of result types back to your javascript callbacks, using class methods that look like:
+Using CDVPluginResult you can return a variety of result types back to your JavaScript callbacks, using class methods that look like:
+ (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAs...
-The types you can create are: `String`, `Int`, `Double`, `Bool`, `Array`, `Dictionary`, `ArrayBuffer`, and `Multipart`. Or, don't attach any arguments (just send a status). Or, return an Error. You can even chose to not send any plugin result at all (your callback will not fire).
+You can create `String`, `Int`, `Double`, `Bool`, `Array`,
+`Dictionary`, `ArrayBuffer`, and `Multipart` types. Or, don't attach
+any arguments (just send a status). Or, return an Error. You can
+even choose to not send any plugin result at all, in which case the
+callback does not fire.
### Notes
- * `messageAsArrayBuffer` expects `NSData*` and will convert to an `ArrayBuffer` for your javascript callback (and `ArrayBuffers` sent to a plugin from javascript are converted to `NSData*`).
- * `messageAsMultipart` expects an `NSArray*` containing any of the other supported types, and will send the whole array as the `arguments` to your javascript callback.
+ * `messageAsArrayBuffer` expects `NSData*` and converts to an `ArrayBuffer` for your JavaScript callback (and `ArrayBuffers` sent to a plugin from JavaScript are converted to `NSData*`).
+ * `messageAsMultipart` expects an `NSArray*` containing any of the other supported types, and sends the whole array as the `arguments` to your JavaScript callback.
* Quirk: this is not just syntactic sugar (though it is sweet). This way, all of the arguments are serialized/deserialized as necessary. e.g. it is safe to return `NSData*` as multipart, but not as `Array`/`Dictionary`.
## Plugin Signatures
@@ -95,7 +105,7 @@ The **old (deprecated)** signature is:
- (void)myMethod:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options;
-Basically, the options dictionary has been removed for the new signature, and the callbackId is not the 0th index item for the arguments array, but it is now in a separate property.
+Basically, the options dictionary has been removed for the new signature, and the callbackId is not the 0th index item for the arguments array, but it is now in a separate property.
## Echo Plugin iOS Plugin
@@ -115,9 +125,9 @@ application folder:
- (void)echo:(CDVInvokedUrlCommand*)command;
@end
-
+
/********* Echo.m Cordova Plugin Implementation *******/
-
+
#import "Echo.h"
#import <Cordova/CDV.h>
@@ -140,17 +150,29 @@ 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.
+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.
-This plugin only supports one action, the `echo` action. First, we grab the echo string using the `objectAtIndex` method on our `args`, telling it we want to get the 0th parameter in the arguments array. We do a bit of parameter checking: make sure it is not `nil`, and make sure it is not a zero-length string.
+This plugin only supports one action, the `echo` action. First, we
+grab the echo string using the `objectAtIndex` method on our `args`,
+telling it we want to get the 0th parameter in the arguments array. We
+do a bit of parameter checking: make sure it is not `nil`, and make
+sure it is not a zero-length string.
-If it is, we return a `PluginResult` with an `ERROR` status. If all of those checks pass, then we return a `PluginResult` with an `OK` status, and pass in the `echo` string we received in the first place as a parameter.
+If it is, we return a `PluginResult` with an `ERROR` status. If all of
+those checks pass, then we return a `PluginResult` with an `OK`
+status, and pass in the `echo` string we received in the first place
+as a parameter.
-Finally, we send the result to `self.commandDelegate`, which will execute the JavaScript that will callback to success or failure callbacks of the exec method on the JavaScript side. If the success callback was called, it will pass the `echo` parameter as a parameter.
+Finally, we send the result to `self.commandDelegate`, which executes
+the `exec` method's success or failure callbacks on the JavaScript
+side. If the success callback is called, it passes in the `echo`
+parameter.
## Threading
-Plugin methods are executed on the UI thread. If your plugin requires a non-trivial amount of processing or requires a blocking call, you should make use of a background thread. An example:
+Plugin methods are executed in the same thread as the UI. If your
+plugin requires a great deal of processing or requires a blocking
+call, you should use a background thread. For example:
- (void)myPluginMethod:(CDVInvokedUrlCommand*)command
{
@@ -172,18 +194,22 @@ 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)
-For example, you can hook into the pause, resume, app terminate and handleOpenURL events.
+For example, you can hook into the `pause`, `resume`, app terminate and `handleOpenURL` events.
## Debugging Plugins
-To debug the Objective-C side, you would use Xcode's built in debugger. For JavaScript, on iOS 5.0 you can use [Weinre, an Apache Cordova Project](https://github.com/apache/cordova-weinre) or [iWebInspector, a third-party utility](http://www.iwebinspector.com/)
+To debug the Objective-C side, you would use Xcode's built-in debugger.
+For JavaScript, on iOS 5.0 you can use
+[Weinre, an Apache Cordova Project](https://github.com/apache/cordova-weinre) or
+[iWebInspector, a third-party utility](http://www.iwebinspector.com/)
-For iOS 6, you would use Safari 6.0 to simply attach to your app running in the iOS 6 Simulator.
+For iOS 6, you would use Safari 6.0 to simply attach to your app
+running in the iOS 6 Simulator.
## Common Pitfalls
-* Don't forget to add your plugin's mapping to config.xml - if you forgot, an error will be printed to the Xcode console log
-* Don't forget to add any hosts you connect to in the [whitelist](guide_whitelist_index.md.html#Domain%20Whitelist%20Guide) - if you forgot, an error will be printed to the Xcode console log
+* 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](guide_whitelist_index.md.html#Domain%20Whitelist%20Guide). If you forget, an error is logged in the Xcode console.
## Deprecated Plugin Signature Note
@@ -191,4 +217,13 @@ The **old (deprecated)** signature is:
- (void) myMethod:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options;
-The options parameter for the Objective-C plugin method is deprecated, and it should not be used. For legacy reasons - the last JavaScript object passed in the args Array will be passed in as the options dictionary of the method in Objective-C. You must make sure that any JavaScript object that is passed in as an element in the args array occurs as the last item in the Array, if not it will throw off the array index of all subsequent parameters of the Array in Objective-C. Only one JavaScript object is supported for the options dictionary, and only the last one encountered will be passed to the native method. It is because of these error-prone reasons that they are being deprecated.
+The Objective-C plugin method's `options` parameter is deprecated, and
+should not be used. For legacy reasons, the last JavaScript object
+passed in the `args` array is passed in as the `options` dictionary of
+the Objective-C method. You must make sure that any JavaScript object
+that is passed in as an element in the `args` appears as the last item
+in the array. Otherwise it throws off the array index for all
+subsequent parameters of the Objective-C array. Only one JavaScript
+object is supported for the options dictionary, and only the last one
+encountered will be passed to the native method. Errors stemming from
+this problem are the reason `options` has been deprecated.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/plugin-development/windows-phone/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/windows-phone/index.md b/docs/en/edge/guide/plugin-development/windows-phone/index.md
index c2ec89d..6ec0bd3 100644
--- a/docs/en/edge/guide/plugin-development/windows-phone/index.md
+++ b/docs/en/edge/guide/plugin-development/windows-phone/index.md
@@ -22,7 +22,7 @@ Developing a Plugin on Windows Phone
Writing a plugin for Cordova on Windows Phone requires a basic understanding of
the architecture of Cordova. Cordova-WP7 consists of a WebBrowser which hosts the
-application javascript code and manages native API calls. There is a BaseCommand
+application JavaScript code and manages native API calls. There is a BaseCommand
(`WP7CordovaClassLib.Cordova.Commands.BaseCommand`) class in C# which you can extend,
and it comes with the majority of the 'plumbing' built for you already.
@@ -64,8 +64,9 @@ The default namespace for unqualified commands is:
// ...
}
-If you would like to use your own namespace, you will need to make a fully qualified
-call to `cordova.exec`. For example, if you wanted to define your C# class like this:
+If you want to use your own namespace, you need to make a fully
+qualified call to `cordova.exec`. For example, if you want to define
+your C# class like this:
namespace com.mydomain.cordovaExtensions
{
@@ -75,7 +76,7 @@ call to `cordova.exec`. For example, if you wanted to define your C# class like
}
}
-Then, in JS you would need to call exec like this:
+Then, in JS you need to call `exec` like this:
cordova.exec(win, fail, "com.mydomain.cordovaExtensions.Echo", ...);
@@ -88,12 +89,12 @@ Looking back at our JS call to `cordova.exec`, we see we passed `[str]`:
cordova.exec(win, fail, "Echo", "echo", ["input string"]);
-If we inspect the options string passed in to our `Echo.echo` method, we will
-see that the value is actually:
+If we inspect the options string passed in to our `Echo.echo` method,
+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.
@@ -110,7 +111,7 @@ you can can simply call:
DispatchCommandResult(); // calls back with an empty plugin result, considered a success callback
-To pass data back, you will need to call a different version of `DispatchCommandResult`:
+To pass data back, you need to call a different version of `DispatchCommandResult`:
DispatchCommandResult(new PluginResult(PluginResult.Status.OK, "Everything went as planned, this is a result that is passed to the success handler."));
@@ -130,13 +131,13 @@ in case we have bad input. This is a pattern used throughout the Cordova C# code
string optVal = null;
- try
+ try
{
optVal = JsonHelper.Deserialize<string[]>(options)[0];
}
catch(Exception)
{
- // simply catch the exception, we will handle null values and exceptions together
+ // simply catch the exception, we handle null values and exceptions together
}
if (optVal == null)
@@ -162,8 +163,9 @@ For example, you can hook into the 'pause' and 'resume' application events.
To debug the C# side, you can use Visual Studio's debugger, just set a break point
at any of the methods exposed by your class.
-Javascript is a little more difficult to debug on Windows Phone, you will need to
-use `console.log` to output the state of your plugin, or inform yourself of errors.
+JavaScript is a little more difficult to debug on Windows Phone. You
+need to use `console.log` to output the state of your plugin, or
+inform yourself of errors.
Common Pitfalls
---------------
@@ -175,7 +177,7 @@ Common Pitfalls
cordova.exec(win, fail, "ServiceName", "MethodName", ["this is a string", 54, {literal:'trouble'}]);
- - This will mean that your C# code will receive a difficult to decode string value, such as:
+ - This means that your C# code receives a difficult to decode string value, such as:
"[\"this is a string\", 54, { literal:'trouble' }]"
@@ -185,7 +187,8 @@ Common Pitfalls
string[] optValues = JsonHelper.Deserialize<string[]>(options);
-- It is usually a good idea to do parameter checking in your JavaScript code,
- before you call exec. This will let you re-use more JS code between different
- native implementations of your plugin.
+- 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
+ implementations.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/project-settings/bada/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/bada/index.md b/docs/en/edge/guide/project-settings/bada/index.md
index f5507d9..6d3f7a6 100644
--- a/docs/en/edge/guide/project-settings/bada/index.md
+++ b/docs/en/edge/guide/project-settings/bada/index.md
@@ -19,6 +19,6 @@
#
-->
-Project Settings for Bada
+Project Settings for Bada
===================================
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/project-settings/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/blackberry/index.md b/docs/en/edge/guide/project-settings/blackberry/index.md
index c08e3fe..69b870b 100644
--- a/docs/en/edge/guide/project-settings/blackberry/index.md
+++ b/docs/en/edge/guide/project-settings/blackberry/index.md
@@ -19,7 +19,11 @@
#
-->
-Project Settings for BlackBerry
+Project Settings for BlackBerry
===================================
-BlackBerry has full support for the [W3C Widget Specfication](http://www.w3.org/TR/widgets/) as well as proprietary RIM extensions. Please see the full [BlackBerry WebWorks documentation regarding config.xml](https://developer.blackberry.com/html5/documentation/working_with_config_xml_file_1866970_11.html) for details.
+BlackBerry fully supports the
+[W3C Widget Specification](http://www.w3.org/TR/widgets/)
+as well as proprietary RIM extensions. Please see the full
+[BlackBerry WebWorks documentation regarding config.xml](https://developer.blackberry.com/html5/documentation/working_with_config_xml_file_1866970_11.html)
+for details.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/project-settings/firefoxos/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/firefoxos/index.md b/docs/en/edge/guide/project-settings/firefoxos/index.md
index 89f53b8..aed24a3 100644
--- a/docs/en/edge/guide/project-settings/firefoxos/index.md
+++ b/docs/en/edge/guide/project-settings/firefoxos/index.md
@@ -19,6 +19,6 @@
#
-->
-Project Settings for FirefoxOS
+Project Settings for FirefoxOS
===================================
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/project-settings/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/index.md b/docs/en/edge/guide/project-settings/index.md
index 3dfb4f5..ab90101 100644
--- a/docs/en/edge/guide/project-settings/index.md
+++ b/docs/en/edge/guide/project-settings/index.md
@@ -21,9 +21,9 @@ Project Settings
================
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.
+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.
+The location of the `config.xml` file is different depending on the platform. The contents, in general, are not.
## Platform-Specific Properties
@@ -62,14 +62,19 @@ A list of supported elements across major platforms which are supported in Apach
### `<plugin>`
-These elements map to native APIs that the application will be able to access. 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.
+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.
### `<access>`
-These elements define how your whitelist works. Please see the Domain Whitelist Guide for more information.
+These elements define how your whitelist works. Please see the
+Domain Whitelist Guide for more information.
### `<content>`
-This element defines the start page of your application, relative to the project's standard web assets root folder. The default is "index.html".
+This element defines your application's start page relative to the
+project's standard web assets root folder. The default is
+`index.html`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/project-settings/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/ios/index.md b/docs/en/edge/guide/project-settings/ios/index.md
index a401f10..ed4404d 100644
--- a/docs/en/edge/guide/project-settings/ios/index.md
+++ b/docs/en/edge/guide/project-settings/ios/index.md
@@ -57,4 +57,4 @@ Various preferences (as **<preference>** tags) default on not breaking exi
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.
\ No newline at end of file
+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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/project-settings/webos/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/webos/index.md b/docs/en/edge/guide/project-settings/webos/index.md
index bd47e17..ad1ab0d 100644
--- a/docs/en/edge/guide/project-settings/webos/index.md
+++ b/docs/en/edge/guide/project-settings/webos/index.md
@@ -19,7 +19,7 @@
#
-->
-Project Settings for webOS
+Project Settings for webOS
===================================
-WebOS does not currently have any additional configurable features.
\ No newline at end of file
+WebOS does not currently have any additional configurable features.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/project-settings/windows8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/windows8/index.md b/docs/en/edge/guide/project-settings/windows8/index.md
index e38dbbb..7a4f706 100644
--- a/docs/en/edge/guide/project-settings/windows8/index.md
+++ b/docs/en/edge/guide/project-settings/windows8/index.md
@@ -19,7 +19,7 @@
#
-->
-Project Settings for Windows 8
+Project Settings for Windows 8
===================================
Windows 8 does not currently support this feature.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/project-settings/wp7/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/wp7/index.md b/docs/en/edge/guide/project-settings/wp7/index.md
index 9c4a410..8c4da6c 100644
--- a/docs/en/edge/guide/project-settings/wp7/index.md
+++ b/docs/en/edge/guide/project-settings/wp7/index.md
@@ -19,7 +19,7 @@
#
-->
-Project Settings for Windows Phone 7
+Project Settings for Windows Phone 7
===================================
-Windows Phone 7 does not currently have any additional configurable features.
\ No newline at end of file
+Windows Phone 7 does not currently have any additional configurable features.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/upgrading/bada/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/bada/index.md b/docs/en/edge/guide/upgrading/bada/index.md
index 52d73ab..52f16fb 100644
--- a/docs/en/edge/guide/upgrading/bada/index.md
+++ b/docs/en/edge/guide/upgrading/bada/index.md
@@ -33,9 +33,9 @@ older version to a current version of Cordova.
## Upgrade to 1.8.x from 1.7.0 ##
-1. Remove the cordova.bada.js file from the Res/js directory
-2. Add the new cordova.js file to your Res/js directory
-3. Update your Res/index.html to reference cordova.js instead of cordova.bada.js
+1. Remove the cordova.bada.js file from the Res/js directory
+2. Add the new cordova.js file to your Res/js directory
+3. Update your Res/index.html to reference cordova.js instead of cordova.bada.js
Change this line:
@@ -44,5 +44,6 @@ to:
<script type="text/javascript" src="./js/cordova.js"></script>
-As of Cordova 1.8, Bada 1.2 is no longer supported! The repository will be kept
-there as an archive for people who still want to use it. It contains some outdated APIs.
+As of Cordova 1.8, Bada 1.2 is no longer supported! The repository
+remains as an archive for people who still want to use it. It contains
+some outdated APIs.
[08/46] docs commit: collapse whitespace
Posted by mw...@apache.org.
collapse whitespace
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/7cc8809b
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/7cc8809b
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/7cc8809b
Branch: refs/heads/master
Commit: 7cc8809be50ece4a2648dec42437f73b5aa83eff
Parents: 4797624
Author: Mike Sierra <le...@gmail.com>
Authored: Mon Apr 29 11:38:05 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon Apr 29 11:38:05 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/command-line/index.md | 2 --
docs/en/edge/guide/cordova-webview/ios.md | 1 -
docs/en/edge/guide/getting-started/android/index.md | 3 ---
docs/en/edge/guide/getting-started/bada/index.md | 3 ---
.../edge/guide/getting-started/blackberry/index.md | 8 --------
docs/en/edge/guide/getting-started/ios/index.md | 6 ------
docs/en/edge/guide/getting-started/symbian/index.md | 7 -------
docs/en/edge/guide/getting-started/tizen/index.md | 1 -
docs/en/edge/guide/getting-started/webos/index.md | 7 -------
.../edge/guide/getting-started/windows-8/index.md | 1 -
.../guide/getting-started/windows-phone-7/index.md | 9 ---------
.../guide/getting-started/windows-phone-8/index.md | 9 ---------
docs/en/edge/guide/overview/index.md | 1 -
docs/en/edge/guide/plugin-development/ios/index.md | 3 ---
docs/en/edge/guide/upgrading/android/index.md | 16 ----------------
docs/en/edge/guide/upgrading/blackberry/index.md | 5 -----
docs/en/edge/guide/upgrading/ios/index.md | 3 ---
docs/en/edge/guide/upgrading/windows-phone/index.md | 4 +---
docs/en/edge/guide/whitelist/index.md | 1 -
19 files changed, 1 insertion(+), 89 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/command-line/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/command-line/index.md b/docs/en/edge/guide/command-line/index.md
index 29ee41d..d97878d 100644
--- a/docs/en/edge/guide/command-line/index.md
+++ b/docs/en/edge/guide/command-line/index.md
@@ -84,7 +84,6 @@ Run the `create` command with the following parameters:
$ /path/to/my_new_cordova_project/cordova/log
-
## Android
The Android command-line tools are built upon shell scripts. You _must_
@@ -151,7 +150,6 @@ or, on **Windows**
$ /path/to/my_new_cordova_project/cordova/release.bat
-
## BlackBerry
The BlackBerry command-line tools are built upon shell scripts.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/cordova-webview/ios.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/ios.md b/docs/en/edge/guide/cordova-webview/ios.md
index a4ca2d5..9b2cd09 100644
--- a/docs/en/edge/guide/cordova-webview/ios.md
+++ b/docs/en/edge/guide/cordova-webview/ios.md
@@ -37,7 +37,6 @@ Prerequisites
2. **Xcode 4.5** or greater
3. `config.xml` file (from a [newly created](guide_command-line_index.md.html#Command-Line%20Usage_ios) Cordova project)
-
Adding Cleaver to your Xcode project (CordovaLib sub-project)
-------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/android/index.md b/docs/en/edge/guide/getting-started/android/index.md
index 7298c48..09892fe 100644
--- a/docs/en/edge/guide/getting-started/android/index.md
+++ b/docs/en/edge/guide/getting-started/android/index.md
@@ -45,7 +45,6 @@ platforms are deprecated as they dip below 5% on Google's
- Download and extract the latest copy of [Cordova](http://cordova.apache.org/#download). You will be working in the `android` directory.
-
3A. Set up your PATH environment variable on Mac OS
---------------------------------------
@@ -81,7 +80,6 @@ platforms are deprecated as they dip below 5% on Google's
- You may also need to include `%JAVA_HOME%\bin` to your PATH. To check if this is required, open a command prompt and type `java`. Add `%JAVA_HOME%\bin` to the PATH if the program can't be found. You may need to specify the full path instead of the `%JAVA_HOME%` environment variable.
- Finally, you may also need to include `%ANT_HOME%\bin` to your PATH. To check if this is required, open a command prompt and type `ant`. Add `%ANT_HOME%\bin` to the PATH if the program can't be found. You may need to specify the full path instead of the `%ANT_HOME%` environment variable.
-
4. Set up New Project
--------------------
@@ -123,7 +121,6 @@ __NOTE:__ For a faster experience, use an Intel-based emulator image.
- Create a new AVD with the Target set to an Intel image.
- When starting the emulator, ensure there are no error messages about the HAX module failing to load.
-
5B. Deploy to Device
--------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/getting-started/bada/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/bada/index.md b/docs/en/edge/guide/getting-started/bada/index.md
index 0a4934d..5cb84d0 100644
--- a/docs/en/edge/guide/getting-started/bada/index.md
+++ b/docs/en/edge/guide/getting-started/bada/index.md
@@ -34,7 +34,6 @@ This guide describes how to set up your development environment for Cordova and
- Download and install the [Bada SDK](http://developer.bada.com) (Windows only).
- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `bada` directory.
-
3. Set up New Project
--------------------
- In Bada IDE, select _File_ -> Import project -> Bada C++ / Flash Project.
@@ -56,7 +55,6 @@ This guide describes how to set up your development environment for Cordova and
**Bada 2.x**: Your HTML/CSS/JavaScript code lives under the Res/ folder. Make sure your index.html contains the following two lines in the <head> section.
-
<link href="osp://webapp/css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="osp://webapp/js/webapp_core.js"></script>
@@ -88,6 +86,5 @@ This guide describes how to set up your development environment for Cordova and
- Right click on your project's folder and select Build configurations -> Set Active -> Target-Debug
- Right click on your project's folder and select Run As -> bada Target Application. You need to close the emulator every time you update your app!
-
Done!
-----
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/getting-started/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/blackberry/index.md b/docs/en/edge/guide/getting-started/blackberry/index.md
index 57840b6..5cbbdfd 100644
--- a/docs/en/edge/guide/getting-started/blackberry/index.md
+++ b/docs/en/edge/guide/getting-started/blackberry/index.md
@@ -28,7 +28,6 @@ WebWorks applications can ONLY be deployed to the following BlackBerry platforms
* BlackBerry PlayBook
* BlackBerry 10 (QNX)
-
1. Requirements
---------------
@@ -40,7 +39,6 @@ WebWorks applications can ONLY be deployed to the following BlackBerry platforms
- Windows: [Apache Ant](http://ant.apache.org/bindownload.cgi).
- Mac OS X: Apache Ant is bundled with Java install.
-
2. Install the WebWorks SDK
-------------------------
Download and install the appropriate WebWorks SDKs for your development. BlackBerry 10, BlackBerry PlayBook, and BlackBerry Smartphone WebWorks SDKs can all be downloaded from the following locations. Please note that BlackBerry PlayBook development requires the Adobe Air SDK as well.
@@ -49,7 +47,6 @@ Download and install the appropriate WebWorks SDKs for your development. BlackBe
- [BlackBerry PlayBook SDK] (https://developer.blackberry.com/html5/download/#playbook) & [Adobe Air SDK](http://www.adobe.com/devnet/air/air-sdk-download.html)
- [BlackBerry Smartphones SDK] (https://developer.blackberry.com/html5/download/#smartphones)
-
3. Register for Signing Keys
-------------------------
If you wish to publish your application on BlackBerry App World, or deploy on an actual device you’ll need to register for a set of free Code Signing Keys.
@@ -58,13 +55,11 @@ To register for Signing Keys visit, and complete the [BlackBerry Keys Order Form
Once you receive your Signing Keys, they'll need to be setup. To learn how to setup your Signing Keys visit the [BlackBerry HTML5/WebWorks website](https://developer.blackberry.com/html5/documentation/signing_setup_bb10_apps_2008396_11.html).
-
4. Install Cordova
-------------------------
Download and extract the latest copy of [Cordova](http://cordova.apache.org/#download).
-
5. Set up New Project
--------------------
@@ -83,7 +78,6 @@ BlackBerry PlayBook
BlackBerry Smartphone (OS5-7)
- `blackberry.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks Packager`
-
6. Hello World
--------------
@@ -98,7 +92,6 @@ BlackBerry PlayBook
BlackBerry Smartphone (OS5-7)
- `./cordova/build blackberry`
-
7A. Deploy to Simulator
--------------------------------------
@@ -141,7 +134,6 @@ Answer "n" when prompted "Do you have a BlackBerry device connected to your comp
The application is installed to the simulator's home screen. Note that on BlackBerry OS 5, it is installed in the `Downloads` folder.
-
7B. Deploy to Device (Windows and Mac)
--------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/ios/index.md b/docs/en/edge/guide/getting-started/ios/index.md
index 8241736..6dd9f29 100644
--- a/docs/en/edge/guide/getting-started/ios/index.md
+++ b/docs/en/edge/guide/getting-started/ios/index.md
@@ -26,7 +26,6 @@ Apache Cordova is a library used to create native mobile applications using Web
### Requirements ###
-
- **Intel-based Computer with Mac® OS X® Lion or greater (10.7.4+)**
The Apple® tools required for building iOS applications run only on the OS X operating system. The version of the development environment required, Xcode® 4.5, runs only on Mac OS X version 10.7 (Lion) or greater.
- **Xcode 4.5 and iOS 6 SDK**
@@ -40,7 +39,6 @@ Apache Cordova is a library used to create native mobile applications using Web
1. Open Xcode
2. Select the following via the Xcode Menus: **Xcode Preferences> Downloads>Command Line Tools**. This downloads and installs copies of the core command-line tools and system headers into your computer's system folders.
-
- **iOS Device**
You can test many of the Cordova features using the iOS simulator installed with the iOS SDK and Xcode, but you need an actual device to fully test all of the device features your applications use before submitting to the App Store. The device must have at least iOS 5.x installed, the minimum iOS version supported as of Cordova 2.3. Devices that support at least iOS 5 include all iPad® models, iPhone® 3GS and above, and iPod® Touch 3rd Generation or later. To install apps onto a device, you must also be a member of Apple's [iOS Developer Program](https://developer.apple.com/programs/ios/). The program costs $99 per year. This Getting Started guide shows how to deploy the application to the iOS simulator, in which case developer program registration is not required.
@@ -98,7 +96,6 @@ project files. This tutorial uses `~/Documents/CordovaXY`, where the
1. **project location**
-
This directory is where the Xcode project and application files are to be located. This tutorial uses `~/Documents/CordovaXY` as the base location (with 'X' and 'Y' representing the Cordova version number) and the `HelloWorld` application name as the project directory. Since the command creates the final `HelloWorld` directory, it must not already exist.
2. **package name**
@@ -291,7 +288,6 @@ references the deprecated invokeString API:
<body onload=”onLoad();”>
.....
-
###Code Your Application
Replace the sample code in the www directory of a new project with the HTML, JavaScript and CSS code for your application. The name of the initial file to load when the app is launched should be index.html (advanced users can change this if necessary). As demonstrated in the HelloWorld sample application, subdirectories within the www directory are permitted. Note that the www directory is readonly, you can not write information to this directory during app execution. If you need to store information use the Cordova File or Storage APIs.
@@ -312,7 +308,6 @@ references the deprecated invokeString API:
### Apple
-
Some of these references are within the Apple iOS Developer Reference and require an iOS Developer License.
- [Start Developing iOS Apps Today](http://developer.apple.com/library/ios/#referencelibrary/GettingStarted/RoadMapiOS/index.html#//apple_ref/doc/uid/TP40011343) provides a quick overview of steps for developing iOS Apps.
@@ -329,7 +324,6 @@ references the deprecated invokeString API:
- [PhoneGap google group](https://groups.google.com/forum/?fromgroups=%23!forum/phonegap) to discuss and ask questions about Cordova. This forum is monitored by Cordova developers as well as users. When posting please include the platform, device type, Cordova version and as many details as possible about the error or problem.
- File Cordova bugs at [https://issues.apache.org/jira/browse/CB](https://issues.apache.org/jira/browse/CB)
-
### Credits
Mac®, OS X®, Apple®, Xcode®, App Store℠, iPad®, iPhone®, iPod® and Finder® are Trademarks of Apple Inc.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/getting-started/symbian/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/symbian/index.md b/docs/en/edge/guide/getting-started/symbian/index.md
index 525fb88..9fb99a8 100644
--- a/docs/en/edge/guide/getting-started/symbian/index.md
+++ b/docs/en/edge/guide/getting-started/symbian/index.md
@@ -27,7 +27,6 @@ Video Tutorials:
- [Cordova Installer - Xcode 4 Template](http://www.youtube.com/v/R9zktJUN7AI?autoplay=1)
-
1. Requirements
---------------
@@ -35,20 +34,17 @@ Video Tutorials:
There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGap-Symbian-%28Qt%29) and [Symbian with Sony Ericsson](http://wiki.phonegap.com/w/page/16494782/Getting-Started-with-PhoneGap-Symbian-(WRT-on-Sony-Ericsson)) guides.
-
2. Install SDK + Cordova
-------------------------
- Download and install [cygwin](http://www.cygwin.com/setup.exe) (Windows only). Make sure you select "make" as it is not included by default
- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the Android directory.
-
3. Set up New Project
--------------------
- In cygwin, navigate to where you extracted Cordova and go into the Symbian directory</li>
-
4. Hello World
--------------
@@ -56,7 +52,6 @@ There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGa
- In the `body` tag, remove the line `"Build your phonegap app here! Dude!"` and add the line `<h1>Hello World</h1>`
- In cygwin/terminal, type `make`. This produces a `phonegap-symbian.wrt/app.wgz` file.
-
5A. Deploy to Simulator
-----------------------
@@ -64,13 +59,11 @@ There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGa
- For Windows you can download the [S60 SDK](http://www.forum.nokia.com/info/sw.nokia.com/id/ec866fab-4b76-49f6-b5a5-af0631419e9c/S60_All_in_One_SDKs.html) which includes the S60 Emulator
- Load the phonegap-symbian.wrt/app.wgz file into the emulator.
-
5B. Deploy to Device
--------------------
- Load the phonegap-symbian.wrt/app.wgz file into the device using bluetooth or email.
-
Done!
-----
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/getting-started/tizen/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/tizen/index.md b/docs/en/edge/guide/getting-started/tizen/index.md
index 4271a3e..33f1ee3 100644
--- a/docs/en/edge/guide/getting-started/tizen/index.md
+++ b/docs/en/edge/guide/getting-started/tizen/index.md
@@ -84,7 +84,6 @@ This guide describes how to set up your development environment for Cordova and
- **Note** that the provided samples Tizen Cordova projects are not basic hello world applications. They contain a simple example usage of the Battery Cordova API.
-
5A. Deploy to Simulator
-----------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/getting-started/webos/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/webos/index.md b/docs/en/edge/guide/getting-started/webos/index.md
index 7d5635c..6d60026 100644
--- a/docs/en/edge/guide/getting-started/webos/index.md
+++ b/docs/en/edge/guide/getting-started/webos/index.md
@@ -28,13 +28,11 @@ Video Tutorials:
- [Cordova and HP Palm webOS quick start video](http://www.youtube.com/v/XEnAUbDRZfw?autoplay=1)
- [How to convert iPhone app to a Palm](http://www.youtube.com/v/wWoJfQw79XI?autoplay=1)
-
1. Requirements
---------------
- Windows, OS X, or Linux
-
2. Install SDK + Cordova
----------------------------
@@ -45,33 +43,28 @@ Video Tutorials:
- Download and install XCode from the [Mac App Store](http://itunes.apple.com/ca/app/xcode/id497799835?mt=12) (OSX only)
- Download and install Command Line Tools for XCode (OSX only); this can be done by going to XCode's Preferences -> Downloads -> Components and then click install on Command Line Tools
-
3. Set up New Project
--------------------
- Open up terminal/cygwin and navigate to where you extracted your Cordova Download. Go into the webOS directory.
-
4. Hello World
--------------
Edit `phonegap/webOS/framework/www/index.html`, adding `<h1>Hello World</h1>` after the `<body>` tag.
-
5A. Deploy to Simulator
-----------------------
- Open up your Palm Emulator from your applications folder/start menu.
- Type `make` in your terminal/cygwin while in the webOS directory.
-
5B. Deploy to Device
--------------------
- Make sure your device is in [Developer Mode and plug it in.](http://developer.palm.com/index.php?option=com_content&view=article&id=1552&Itemid=59#dev_mode)
- Type `make` in your terminal/cygwin while in the webOS directory.
-
Done!
-----
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/getting-started/windows-8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/windows-8/index.md b/docs/en/edge/guide/getting-started/windows-8/index.md
index fad87a2..adef5d4 100644
--- a/docs/en/edge/guide/getting-started/windows-8/index.md
+++ b/docs/en/edge/guide/getting-started/windows-8/index.md
@@ -95,7 +95,6 @@ You can already build Windows 8 apps using the "HTML/JavaScript track" available
</body>
-
5. Test the Project
-------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/getting-started/windows-phone-7/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/windows-phone-7/index.md b/docs/en/edge/guide/getting-started/windows-phone-7/index.md
index 6f0ec3d..2ff44df 100644
--- a/docs/en/edge/guide/getting-started/windows-phone-7/index.md
+++ b/docs/en/edge/guide/getting-started/windows-phone-7/index.md
@@ -28,7 +28,6 @@ Video Tutorials:
- [Cordova and Windows Phone quick setup video](http://www.youtube.com/v/wO9xdRcNHIM?autoplay=1)
- [Cordova and Windows Phone deep dive](http://www.youtube.com/v/BJFX1GRUXj8?autoplay=1)
-
1. Requirements
---------------
@@ -48,7 +47,6 @@ __NOTE:__ Running in VM does not work well. If you are on a Mac, you need to set
if you have just installed VisualStudio, you should launch it once to create this folder
if you prefer, you may add the project instead to the "Silverlight for Windows Phone" subfolder of "Visual C#". This is up to you, and only affects where the project template is shown when creating a new project. Also, You may need to create this folder.
-
2.1. Building the template
-----------------------------
@@ -63,9 +61,6 @@ __NOTE:__ Skip this step if the `lib\windows-phone` directory already contains a
- __NOTE:__ If you select __Automatically import the template...__, then you don't need to copy the `.zip` file over as outlined in step 2.
- Press __Finish__.
-
-
-
3. Set up New Project
--------------------
@@ -76,7 +71,6 @@ __NOTE:__ Skip this step if the `lib\windows-phone` directory already contains a
-
4. Review the project structure
-------------------------------
@@ -85,7 +79,6 @@ __NOTE:__ Skip this step if the `lib\windows-phone` directory already contains a
-
5. Build and Deploy to Emulator
-------------------------------
@@ -95,7 +88,6 @@ __NOTE:__ Skip this step if the `lib\windows-phone` directory already contains a
-
6. Build your project for the device
------------------------------------
@@ -107,7 +99,6 @@ To test your application on a device, the device must be registered. MSDN provid
-
Done!
-----
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/getting-started/windows-phone-8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/windows-phone-8/index.md b/docs/en/edge/guide/getting-started/windows-phone-8/index.md
index 4e9406f..8938f47 100644
--- a/docs/en/edge/guide/getting-started/windows-phone-8/index.md
+++ b/docs/en/edge/guide/getting-started/windows-phone-8/index.md
@@ -51,7 +51,6 @@ __NOTE:__ Applications built with Apache Cordova for Windows Phone 8 run only on
__NOTE:__ Running the SDK in Virtual Machine might present some challenges. You can read this blog post that gives insight on the solutions to develop for [Windows Phone on a Mac](http://aka.ms/BuildaWP8apponaMac).
-
2. Install SDK + Cordova
----------------------------
@@ -59,7 +58,6 @@ __NOTE:__ Running the SDK in Virtual Machine might present some challenges. You
- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-phone-8` subfolder.
- copy the file CordovaWP8AppFull-x.x.x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\
-
2.1. Building the template
-----------------------------
__NOTE:__ this step may not be required. If the lib\windows-phone directory already contains a file CordovaStarter-x.x.x.zip then you may skip this step.
@@ -74,7 +72,6 @@ In order to simplify the development process, Cordova comes with a Visual Studio
- __NOTE:__ If you select __Automatically import the template...__, then you don't need to copy the `.zip` file over as outlined in step 2.
- Press __Finish__
-
2.2 About the different templates
--------------------
Apache Cordova for Windows Phone 8 supports 2 different types of templates.
@@ -112,7 +109,6 @@ choose __do not include in project__.
-
4. Review the project structure
-------------------------------
@@ -121,7 +117,6 @@ choose __do not include in project__.
-
5. Build and Deploy to Emulator
-------------------------------
@@ -130,7 +125,6 @@ choose __do not include in project__.
-
6. Build your project for the device
------------------------------------
@@ -142,7 +136,6 @@ In order to test your application on a device, the device must be registered. Cl
-
Done!
-----
@@ -151,5 +144,3 @@ Further Reading
For more details on the specific differences between IE10 and WebKit browsers, and how to support both MS has a helpful [guide here](http://blogs.windows.com/windows_phone/b/wpdev/archive/2012/11/15/adapting-your-webkit-optimized-site-for-internet-explorer-10.aspx)
-
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/index.md b/docs/en/edge/guide/overview/index.md
index a17439b..d7a46ff 100644
--- a/docs/en/edge/guide/overview/index.md
+++ b/docs/en/edge/guide/overview/index.md
@@ -44,7 +44,6 @@ Use Cordova if you are:
* a developer who wants to blend
-
How Do You Use It?
---------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/plugin-development/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/ios/index.md b/docs/en/edge/guide/plugin-development/ios/index.md
index 09b0f0c..5228896 100644
--- a/docs/en/edge/guide/plugin-development/ios/index.md
+++ b/docs/en/edge/guide/plugin-development/ios/index.md
@@ -53,7 +53,6 @@ There is *no* designated initializer for plugins. Instead, plugins should use th
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
We have JavaScript fire off a plugin request to the native side. We have the iOS Objective-C plugin mapped properly via the `config.xml` file. So what does the final iOS Objective-C Plugin class look like?
@@ -149,7 +148,6 @@ 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.
This plugin only supports one action, the `echo` action. First, we
@@ -186,7 +184,6 @@ call, you should use a background thread. For example:
}];
}
-
## Advanced Plugin Functionality
See other methods that you can override in:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/upgrading/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/android/index.md b/docs/en/edge/guide/upgrading/android/index.md
index 9651800..b729cb2 100644
--- a/docs/en/edge/guide/upgrading/android/index.md
+++ b/docs/en/edge/guide/upgrading/android/index.md
@@ -20,7 +20,6 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Upgrading Cordova Android
=========================
-
This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova.
## Upgrade to 2.5.0 from 2.4.0 ##
@@ -44,7 +43,6 @@ This document is for people who need to upgrade their Cordova versions from an o
6. Copy the res/xml/config.xml to be the same as the one found in framework/res/xml/config.xml
7. Copy files from bin/templates/cordova to the cordova directory in your project
-
## Upgrade to 2.3.0 from 2.2.0 ##
1. Remove cordova-2.2.0.jar from the libs directory in your project
@@ -65,7 +63,6 @@ This document is for people who need to upgrade their Cordova versions from an o
6. Copy the res/xml/config.xml to be the same as the one found in framework/res/xml/config.xml
7. Copy files from bin/templates/cordova to the cordova directory in your project
-
## Upgrade to 2.1.0 from 2.0.0 ##
1. Remove cordova-2.0.0.jar from the libs directory in your project
@@ -76,7 +73,6 @@ This document is for people who need to upgrade their Cordova versions from an o
6. Copy the res/xml/config.xml to be the same as the one found in framework/res/xml/config.xml
7. Copy files from bin/templates/cordova to the cordova directory in your project
-
## Upgrade to 2.0.0 from 1.9.0 ##
1. Remove cordova-1.9.0.jar from the libs directory in your project
@@ -113,7 +109,6 @@ getContext() or getActivity(). If you are not an experienced Android developer,
5. Update your HTML to use the new cordova-1.8.1.js file
6. Update the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml
-
## Upgrade to 1.8.0 from 1.7.0 ##
1. Remove cordova-1.7.0.jar from the libs directory in your project
@@ -123,9 +118,6 @@ getContext() or getActivity(). If you are not an experienced Android developer,
5. Update your HTML to use the new cordova-1.8.0.js file
6. Update the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml
-
-
-
## Upgrade to 1.8.0 from 1.7.0 ##
1. Remove cordova-1.7.0.jar from the libs directory in your project
@@ -135,7 +127,6 @@ getContext() or getActivity(). If you are not an experienced Android developer,
5. Update your HTML to use the new cordova-1.8.0.js file
6. Update the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml
-
## Upgrade to 1.7.0 from 1.6.1 ##
1. Remove cordova-1.6.1.jar from the libs directory in your project
@@ -144,7 +135,6 @@ getContext() or getActivity(). If you are not an experienced Android developer,
4. Copy the new cordova-1.7.0.js into your project
5. Update the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml
-
## Upgrade to 1.6.1 from 1.6.0 ##
1. Remove cordova-1.6.0.jar from the libs directory in your project
@@ -162,7 +152,6 @@ getContext() or getActivity(). If you are not an experienced Android developer,
6. Update the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
7. Replace the res/xml/phonegap.xml with res/xml/cordova.xml so that it is the same as the one found in framework/res/xml/cordova.xml
-
## Upgrade to 1.5.0 from 1.4.0##
1. Remove phonegap-1.4.0.jar from the libs directory in your project
2. Add cordova-1.5.0.jar to the libs directory in your project
@@ -181,7 +170,6 @@ getContext() or getActivity(). If you are not an experienced Android developer,
6. Update the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
7. Update the res/xml/phonegap.xml so that it is the same as the one found in framework/res/xml/phonegap.xml
-
## Upgrade to 1.3.0 from 1.2.0 ##
1. Remove phonegap-1.2.0.jar from the libs directory in your project
2. Add phonegap-1.3.0.jar to the libs directory in your project
@@ -191,7 +179,6 @@ getContext() or getActivity(). If you are not an experienced Android developer,
6. Update the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
7. Update the res/xml/phonegap.xml so that it is the same as the one found in framework/res/xml/phonegap.xml
-
## Upgrade to 1.2.0 from 1.1.0 ##
1. Remove phonegap-1.1.0.jar from the libs directory in your project
2. Add phonegap-1.2.0.jar to the libs directory in your project
@@ -201,7 +188,6 @@ getContext() or getActivity(). If you are not an experienced Android developer,
6. Update the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
7. Update the res/xml/phonegap.xml so that it is the same as the one found in framework/res/xml/phonegap.xml
-
## Upgrade to 1.1.0 from 1.0.0 ##
1. Remove phonegap-1.0.0.jar from the libs directory in your project
2. Add phonegap-1.1.0.jar to the libs directory in your project
@@ -210,7 +196,6 @@ getContext() or getActivity(). If you are not an experienced Android developer,
5. Update your HTML to use the new phonegap-1.1.0.js file
6. Update the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
-
## Upgrade to 1.0.0 from 0.9.6 ##
1. Remove phonegap-0.9.6.jar from the libs directory in your project
2. Add phonegap-1.0.0.jar to the libs directory in your project
@@ -219,4 +204,3 @@ getContext() or getActivity(). If you are not an experienced Android developer,
5. Update your HTML to use the new phonegap-1.0.0.js file
6. Add the res/xml/plugins.xml so that it is the same as the one found in framework/res/xml/plugins.xml
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/upgrading/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/blackberry/index.md b/docs/en/edge/guide/upgrading/blackberry/index.md
index e7853e6..1e65812 100644
--- a/docs/en/edge/guide/upgrading/blackberry/index.md
+++ b/docs/en/edge/guide/upgrading/blackberry/index.md
@@ -44,7 +44,6 @@ 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):
1. Open the `sample/lib/` folder.
@@ -66,9 +65,6 @@ Updating the sample folder (ie, updating using the ant tools):
<plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
<plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
-
-
-
- To upgrade to 1.8.0, please go from 1.7.0
## Upgrade to 1.8.0 from 1.7.0 ##
@@ -93,7 +89,6 @@ 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):
1. Open the `sample/lib/` folder.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/upgrading/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/ios/index.md b/docs/en/edge/guide/upgrading/ios/index.md
index 3a07a61..1e4610a 100644
--- a/docs/en/edge/guide/upgrading/ios/index.md
+++ b/docs/en/edge/guide/upgrading/ios/index.md
@@ -133,7 +133,6 @@ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Referenc
`update_cordova_subproject path/to/your/project/xcodeproj`
-
## Upgrading Cordova 1.9.0 projects to 2.0.0 ##
1. **Install** Cordova 2.0.0
@@ -207,7 +206,6 @@ in `Cordova.plist`. By default, this setting is enabled, so set it to
Safari and UIKit
Section](https://developer.apple.com/library/prerelease/ios/#releasenotes/General/RN-iOSSDK-6_0/_index.html)
-
## Upgrading Cordova 1.7.0 projects to 1.8.x ##
1. **Install** Cordova 1.8.0
@@ -251,7 +249,6 @@ If you intend on using the **Capture API**, you will need the new **iPad retina-
13. Enter **"Compiler for C/C++/Objective-C"** in the search field
14. Select the **"Apple LLVM Compiler 3.1"** value
-
## Upgrading Cordova 1.4.x projects to 1.5.0 ##
1. **Install** Cordova 1.5.0
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7cc8809b/docs/en/edge/guide/upgrading/windows-phone/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/windows-phone/index.md b/docs/en/edge/guide/upgrading/windows-phone/index.md
index 1d67b8c..0203f78 100644
--- a/docs/en/edge/guide/upgrading/windows-phone/index.md
+++ b/docs/en/edge/guide/upgrading/windows-phone/index.md
@@ -84,7 +84,6 @@ There have been considerable changes to the WP7 project structure in Apache Cord
5. Copy over any plugins from the plugins folder 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:
@@ -96,7 +95,6 @@ There have been considerable changes to the WP7 project structure in Apache Cord
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:
@@ -194,4 +192,4 @@ There have been considerable changes to the WP7 project structure in Apache Cord
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.
\ No newline at end of file
+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/7cc8809b/docs/en/edge/guide/whitelist/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/whitelist/index.md b/docs/en/edge/guide/whitelist/index.md
index 4a0d942..ca1ee9f 100644
--- a/docs/en/edge/guide/whitelist/index.md
+++ b/docs/en/edge/guide/whitelist/index.md
@@ -118,7 +118,6 @@ __NOTE:__ origins specified without a protocol, such as
`www.apache.org` rather than `http://www.apache.org`, default to all
of the `http`, `https`, `ftp`, and `ftps` schemes.
-
### Syntax
Wildcards on iOS (`*`) are more flexible than the [W3C Widget Access][1] specification.
[25/46] docs commit: to end of geoloc
Posted by mw...@apache.org.
to end of geoloc
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/80d6aeab
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/80d6aeab
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/80d6aeab
Branch: refs/heads/master
Commit: 80d6aeab49754b77cf4aa033a5c381ede0ad37f4
Parents: f43710d
Author: Mike Sierra <le...@gmail.com>
Authored: Thu May 16 16:32:59 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Thu May 16 16:32:59 2013 -0400
----------------------------------------------------------------------
.../accelerometer/acceleration/acceleration.md | 8 +-
.../parameters/accelerometerOptions.md | 2 +-
.../parameters/accelerometerSuccess.md | 2 +-
.../camera/parameter/CameraPopoverHandle.md | 2 +-
.../camera/parameter/CameraPopoverOptions.md | 10 +-
.../cordova/camera/parameter/cameraError.md | 2 +-
.../cordova/camera/parameter/cameraOptions.md | 24 ++--
.../cordova/camera/parameter/cameraSuccess.md | 2 +-
.../compass/compassError/compassError.md | 2 +-
.../compass/parameters/compassHeading.md | 8 +-
.../compass/parameters/compassOptions.md | 4 +-
.../compass/parameters/compassSuccess.md | 2 +-
.../en/edge/cordova/contacts/Contact/contact.md | 90 +++++++-------
.../contacts/ContactAddress/contactaddress.md | 42 +++----
.../contacts/ContactError/contactError.md | 2 +-
.../contacts/ContactField/contactfield.md | 18 +--
.../ContactFindOptions/contactfindoptions.md | 6 +-
.../cordova/contacts/ContactName/contactname.md | 36 +++---
.../ContactOrganization/contactorganization.md | 28 ++---
docs/en/edge/cordova/contacts/contacts.find.md | 8 +-
.../contacts/parameters/contactFindOptions.md | 4 +-
.../contacts/parameters/contactSuccess.md | 2 +-
.../cordova/events/events.batterycritical.md | 4 +-
.../en/edge/cordova/events/events.batterylow.md | 4 +-
.../edge/cordova/events/events.batterystatus.md | 4 +-
.../file/directoryentry/directoryentry.md | 117 ++++++++++---------
.../file/directoryreader/directoryreader.md | 11 +-
docs/en/edge/cordova/file/file.md | 4 +-
.../en/edge/cordova/file/fileentry/fileentry.md | 88 +++++++-------
.../en/edge/cordova/file/fileerror/fileerror.md | 11 +-
docs/en/edge/cordova/file/fileobj/fileobj.md | 27 +++--
.../edge/cordova/file/filereader/filereader.md | 46 +++++---
.../edge/cordova/file/filesystem/filesystem.md | 11 +-
.../cordova/file/filetransfer/filetransfer.md | 47 +++++---
.../file/filetransfererror/filetransfererror.md | 11 +-
.../file/fileuploadoptions/fileuploadoptions.md | 25 ++--
.../file/fileuploadresult/fileuploadresult.md | 16 +--
.../edge/cordova/file/filewriter/filewriter.md | 48 +++++---
docs/en/edge/cordova/file/flags/flags.md | 10 +-
.../file/localfilesystem/localfilesystem.md | 8 +-
docs/en/edge/cordova/file/metadata/metadata.md | 10 +-
.../geolocation/Coordinates/coordinates.md | 7 +-
.../cordova/geolocation/Position/position.md | 9 +-
.../geolocation/PositionError/positionError.md | 21 ++--
.../geolocation/geolocation.clearWatch.md | 11 +-
.../geolocation.getCurrentPosition.md | 14 ++-
docs/en/edge/cordova/geolocation/geolocation.md | 15 ++-
.../geolocation/geolocation.watchPosition.md | 13 ++-
.../parameters/geolocation.options.md | 12 +-
.../geolocation/parameters/geolocationError.md | 7 +-
.../parameters/geolocationSuccess.md | 9 +-
.../GlobalizationError/globalizationerror.md | 4 +-
.../edge/cordova/inappbrowser/inappbrowser.md | 34 +++---
.../en/edge/cordova/inappbrowser/window.open.md | 24 ++--
.../edge/cordova/media/MediaError/mediaError.md | 4 +-
.../edge/cordova/media/Parameters/mediaError.md | 2 +-
.../edge/cordova/media/capture/CaptureError.md | 2 +-
.../cordova/media/capture/ConfigurationData.md | 6 +-
docs/en/edge/cordova/media/capture/MediaFile.md | 12 +-
.../edge/cordova/media/capture/MediaFileData.md | 40 +++----
docs/en/edge/cordova/media/capture/capture.md | 6 +-
.../media/capture/captureAudioOptions.md | 4 +-
.../media/capture/captureImageOptions.md | 2 +-
.../media/capture/captureVideoOptions.md | 4 +-
.../cordova/notification/notification.alert.md | 8 +-
.../cordova/notification/notification.beep.md | 2 +-
.../notification/notification.confirm.md | 8 +-
.../cordova/notification/notification.prompt.md | 12 +-
.../notification/notification.vibrate.md | 4 +-
.../edge/cordova/storage/sqlerror/sqlerror.md | 4 +-
70 files changed, 595 insertions(+), 511 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
index fb77e01..cae085e 100644
--- a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
+++ b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
@@ -25,10 +25,10 @@ Contains `Accelerometer` data captured at a specific point in time.
Properties
----------
-- __x:__ Amount of acceleration on the x-axis. (in m/s^2) (`Number`)
-- __y:__ Amount of acceleration on the y-axis. (in m/s^2) (`Number`)
-- __z:__ Amount of acceleration on the z-axis. (in m/s^2) (`Number`)
-- __timestamp:__ Creation timestamp in milliseconds. (`DOMTimeStamp`)
+- __x__: Amount of acceleration on the x-axis. (in m/s^2) (`Number`)
+- __y__: Amount of acceleration on the y-axis. (in m/s^2) (`Number`)
+- __z__: Amount of acceleration on the z-axis. (in m/s^2) (`Number`)
+- __timestamp__: Creation timestamp in milliseconds. (`DOMTimeStamp`)
Description
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
index 0396055..e73429e 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
@@ -25,4 +25,4 @@ An optional parameter to customize the retrieval of accelerometer values.
Options
-------
-- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
+- __frequency__: How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
index c402ece..792a2d9 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
@@ -29,7 +29,7 @@ onSuccess callback function that provides the `Acceleration` information.
Parameters
----------
-- __acceleration:__ The acceleration at a single moment in time. (Acceleration)
+- __acceleration__: The acceleration at a single moment in time. (Acceleration)
Example
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
index 70ce431..34084fa 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
@@ -25,7 +25,7 @@ A handle to the popover dialog created by `camera.getPicture`.
Methods
-------
-- __setPosition:__ Set the position of the popover.
+- __setPosition__: Set the position of the popover.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
index 8bd0728..dec818e 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
@@ -34,15 +34,15 @@ or album.
CameraPopoverOptions
--------------------
-- __x:__ x pixel coordinate of screen element onto which to anchor the popover. (`Number`)
+- __x__: x pixel coordinate of screen element onto which to anchor the popover. (`Number`)
-- __y:__ y pixel coordinate of screen element onto which to anchor the popover. (`Number`)
+- __y__: y pixel coordinate of screen element onto which to anchor the popover. (`Number`)
-- __width:__ width, in pixels, of the screen element onto which to anchor the popover. (`Number`)
+- __width__: width, in pixels, of the screen element onto which to anchor the popover. (`Number`)
-- __height:__ height, in pixels, of the screen element onto which to anchor the popover. (`Number`)
+- __height__: height, in pixels, of the screen element onto which to anchor the popover. (`Number`)
-- __arrowDir:__ Direction the arrow on the popover should point. Defined in `Camera.PopoverArrowDirection` (`Number`)
+- __arrowDir__: Direction the arrow on the popover should point. Defined in `Camera.PopoverArrowDirection` (`Number`)
Camera.PopoverArrowDirection = {
ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/camera/parameter/cameraError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraError.md b/docs/en/edge/cordova/camera/parameter/cameraError.md
index f36840f..c89b0fa 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraError.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraError.md
@@ -29,4 +29,4 @@ onError callback function that provides an error message.
Parameters
----------
-- __message:__ The message is provided by the device's native code. (`String`)
+- __message__: The message is provided by the device's native code. (`String`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraOptions.md b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
index a7a9974..d3385dd 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
@@ -35,9 +35,9 @@ Optional parameters to customize the camera settings.
Options
-------
-- __quality:__ Quality of saved image. Range is [0, 100]. (`Number`)
+- __quality__: Quality of saved image. Range is [0, 100]. (`Number`)
-- __destinationType:__ Choose the format of the return value. Defined in `navigator.camera.DestinationType` (`Number`)
+- __destinationType__: Choose the format of the return value. Defined in `navigator.camera.DestinationType` (`Number`)
Camera.DestinationType = {
DATA_URL : 0, // Return image as base64-encoded string
@@ -45,7 +45,7 @@ Options
NATIVE_URI : 2 // Return image native URI (e.g. assets-library:// on iOS or content:// on Android)
};
-- __sourceType:__ Set the source of the picture. Defined in `navigator.camera.PictureSourceType` (`Number`)
+- __sourceType__: Set the source of the picture. Defined in `navigator.camera.PictureSourceType` (`Number`)
Camera.PictureSourceType = {
PHOTOLIBRARY : 0,
@@ -53,19 +53,19 @@ Options
SAVEDPHOTOALBUM : 2
};
-- __allowEdit:__ Allow simple editing of image before selection. (`Boolean`)
+- __allowEdit__: Allow simple editing of image before selection. (`Boolean`)
-- __encodingType:__ Choose the returned image file's encoding. Defined in `navigator.camera.EncodingType` (`Number`)
+- __encodingType__: Choose the returned image file's encoding. Defined in `navigator.camera.EncodingType` (`Number`)
Camera.EncodingType = {
JPEG : 0, // Return JPEG encoded image
PNG : 1 // Return PNG encoded image
};
-- __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`)
+- __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`)
+- __mediaType__: Set the type of media to select from. Only works when `PictureSourceType` is `PHOTOLIBRARY` or `SAVEDPHOTOALBUM`. Defined in `nagivator.camera.MediaType` (`Number`)
Camera.MediaType = {
PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
@@ -73,10 +73,10 @@ Options
ALLMEDIA : 2 // allow selection from all media types
};
-- __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`)
+- __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 = {
BACK : 0, // Use the back-facing camera
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraSuccess.md b/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
index 12e9c26..d9ceb75 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
@@ -29,7 +29,7 @@ onSuccess callback function that provides the image data.
Parameters
----------
-- __imageData:__ Base64 encoding of the image data, _or_ the image file URI, depending on `cameraOptions` in effect. (`String`)
+- __imageData__: Base64 encoding of the image data, _or_ the image file URI, depending on `cameraOptions` in effect. (`String`)
Example
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compassError/compassError.md b/docs/en/edge/cordova/compass/compassError/compassError.md
index 43058eb..8862490 100644
--- a/docs/en/edge/cordova/compass/compassError/compassError.md
+++ b/docs/en/edge/cordova/compass/compassError/compassError.md
@@ -25,7 +25,7 @@ A `CompassError` object is returned to the `compassError` callback function when
Properties
----------
-- __code:__ One of the predefined error codes listed below.
+- __code__: One of the predefined error codes listed below.
Constants
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassHeading.md b/docs/en/edge/cordova/compass/parameters/compassHeading.md
index 544a6b6..25bdf9d 100644
--- a/docs/en/edge/cordova/compass/parameters/compassHeading.md
+++ b/docs/en/edge/cordova/compass/parameters/compassHeading.md
@@ -24,10 +24,10 @@ 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)_
-- __headingAccuracy:__ The deviation in degrees between the reported heading and the true heading. _(Number)_
-- __timestamp:__ The time at which this heading was determined. _(milliseconds)_
+- __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
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassOptions.md b/docs/en/edge/cordova/compass/parameters/compassOptions.md
index 99e648c..4427c16 100755
--- a/docs/en/edge/cordova/compass/parameters/compassOptions.md
+++ b/docs/en/edge/cordova/compass/parameters/compassOptions.md
@@ -25,8 +25,8 @@ An optional parameter to customize the retrieval of the compass.
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)_
+- __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
______________
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassSuccess.md b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
index 4e11974..bc95de4 100644
--- a/docs/en/edge/cordova/compass/parameters/compassSuccess.md
+++ b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
@@ -29,7 +29,7 @@ onSuccess callback function that provides the compass heading information via a
Parameters
----------
-- __heading:__ The heading information. _(compassHeading)_
+- __heading__: The heading information. _(compassHeading)_
Example
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/Contact/contact.md b/docs/en/edge/cordova/contacts/Contact/contact.md
index 2b5985e..00d958a 100644
--- a/docs/en/edge/cordova/contacts/Contact/contact.md
+++ b/docs/en/edge/cordova/contacts/Contact/contact.md
@@ -25,20 +25,20 @@ Contains properties that describe a contact, such as a user's personal or busine
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 contact's user-defined categories. _(ContactField[])_
-- __urls:__ An array of web pages associated with the contact. _(ContactField[])_
+- __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 contact's user-defined categories. _(ContactField[])_
+- __urls__: An array of web pages associated with the contact. _(ContactField[])_
Methods
-------
@@ -192,50 +192,50 @@ Full Example
Android 2.X Quirks
------------------
-- __categories:__ Not supported on Android 2.X devices, returning `null`.
+- __categories__: Not supported on Android 2.X devices, returning `null`.
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.
+- __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`.
+- __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`.
+- __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`.
Bada Quirks
-----------
-- __displayName:__ Not supported.
-- __birthday:__ Not supported.
-- __photos:__ This property should be a list with one URL to a photo
-- __categories:__ Not supported.
-- __ims:__ Not supported.
+- __displayName__: Not supported.
+- __birthday__: Not supported.
+- __photos__: This property should be a list with one URL to a photo
+- __categories__: Not supported.
+- __ims__: Not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
index 7038135..124e141 100644
--- a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
+++ b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
@@ -24,14 +24,14 @@ Contains address properties for a `Contact` object.
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)_
+- __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
-------
@@ -139,25 +139,25 @@ Full Example
Android 2.X Quirks
------------------
-- __pref:__ Not supported, returning `false` on Android 2.X devices.
+- __pref__: Not supported, returning `false` on Android 2.X devices.
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.
+- __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.
+- __pref__: Not supported on iOS devices, returning `false`.
+- __formatted__: Currently not supported.
Bada Quirks
-----------
-- __formatted:__ Not supported.
-- __type:__ Has to be either `WORK` or `HOME`
+- __formatted__: Not supported.
+- __type__: Has to be either `WORK` or `HOME`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactError/contactError.md b/docs/en/edge/cordova/contacts/ContactError/contactError.md
index 0be9191..d43f706 100644
--- a/docs/en/edge/cordova/contacts/ContactError/contactError.md
+++ b/docs/en/edge/cordova/contacts/ContactError/contactError.md
@@ -25,7 +25,7 @@ A `ContactError` object is passed to the `contactError` callback when an error o
Properties
----------
-- __code:__ One of the predefined error codes listed below.
+- __code__: One of the predefined error codes listed below.
Constants
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactField/contactfield.md b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
index d18fafc..f14e735 100644
--- a/docs/en/edge/cordova/contacts/ContactField/contactfield.md
+++ b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
@@ -27,9 +27,9 @@ URLs.
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)_
+- __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
-------
@@ -144,20 +144,20 @@ Full Example
Android Quirks
--------------
-- __pref:__ Not supported, returning `false`.
+- __pref__: Not supported, returning `false`.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
-- __type:__ Partially supported. Used for phone numbers.
-- __value:__ Supported.
-- __pref:__ Not supported, returning `false`.
+- __type__: Partially supported. Used for phone numbers.
+- __value__: Supported.
+- __pref__: Not supported, returning `false`.
iOS Quirks
-----------
-- __pref:__ Not supported, returning `false`.
+- __pref__: Not supported, returning `false`.
Bada Quirks
-----------
-- __type:__ For email or address fields, property must be _WORK_ or _HOME_. For phone fields, must be _WORK_, _HOME_, _VOICE_, _FAX_, _MSG_, _CELL_, _PAGER_, _BBS_, _MODEM_, _CAR_, _ISDN_,_VIDEO_, or _PCS_.
+- __type__: For email or address fields, property must be _WORK_ or _HOME_. For phone fields, must be _WORK_, _HOME_, _VOICE_, _FAX_, _MSG_, _CELL_, _PAGER_, _BBS_, _MODEM_, _CAR_, _ISDN_,_VIDEO_, or _PCS_.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
index cfa939a..522111a 100644
--- a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -25,8 +25,8 @@ Contains properties that can be used to filter the results of a `contacts.find`
Properties
----------
-- __filter:__ The search string used to find contacts. _(DOMString)_ (Default: `""`)
-- __multiple:__ Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: false)
+- __filter__: The search string used to find contacts. _(DOMString)_ (Default: `""`)
+- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: false)
Supported Platforms
-------------------
@@ -115,4 +115,4 @@ Full Example
Bada Quirks
-----------
-__filter:__ Property can only apply to the following: _firstName_, _lastName_, _nickname_, _phoneNumber_, _email_, and _address_.
+__filter__: Property can only apply to the following: _firstName_, _lastName_, _nickname_, _phoneNumber_, _email_, and _address_.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactName/contactname.md b/docs/en/edge/cordova/contacts/ContactName/contactname.md
index 912355c..3702ab7 100644
--- a/docs/en/edge/cordova/contacts/ContactName/contactname.md
+++ b/docs/en/edge/cordova/contacts/ContactName/contactname.md
@@ -25,12 +25,12 @@ Contains different kinds of information about a `Contact` object's name.
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)_
+- __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
-------
@@ -123,25 +123,25 @@ Full Example
Android Quirks
------------
-- __formatted:__ Partially supported, and read-only. Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
+- __formatted__: Partially supported, and read-only. Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
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`.
+- __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
------------
-- __formatted:__ Partially supported. Returns iOS Composite Name, but is read-only.
+- __formatted__: Partially supported. Returns iOS Composite Name, but is read-only.
Bada Quirks
-----------
-- __formatted:__ Not supported
-- __middleName:__ Not supported
-_ __honorificPrefix:__ Not supported
-- __honorificSuffix:__ Not supported
+- __formatted__: Not supported
+- __middleName__: Not supported
+_ __honorificPrefix__: Not supported
+- __honorificSuffix__: Not supported
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
index 497a368..475a2fd 100644
--- a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
@@ -24,11 +24,11 @@ Contains a `Contact` object's organization properties.
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)_
+- __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
-------
@@ -127,21 +127,21 @@ Full Example
Android 2.X Quirks
------------------
-- __pref:__ Not supported by Android 2.X devices, returning `false`.
+- __pref__: Not supported by Android 2.X devices, returning `false`.
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.
+- __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.
+- __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/80d6aeab/docs/en/edge/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.find.md b/docs/en/edge/cordova/contacts/contacts.find.md
index 3d527be..1668642 100644
--- a/docs/en/edge/cordova/contacts/contacts.find.md
+++ b/docs/en/edge/cordova/contacts/contacts.find.md
@@ -49,10 +49,10 @@ _any_ of the specified fields, the contact is returned.
Parameters
----------
-- __contactFields:__ Contact fields to use as a search qualifier. Only these fields will have values in the resulting `Contact` objects. _(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]
+- __contactFields__: Contact fields to use as a search qualifier. Only these fields will have values in the resulting `Contact` objects. _(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/80d6aeab/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
index 7c0d59b..773b56e 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
@@ -31,6 +31,6 @@ contacts returned from the contacts database.
Options
-------
-- __filter:__ The search string used to filter contacts. _(DOMString)_ (Default: `""`)
-- __multiple:__ Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: `false`)
+- __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/80d6aeab/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
index c3cdda2..0cf2a83 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
@@ -29,7 +29,7 @@ Success callback function that provides the `Contact` array resulting from a `co
Parameters
----------
-- __contacts:__ The contact array resulting from a find operation. (`Contact`)
+- __contacts__: The contact array resulting from a find operation. (`Contact`)
Example
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterycritical.md b/docs/en/edge/cordova/events/events.batterycritical.md
index 5568845..166cc60 100644
--- a/docs/en/edge/cordova/events/events.batterycritical.md
+++ b/docs/en/edge/cordova/events/events.batterycritical.md
@@ -34,8 +34,8 @@ critical battery threshold. The value is device-specific.
The `batterycritical` handler is called with 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)_
+- __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 an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterylow.md b/docs/en/edge/cordova/events/events.batterylow.md
index 6159c3d..7014765 100644
--- a/docs/en/edge/cordova/events/events.batterylow.md
+++ b/docs/en/edge/cordova/events/events.batterylow.md
@@ -33,8 +33,8 @@ low battery threshold, device-specific value.
The `batterylow` handler is called with 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)_
+- __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
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterystatus.md b/docs/en/edge/cordova/events/events.batterystatus.md
index e91050d..57ed6ef 100644
--- a/docs/en/edge/cordova/events/events.batterystatus.md
+++ b/docs/en/edge/cordova/events/events.batterystatus.md
@@ -33,8 +33,8 @@ least 1 percent, or if the device is plugged in or unplugged.
The battery status handler is called with 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)_
+- __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 an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index cc5990d..c5d87cd 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,15 +27,15 @@ specification.
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)_
+- __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 attributes are defined by the W3C
specification, but are _not_ supported by Cordova:
-- __filesystem:__ The file system on which the `DirectoryEntry` resides. _(FileSystem)_
+- __filesystem__: The file system on which the `DirectoryEntry` resides. _(FileSystem)_
Methods
-------
@@ -70,8 +70,8 @@ Look up metadata about a directory.
__Parameters:__
-- __successCallback__ - A callback function to be called with a `Metadata` object. _(Function)_
-- __errorCallback__ - A callback function that executes if an error occurs when retrieving the `Metadata`, invoked with a `FileError` object. _(Function)_
+- __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__
@@ -90,13 +90,13 @@ setMetadata
----------------
Set metadata on a directory.
-**Only works on iOS currently** - this will set the extended attributes of a directory.
+__Currently works only on iOS.__ - this will set the extended attributes of a directory.
__Parameters:__
-- __successCallback__ - A callback that is called when the metadata was successfully set. _(Function)_
-- __errorCallback__ - A callback that is called when the metadata was not successfully set. _(Function)_
-- __metadataObject__ - An object that contains the metadata keys and values. _(Object)_
+- __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__
@@ -110,9 +110,10 @@ __Quick Example__
// Set the metadata
entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
+
__iOS Quirk__
-- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to _not_ enable the directory to be backed up by iCloud. Set the value to **0** to re-enable the directory to be backed up by iCloud.
+- Only the `com.apple.MobileBackup` extended attribute is supported. Set the value to `1` to prevent the directory from being backed up to iCloud. Set the value to `0` to re-enable the directory to be backed up to iCloud.
__Quick Example__
@@ -150,21 +151,22 @@ __Quick Example__
moveTo
------
-Move a directory to a different location on the file system. It is an error to attempt to:
+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 one is not provided;
-- move a directory to a path occupied by a file;
-- move a directory to a path occupied by a directory which is not empty.
+- 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.
-In addition, an attempt to move a directory on top of an existing empty directory must attempt to delete and replace that directory.
+Moving a directory on top of an existing empty directory attempts to
+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 is called with the DirectoryEntry object of the new directory. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to move the directory. Invoked with a FileError object. _(Function)_
+- __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__
@@ -189,19 +191,19 @@ __Quick Example__
copyTo
------
-Copy a directory to a different location on the file system. It is an error to attempt to:
+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 one is not provided.
+- 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 - that is, they copy all contents of the directory.
+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 is called with the DirectoryEntry object of the new directory. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the underlying directory. Invoked with a FileError object. _(Function)_
+- __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__
@@ -237,15 +239,15 @@ __Quick Example__
remove
------
-Deletes a directory. It is an error to attempt to:
+Deletes a directory. An error results if the app attempts to:
-- delete a directory that is not empty;
+- delete a directory that is not empty.
- delete the root directory of a filesystem.
__Parameters:__
-- __successCallback__ - A callback that is called after the directory has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the directory. Invoked with a FileError object. _(Function)_
+- __successCallback__: A callback that is called after the directory has been deleted. Invoked with no parameters. _(Function)_
+- __errorCallback__: A callback that is called if an error occurs when attempting to delete the directory. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -267,8 +269,8 @@ Look up the parent DirectoryEntry containing the directory.
__Parameters:__
-- __successCallback__ - A callback that is called with the directory's parent DirectoryEntry. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_
+- __successCallback__: A callback that is called with the directory's parent DirectoryEntry. _(Function)_
+- __errorCallback__: A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -296,16 +298,16 @@ __Quick Example__
getDirectory
------------
-Creates or looks up an existing directory. It is an error to attempt to:
+Creates or looks up an existing directory. An error results if the app attempts to:
- create a directory whose immediate parent does not yet exist.
__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 created if it doesn't exist. _(Flags)_
-- __successCallback__ - A callback that is invoked with a DirectoryEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs creating or looking up the directory. Invoked with a FileError object. _(Function)_
+- __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__
@@ -323,16 +325,16 @@ __Quick Example__
getFile
-------
-Creates or looks up a file. It is an error to attempt to:
+Creates or looks up a file. An error results if the app attempts to:
- create a file whose immediate parent does not yet exist.
__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 invoked with a FileEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs creating or looking up the file. Invoked with a FileError object. _(Function)_
+- __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 invoked with a `FileEntry` object. _(Function)_
+- __errorCallback__: A callback that is called if an error occurs when creating or looking up the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -350,16 +352,16 @@ __Quick Example__
removeRecursively
-----------------
-Deletes a directory and all of its contents. In the event of an error (e.g. trying to delete
-a directory that contains a file that cannot be removed), some of the contents of the directory may
-be deleted. It is an error to attempt to:
+Deletes a directory and all of its contents. In the event of an error (such as trying to delete
+a directory containing a file that cannot be removed), some of the contents of the directory may
+be deleted. An error results if the app attempts to:
- delete the root directory of a filesystem.
__Parameters:__
-- __successCallback__ - A callback that is called after the DirectoryEntry has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the DirectoryEntry. Invoked with a FileError object. _(Function)_
+- __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__
@@ -377,12 +379,13 @@ __Quick Example__
BlackBerry Quirks
-----------------
-May fail with a ControlledAccessException in the following cases:
+May fail with a `ControlledAccessException` in the following cases:
+
+- An app attempts to access a directory created by a previous installation of the app.
-- Access is attempted on an directory created by a previous installation of an application.
+> Solution: ensure temporary directories are cleaned manually, or by the application prior to reinstallation.
-> solution: insure temporary directories are cleaned manually, or by the application before reinstall
+- If the device is connected by USB.
-- if device is connected by usb
+> Solution: disconnect the USB cable from the device and run again.
-> solution: disconnect usb cable from device and run again
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryreader/directoryreader.md b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
index e7aff92..dcddd3a 100644
--- a/docs/en/edge/cordova/file/directoryreader/directoryreader.md
+++ b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,10 @@ license: Licensed to the Apache Software Foundation (ASF) under one
DirectoryReader
===============
-An object that lists files and directories in a directory. Defined in the [Directories and Systems](http://www.w3.org/TR/file-system-api/) specification.
+An object that lists files and directories within a directory, as
+defined in the
+[W3C Directories and Systems](http://www.w3.org/TR/file-system-api/)
+specification.
Methods
-------
@@ -43,8 +46,8 @@ 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 is called if an error occurs retrieving the directory listing. Invoked with a FileError object. _(Function)_
+- __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/80d6aeab/docs/en/edge/cordova/file/file.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/file.md b/docs/en/edge/cordova/file/file.md
index 18e0a7a..eed64c0 100644
--- a/docs/en/edge/cordova/file/file.md
+++ b/docs/en/edge/cordova/file/file.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
File
==========
-> This API is based on the W3C [File API](http://www.w3.org/TR/FileAPI). An API to read, write and navigate file system hierarchies.
+> An API to read, write and navigate file system hierarchies, based on the [W3C File API](http://www.w3.org/TR/FileAPI).
Objects
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileentry/fileentry.md b/docs/en/edge/cordova/file/fileentry/fileentry.md
index b1ac22b..9689f26 100644
--- a/docs/en/edge/cordova/file/fileentry/fileentry.md
+++ b/docs/en/edge/cordova/file/fileentry/fileentry.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,19 +20,22 @@ license: Licensed to the Apache Software Foundation (ASF) under one
FileEntry
==========
-This object represents a file on a file system. It is defined in the [W3C Directories and Systems](http://www.w3.org/TR/file-system-api/) specification.
+Represents a file on a file system, as defined in the
+[W3C Directories and Systems](http://www.w3.org/TR/file-system-api/)
+specification.
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)_
+- __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 attributes are defined by the W3C specification, but are __not supported__ by Cordova:
+__NOTE:__ The following attributes are defined by the W3C
+specification, but are _not_ supported by Cordova:
-- __filesystem:__ The file system on which the FileEntry resides. _(FileSystem)_
+- __filesystem__: The file system on which the `FileEntry` resides. _(FileSystem)_
Methods
-------
@@ -44,8 +47,8 @@ Methods
- __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.
+- __createWriter__: Creates a `FileWriter` object that can be used to write to a file.
+- __file__: Creates a `File` object containing file properties.
Supported Platforms
-------------------
@@ -63,8 +66,8 @@ Look up metadata about a file.
__Parameters:__
-- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_
+- __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__
@@ -83,13 +86,15 @@ setMetadata
----------------
Set metadata on a file.
-**Only works on iOS currently** - this will set the extended attributes of a file.
+
+__Currently works only on iOS.__
+- this will set the extended attributes of a file.
__Parameters:__
-- __successCallback__ - A callback that is called when the metadata was successfully set. _(Function)_
-- __errorCallback__ - A callback that is called when the metadata was not successfully set. _(Function)_
-- __metadataObject__ - An object that contains the metadata keys and values. _(Object)_
+- __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__
@@ -103,9 +108,10 @@ __Quick Example__
// Set the metadata
entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
+
__iOS Quirk__
-- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to _not_ enable the file to be backed up by iCloud. Set the value to **0** to re-enable the file to be backed up by iCloud.
+- Only the `com.apple.MobileBackup` extended attribute is supported. Set the value to `1` to prevent the file from being backed up to iCloud. Set the value to `0` to re-enable the file to be backed up to iCloud.
__Quick Example__
@@ -143,19 +149,21 @@ __Quick Example__
moveTo
------
-Move a file to a different location on the file system. It is an error to attempt to:
+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, an attempt to move a file on top of an existing file must attempt to delete and replace that file.
+In addition, moving a file on top of an existing file attempts to
+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 called with the FileEntry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a FileError object. _(Function)_
+- __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)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to move the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
@@ -179,16 +187,17 @@ __Quick Example__
copyTo
------
-Copy a file to a new location on the file system. It is an error to attempt to:
+Copy a file to a new location on the file system. An error results if
+the app attempts to:
- copy a file into its parent if a name different from its current one is not provided.
__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 called with the FileEntry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a FileError object. _(Function)_
+- __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__
@@ -227,8 +236,8 @@ Deletes a file.
__Parameters:__
-- __successCallback__ - A callback that is called after the file has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a FileError object. _(Function)_
+- __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__
@@ -246,12 +255,12 @@ __Quick Example__
getParent
---------
-Look up the parent DirectoryEntry containing the file.
+Look up the parent `DirectoryEntry` containing the file.
__Parameters:__
-- __successCallback__ - A callback that is called with the file's parent DirectoryEntry. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_
+- __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__
@@ -269,12 +278,12 @@ __Quick Example__
createWriter
------------
-Create a FileWriter object associated with the file that the FileEntry represents.
+Create a `FileWriter` object associated with the file represented by the `FileEntry`.
__Parameters:__
-- __successCallback__ - A callback that is called with a FileWriter object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs while attempting to create the FileWriter. Invoked with a FileError object. _(Function)_
+- __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__
@@ -292,12 +301,13 @@ __Quick Example__
file
----
-Return a File object that represents the current state of the file that this FileEntry represents.
+Return a `File` object that represents the current state of the file
+that this `FileEntry` represents.
__Parameters:__
-- __successCallback__ - A callback that is called with a File object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when creating the File object (e.g. the underlying file no longer exists). Invoked with a FileError object. _(Function)_
+- __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/80d6aeab/docs/en/edge/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileerror/fileerror.md b/docs/en/edge/cordova/file/fileerror/fileerror.md
index 5aca921..a408736 100644
--- a/docs/en/edge/cordova/file/fileerror/fileerror.md
+++ b/docs/en/edge/cordova/file/fileerror/fileerror.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,12 +20,12 @@ license: Licensed to the Apache Software Foundation (ASF) under one
FileError
========
-A 'FileError' object is set when an error occurs in any of the File API methods.
+A `FileError` object is set when an error occurs in any of the File API methods.
Properties
----------
-- __code:__ One of the predefined error codes listed below.
+- __code__: One of the predefined error codes listed below.
Constants
---------
@@ -46,4 +46,7 @@ Constants
Description
-----------
-The `FileError` object is the only parameter of any of the File API's error callbacks. Developers must read the code property to determine the type of error.
+The `FileError` object is the only parameter provided to any of the
+File API's error callbacks. To determine the type of error, compare
+its `code` property to any of the listings above.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileobj/fileobj.md b/docs/en/edge/cordova/file/fileobj/fileobj.md
index 4d42525..c343383 100644
--- a/docs/en/edge/cordova/file/fileobj/fileobj.md
+++ b/docs/en/edge/cordova/file/fileobj/fileobj.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -25,11 +25,11 @@ This object contains attributes of a single file.
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)_
+- __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
-------
@@ -39,7 +39,9 @@ Methods
Details
-------
-The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `FileEntry` object.
+The `File` object contains attributes of a single file. You can get
+an instance of a `File` object by calling a `FileEntry` object's
+`file()` method.
Supported Platforms
-------------------
@@ -53,14 +55,15 @@ Supported Platforms
slice
--------------
-Return a new File object, for which FileReader will return only the specified portion of the file.
-Negative values for __start__ or __end__ are measured from the end of the file.
-The indexes are always relative to the current slice (see the full example).
+Return a new `File` object, for which `FileReader` returns only the
+specified portion of the file. Negative values for `start` or `end`
+are measured from the end of the file. Indexes are positioned
+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.
+- __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/80d6aeab/docs/en/edge/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filereader/filereader.md b/docs/en/edge/cordova/file/filereader/filereader.md
index 17220ff..f7e9f98 100644
--- a/docs/en/edge/cordova/file/filereader/filereader.md
+++ b/docs/en/edge/cordova/file/filereader/filereader.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,20 +20,23 @@ license: Licensed to the Apache Software Foundation (ASF) under one
FileReader
==========
-FileReader is an object that allows one to read a file.
+The `FileReader` allows basic access to a file.
Properties
----------
-- __readyState:__ One of the three states the reader can be in EMPTY, LOADING or DONE.
-- __result:__ The contents of the file that has been read. _(DOMString)_
-- __error:__ An object containing errors. _(FileError)_
-- __onloadstart:__ Called when the read starts. . _(Function)_
-- __onprogress:__ Called while reading the file, reports progress (progess.loaded/progress.total). _(Function)_ -_not_ SUPPORTED
-- __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)_
+- __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:
+
+- __onprogress__: Called while reading the file, reporting progress in terms of `progress.loaded`/`progress.total`. _(Function)_
Methods
-------
@@ -42,12 +45,15 @@ Methods
- __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.
+- __readAsArrayBuffer__: Reads file as an `ArrayBuffer`.
Details
-------
-The `FileReader` object is a way to read files from the devices file system. Files can be read as text or as a base64 data encoded string. Users register their own event listeners to receive the loadstart, progress, load, loadend, error and abort events.
+The `FileReader` object offers a way to read files from the device's
+file system. Files can be read as text or as a base64 data-encoded
+string. Event listeners receive the `loadstart`, `progress`, `load`,
+`loadend`, `error`, and `abort` events.
Supported Platforms
-------------------
@@ -62,7 +68,8 @@ Read As Data URL
----------------
__Parameters:__
-- file - the file object to read
+
+- __file__: the file object to read.
Quick Example
-------------
@@ -87,8 +94,8 @@ Read As Text
__Parameters:__
-- file - the file object to read
-- encoding - the encoding to use to encode the file's content. Default is UTF8.
+- __file__: the file object to read.
+- __encoding__: the encoding to use to encode the file's content. Default is UTF8.
Quick Example
-------------
@@ -195,7 +202,7 @@ Full Example
iOS Quirks
----------
-- __encoding__ parameter is not supported, UTF8 encoding is always used.
+- The __encoding__ parameter is not supported, and UTF8 encoding is always in effect.
Read As Binary String
---------------------
@@ -203,7 +210,8 @@ Read As Binary String
Currently supported on iOS and Android only.
__Parameters:__
-- file - the file object to read
+
+- __file__: the file object to read.
Quick Example
-------------
@@ -229,7 +237,7 @@ Read As Array Buffer
Currently supported on iOS and Android only.
__Parameters:__
-- file - the file object to read
+- __file__: the file object to read.
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filesystem/filesystem.md b/docs/en/edge/cordova/file/filesystem/filesystem.md
index b768e78..4510d12 100644
--- a/docs/en/edge/cordova/file/filesystem/filesystem.md
+++ b/docs/en/edge/cordova/file/filesystem/filesystem.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -25,13 +25,16 @@ This object represents a file system.
Properties
----------
-- __name:__ The name of the file system. _(DOMString)_
-- __root:__ The root directory of the file system. _(DirectoryEntry)_
+- __name__: The name of the file system. _(DOMString)_
+- __root__: The root directory of the file system. _(DirectoryEntry)_
Details
-------
-The `FileSystem` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `DirectoryEntry` object which represents the root directory of the file system.
+The `FileSystem` object represents information about the file system.
+The name of the file system is unique across the list of exposed
+file systems. The root property contains a `DirectoryEntry` object
+that represents the file system's root directory.
Supported Platforms
-------------------
[03/46] docs commit: more stubs
Posted by mw...@apache.org.
more stubs
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/b151e34c
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/b151e34c
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/b151e34c
Branch: refs/heads/master
Commit: b151e34c5d00f998bfd5bdc446ca0bcb25dc89b8
Parents: d33b887
Author: Mike Sierra <le...@gmail.com>
Authored: Fri Apr 26 10:20:55 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Fri Apr 26 10:20:55 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/overview/apis.md | 25 +++
docs/en/edge/guide/overview/index.md | 29 +++
docs/en/edge/guide/overview/support.html | 302 ++++++++++++++++++++++++++
docs/en/edge/guide/overview/support.md | 302 ++++++++++++++++++++++++++
4 files changed, 658 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/b151e34c/docs/en/edge/guide/overview/apis.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/apis.md b/docs/en/edge/guide/overview/apis.md
new file mode 100644
index 0000000..a2c5d89
--- /dev/null
+++ b/docs/en/edge/guide/overview/apis.md
@@ -0,0 +1,25 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+API Primer
+==========
+
+This section introduces the Cordova APIs and shows how you might use
+them in your application.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/b151e34c/docs/en/edge/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/index.md b/docs/en/edge/guide/overview/index.md
index bc10128..a17439b 100644
--- a/docs/en/edge/guide/overview/index.md
+++ b/docs/en/edge/guide/overview/index.md
@@ -20,3 +20,32 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Overview
========
+Cordova is an open-source mobile development framework. It allows you
+to use standard web technologies such as HTML5, CSS3, and JavaScript
+for cross-platform development, avoiding each mobile platforms' native
+development language. Applications execute as a WebView within a
+native wrapper, and rely on standards-compliant Cordova API bindings
+to access the device's sensors, data, and network status.
+
+Cordova also offers features
+
+PhoneGap is a product offering that relies on the Cordova framework.
+Its PhoneGap Build service provides a way to build applications
+remotely without having to run local tools.
+
+Use Cordova if you are:
+
+* a mobile developer and want to extend an application across more
+ than one platform, without having to re-implement it with each
+ platform's language and tool set.
+
+* a web developer and want to deploy a web app that's packaged for
+ distribution in app store portals.
+
+* a developer who wants to blend
+
+
+How Do You Use It?
+---------------------
+
+There are several ways to build
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/b151e34c/docs/en/edge/guide/overview/support.html
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/support.html b/docs/en/edge/guide/overview/support.html
new file mode 100644
index 0000000..3dd6c5c
--- /dev/null
+++ b/docs/en/edge/guide/overview/support.html
@@ -0,0 +1,302 @@
+<style>
+[data-support=y] { background-color: lightgreen }
+[data-support=p] { background-color: gold }
+[data-support=n] { background-color: pink }
+[data-support=u] { background-color: #ddd }
+</style>
+
+<table width="100%">
+ <tr>
+ <th></th>
+ <th>Android</th>
+ <th>Blackberry</th>
+ <th>iOS</th>
+ <th>Symbian</th>
+ <th>WebOS</th>
+ <th>Windows<br/>Phone 7</th>
+ <th>Windows<br/>Phone 8</th>
+ <th>Windows<br/>8</th>
+ <th>Bada</th>
+ <th>Tizen</th>
+ </tr>
+
+ <tr>
+ <th>Accelerometer</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔ (5.x+)</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Camera</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔ (5.x+)</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="p">✝</th>
+ </tr>
+
+ <tr>
+ <th>Capture</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Compass</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="n">✘</th>
+ <th class="ios" data-support="y">✔ (3GS+)</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Connection</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Contacts</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="n">✘</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Device</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Events</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>File</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="n">✘</th>
+ <th class="webos" data-support="n">✘</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="n">✘</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Geolocation</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Globalization</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>InAppBrowser</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Media</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="n">✘</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="n">✘</th>
+ <th class="webos" data-support="n">✘</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="n">✘</th>
+ <th class="tizen" data-support="p">✝</th>
+ </tr>
+
+ <tr>
+ <th>Notification</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Splashscreen</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Storage</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔ (5.x+)</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="n">✘</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th colspan="20">Other Features</th>
+ </tr>
+ <tr>
+ <th>Command-line<br/>Interface</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="u">✝</th>
+ <th class="webos" data-support="u">✝</th>
+ <th class="winphone7" data-support="u">✝</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="u">✝</th>
+ <th class="bada" data-support="u">✝</th>
+ <th class="tizen" data-support="u">✝</th>
+ </tr>
+ <tr>
+ <th>PhoneGap<br/>Build</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="u">✝</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="u">✝</th>
+ <th class="bada" data-support="u">✝</th>
+ <th class="tizen" data-support="u">✝</th>
+ </tr>
+ <tr>
+ <th>Embedded<br/>WebView</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="u">✝</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="u">✝</th>
+ <th class="webos" data-support="u">✝</th>
+ <th class="winphone7" data-support="u">✝</th>
+ <th class="winphone8" data-support="u">✝</th>
+ <th class="win8" data-support="u">✝</th>
+ <th class="bada" data-support="u">✝</th>
+ <th class="tizen" data-support="u">✝</th>
+ </tr>
+ <tr>
+ <th>Plug-in<br/>Interface</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="u">✝</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="u">✝</th>
+ <th class="winphone8" data-support="u">✝</th>
+ <th class="win8" data-support="u">✝</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/b151e34c/docs/en/edge/guide/overview/support.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/support.md b/docs/en/edge/guide/overview/support.md
index 3ea9cf5..b5dfa72 100644
--- a/docs/en/edge/guide/overview/support.md
+++ b/docs/en/edge/guide/overview/support.md
@@ -20,3 +20,305 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Supported Features
==================
+<style>
+[data-support=y] { background-color: lightgreen }
+[data-support=p] { background-color: gold }
+[data-support=n] { background-color: pink }
+[data-support=u] { background-color: #ddd }
+</style>
+
+<table width="100%">
+ <tr>
+ <th></th>
+ <th>Android</th>
+ <th>Blackberry</th>
+ <th>iOS</th>
+ <th>Symbian</th>
+ <th>WebOS</th>
+ <th>Windows<br/>Phone 7</th>
+ <th>Windows<br/>Phone 8</th>
+ <th>Windows<br/>8</th>
+ <th>Bada</th>
+ <th>Tizen</th>
+ </tr>
+
+ <tr>
+ <th>Accelerometer</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔ (5.x+)</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Camera</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔ (5.x+)</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="p">✝</th>
+ </tr>
+
+ <tr>
+ <th>Capture</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Compass</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="n">✘</th>
+ <th class="ios" data-support="y">✔ (3GS+)</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Connection</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Contacts</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="n">✘</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Device</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Events</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>File</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="n">✘</th>
+ <th class="webos" data-support="n">✘</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="n">✘</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Geolocation</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Globalization</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>InAppBrowser</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Media</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="n">✘</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="n">✘</th>
+ <th class="webos" data-support="n">✘</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="n">✘</th>
+ <th class="tizen" data-support="p">✝</th>
+ </tr>
+
+ <tr>
+ <th>Notification</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Splashscreen</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th>Storage</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔ (5.x+)</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="y">✔</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="y">✔</th>
+ <th class="bada" data-support="n">✘</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+
+ <tr>
+ <th colspan="20">Other Features</th>
+ </tr>
+ <tr>
+ <th>Command-line<br/>Interface</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="u">✝</th>
+ <th class="webos" data-support="u">✝</th>
+ <th class="winphone7" data-support="u">✝</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="u">✝</th>
+ <th class="bada" data-support="u">✝</th>
+ <th class="tizen" data-support="u">✝</th>
+ </tr>
+ <tr>
+ <th>PhoneGap<br/>Build</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="y">✔</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="u">✝</th>
+ <th class="winphone8" data-support="y">✔</th>
+ <th class="win8" data-support="u">✝</th>
+ <th class="bada" data-support="u">✝</th>
+ <th class="tizen" data-support="u">✝</th>
+ </tr>
+ <tr>
+ <th>Embedded<br/>WebView</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="u">✝</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="u">✝</th>
+ <th class="webos" data-support="u">✝</th>
+ <th class="winphone7" data-support="u">✝</th>
+ <th class="winphone8" data-support="u">✝</th>
+ <th class="win8" data-support="u">✝</th>
+ <th class="bada" data-support="u">✝</th>
+ <th class="tizen" data-support="u">✝</th>
+ </tr>
+ <tr>
+ <th>Plug-in<br/>Interface</th>
+ <th class="android" data-support="y">✔</th>
+ <th class="blackberry" data-support="y">✔</th>
+ <th class="ios" data-support="y">✔</th>
+ <th class="symbian" data-support="u">✝</th>
+ <th class="webos" data-support="y">✔</th>
+ <th class="winphone7" data-support="u">✝</th>
+ <th class="winphone8" data-support="u">✝</th>
+ <th class="win8" data-support="u">✝</th>
+ <th class="bada" data-support="y">✔</th>
+ <th class="tizen" data-support="y">✔</th>
+ </tr>
+</table>
[26/46] docs commit: edits mostly in globalization
Posted by mw...@apache.org.
edits mostly in globalization
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/d9648d01
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/d9648d01
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/d9648d01
Branch: refs/heads/master
Commit: d9648d0193d8319ccadb22422e1b8003dab32471
Parents: 80d6aea
Author: Mike Sierra <le...@gmail.com>
Authored: Thu May 16 18:08:40 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Thu May 16 18:08:40 2013 -0400
----------------------------------------------------------------------
.../globalization/globalization.dateToString.md | 14 +++++++++-----
.../globalization/globalization.getDateNames.md | 2 +-
.../globalization/globalization.getFirstDayOfWeek.md | 2 +-
.../globalization/globalization.getLocaleName.md | 2 +-
.../globalization.getPreferredLanguage.md | 2 +-
.../globalization.isDayLightSavingsTime.md | 2 +-
.../globalization/globalization.numberToString.md | 2 +-
.../globalization/globalization.stringToNumber.md | 2 +-
docs/en/edge/cordova/media/capture/capture.md | 2 +-
docs/en/edge/cordova/media/capture/captureAudio.md | 2 +-
10 files changed, 18 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.dateToString.md b/docs/en/edge/cordova/globalization/globalization.dateToString.md
index f748b37..80192ea 100644
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.md
@@ -27,14 +27,18 @@ Returns a date formatted as a string according to the client's locale and timezo
Description
-----------
-It returns the formatted date string to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a String value.
+It returns the formatted date string to the successCB callback with a
+properties object as a parameter. That object should have a `value`
+property with a `String` value.
-The inbound ``date`` parameter should be of type ``Date``.
+The inbound `date` parameter should be of type `Date`.
-If there is an error formatting the date, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+If there is an error formatting the date, then the `errorCB` callback is
+invoked with a `GlobalizationError` object as a parameter. The expected
+code for this error is `GlobalizationError.FORMATTING\_ERROR`.
-`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
-`options.selector` can be 'date', 'time' or 'date and time'.
+The `options.formatLength` can be 'short', 'medium', 'long', or 'full'.
+The `options.selector` can be 'date', 'time' or 'date and time'.
The default options are `{formatLength:'short', selector:'date and time'}`.
The `options` parameter is optional.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDateNames.md b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
index 92863cd..aa6f89a 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -27,7 +27,7 @@ Returns an array of either the names of the months or days of the week according
Description
-----------
-It returns the array of names to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
+It returns the array of names to the successCB callback with a properties object as a parameter. That object should have a `value` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
If there is an error obtaining the names, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
index ea2e0da..15f02e0 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -27,7 +27,7 @@ Returns the first day of the week according to the client's user preferences and
Description
-----------
-The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a Number value.
+The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the successCB callback with a properties object as a parameter. That object should have a `value` property with a Number value.
If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
index 4a30024..d07939a 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -29,7 +29,7 @@ Description
-----------
It returns the locale identifier string to the successCB callback with a
-properties object as a parameter. That object should have a ``value`` property with a String value.
+properties object as a parameter. That object should have a `value` property with a String value.
If there is an error getting the locale, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
index 6ffb40d..8110432 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -29,7 +29,7 @@ Description
-----------
It returns the language identifier string to the successCB callback with a
-properties object as a parameter. That object should have a ``value`` property with a String value.
+properties object as a parameter. That object should have a `value` property with a String value.
If there is an error getting the language, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
index 2ecf085..537339d 100644
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -27,7 +27,7 @@ Returns whether daylight savings time is in effect for a given date using the cl
Description
-----------
-It returns whether or not daylight savings time is in effect to the successCB callback with a properties object as a parameter. That object should have a ``dst`` property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not.
+It returns whether or not daylight savings time is in effect to the successCB callback with a properties object as a parameter. That object should have a `dst` property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not.
The inbound parameter `date` should be of type `Date`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.numberToString.md b/docs/en/edge/cordova/globalization/globalization.numberToString.md
index 51e8cff..c0c9e48 100644
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.numberToString.md
@@ -27,7 +27,7 @@ Returns a number formatted as a string according to the client's user preference
Description
-----------
-It returns the formatted number string to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a String value.
+It returns the formatted number string to the successCB callback with a properties object as a parameter. That object should have a `value` property with a String value.
If there is an error formatting the number, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
index db5cf70..b0a2627 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
@@ -27,7 +27,7 @@ Parses a number formatted as a string according to the client's user preferences
Description
-----------
-It returns the number to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a Number value.
+It returns the number to the successCB callback with a properties object as a parameter. That object should have a `value` property with a Number value.
If there is an error parsing the number string, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/capture.md b/docs/en/edge/cordova/media/capture/capture.md
index 7f669df..ffa8553 100644
--- a/docs/en/edge/cordova/media/capture/capture.md
+++ b/docs/en/edge/cordova/media/capture/capture.md
@@ -29,7 +29,7 @@ Objects
- CaptureAudioOptions
- CaptureImageOptions
- CaptureVideoOptions
-- CaptureCB
+- CaptureCallback
- CaptureErrorCB
- ConfigurationData
- MediaFile
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudio.md b/docs/en/edge/cordova/media/capture/captureAudio.md
index aceab94..e32d96c 100644
--- a/docs/en/edge/cordova/media/capture/captureAudio.md
+++ b/docs/en/edge/cordova/media/capture/captureAudio.md
@@ -33,7 +33,7 @@ This method starts an asynchronous operation to capture audio recordings using t
The capture operation ends when either the user exits the audio recording application, or the maximum number of recordings, specified by the __limit__ parameter in CaptureAudioOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single audio clip.
-When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation is finished, it will invoke the CaptureCallback callback with an array of MediaFile objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the CaptureErrorCallback callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------
Re: [27/46] docs commit: amidst globalization api
Posted by Michael Brooks <mi...@michaelbrooks.ca>.
The three main points are:
- any features of joDoc [1]
- autolink any text that match a <h1> or <h2>
- automatically replace "x.x.x" pattern with the latest version.
[1] https://github.com/davebalmer/joDoc/wiki
On Fri, Jun 14, 2013 at 5:48 PM, Marcel Kinard <cm...@gmail.com> wrote:
>
> On Jun 13, 2013, at 3:53 PM, Michael Sierra <ms...@adobe.com> wrote:
>
> > Are automatic doc-generation tools doc'ed anywhere? E.g., the
> conversion of heading text to live links? Granted it's not intrinsic to
> content, but potentially affects how you might structure it.
>
> Not doc'ed in our repo, that I'm aware of. This is the only thing I've
> been able to find:
> https://github.com/davebalmer/joDoc/wiki
> https://github.com/davebalmer/joDoc/blob/master/TOC.mdown
>
> @mwbrooks, any other hints?
>
> -- Marcel Kinard
Re: [27/46] docs commit: amidst globalization api
Posted by Marcel Kinard <cm...@gmail.com>.
On Jun 13, 2013, at 3:53 PM, Michael Sierra <ms...@adobe.com> wrote:
> Are automatic doc-generation tools doc'ed anywhere? E.g., the conversion of heading text to live links? Granted it's not intrinsic to content, but potentially affects how you might structure it.
Not doc'ed in our repo, that I'm aware of. This is the only thing I've been able to find:
https://github.com/davebalmer/joDoc/wiki
https://github.com/davebalmer/joDoc/blob/master/TOC.mdown
@mwbrooks, any other hints?
-- Marcel Kinard
RE: [27/46] docs commit: amidst globalization api
Posted by Michael Sierra <ms...@adobe.com>.
That's already in place, with a reference in the top-level README.md. Thanks. I'd keep it out of the README, though, as too much info.
Are automatic doc-generation tools doc'ed anywhere? E.g., the conversion of heading text to live links? Granted it's not intrinsic to content, but potentially affects how you might structure it.
--Mike Sierra
________________________________________
From: Marcel Kinard [cmarcelk@gmail.com]
Sent: Wednesday, June 12, 2013 5:32 PM
To: dev@cordova.apache.org
Subject: Fwd: [27/46] docs commit: amidst globalization api
Mike, how about adding a reference to STYLESHEET.md in README.md, so people looking at README.md see the great style guidelines you authored? Or perhaps even collapse STYLESHEET.md into README.md so it's all inline in the README.
-- Marcel Kinard
Begin forwarded message:
> From: Marcel Kinard <cm...@gmail.com>
> Subject: Re: [27/46] docs commit: amidst globalization api
> Date: June 12, 2013 4:54:31 PM EDT
> To: "dev@cordova.apache.org" <de...@cordova.apache.org>
>
> Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow
>
> After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.
>
> -- Marcel Kinard
>
> On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:
>
>> amidst globalization api
>>
>>
>> Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
>> Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/e2d7868b
>> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
>> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
>>
>> Branch: refs/heads/master
>> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
>> Parents: d9648d0
>> Author: Mike Sierra <le...@gmail.com>
>> Authored: Fri May 17 09:17:27 2013 -0400
>> Committer: Mike Sierra <le...@gmail.com>
>> Committed: Fri May 17 09:17:27 2013 -0400
>>
>> ----------------------------------------------------------------------
>> .../GlobalizationError/globalizationerror.md | 10 +++---
>> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
>> .../globalization.getCurrencyPattern.md | 21 +++++++------
>> .../globalization/globalization.getDateNames.md | 6 ++--
>> .../globalization.getDatePattern.md | 6 ++--
>> .../globalization.getFirstDayOfWeek.md | 6 ++--
>> .../globalization.getLocaleName.md | 6 ++--
>> .../globalization.getNumberPattern.md | 6 ++--
>> .../globalization.getPreferredLanguage.md | 6 ++--
>> .../globalization.isDayLightSavingsTime.md | 6 ++--
>> .../globalization.numberToString.md | 6 ++--
>> .../globalization/globalization.stringToDate.md | 4 +--
>> .../globalization.stringToNumber.md | 6 ++--
>> 13 files changed, 63 insertions(+), 59 deletions(-)
>> ----------------------------------------------------------------------
>
Fwd: [27/46] docs commit: amidst globalization api
Posted by Marcel Kinard <cm...@gmail.com>.
Mike, how about adding a reference to STYLESHEET.md in README.md, so people looking at README.md see the great style guidelines you authored? Or perhaps even collapse STYLESHEET.md into README.md so it's all inline in the README.
-- Marcel Kinard
Begin forwarded message:
> From: Marcel Kinard <cm...@gmail.com>
> Subject: Re: [27/46] docs commit: amidst globalization api
> Date: June 12, 2013 4:54:31 PM EDT
> To: "dev@cordova.apache.org" <de...@cordova.apache.org>
>
> Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow
>
> After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.
>
> -- Marcel Kinard
>
> On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:
>
>> amidst globalization api
>>
>>
>> Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
>> Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/e2d7868b
>> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
>> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
>>
>> Branch: refs/heads/master
>> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
>> Parents: d9648d0
>> Author: Mike Sierra <le...@gmail.com>
>> Authored: Fri May 17 09:17:27 2013 -0400
>> Committer: Mike Sierra <le...@gmail.com>
>> Committed: Fri May 17 09:17:27 2013 -0400
>>
>> ----------------------------------------------------------------------
>> .../GlobalizationError/globalizationerror.md | 10 +++---
>> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
>> .../globalization.getCurrencyPattern.md | 21 +++++++------
>> .../globalization/globalization.getDateNames.md | 6 ++--
>> .../globalization.getDatePattern.md | 6 ++--
>> .../globalization.getFirstDayOfWeek.md | 6 ++--
>> .../globalization.getLocaleName.md | 6 ++--
>> .../globalization.getNumberPattern.md | 6 ++--
>> .../globalization.getPreferredLanguage.md | 6 ++--
>> .../globalization.isDayLightSavingsTime.md | 6 ++--
>> .../globalization.numberToString.md | 6 ++--
>> .../globalization/globalization.stringToDate.md | 4 +--
>> .../globalization.stringToNumber.md | 6 ++--
>> 13 files changed, 63 insertions(+), 59 deletions(-)
>> ----------------------------------------------------------------------
>
RE: [27/46] docs commit: amidst globalization api
Posted by Michael Sierra <ms...@adobe.com>.
Sure, sorry for the volume. Am working on improving doc, and needed to bring it up to a certain baseline. Will punch in a few JIRAs to clarify plans going forward, and to help organize existing doc bugs.
--Mike Sierra
________________________________________
From: Marcel Kinard [cmarcelk@gmail.com]
Sent: Wednesday, June 12, 2013 4:54 PM
To: dev@cordova.apache.org
Subject: Re: [27/46] docs commit: amidst globalization api
Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow
After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.
-- Marcel Kinard
On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:
> amidst globalization api
>
>
> Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
> Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/e2d7868b
> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
>
> Branch: refs/heads/master
> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
> Parents: d9648d0
> Author: Mike Sierra <le...@gmail.com>
> Authored: Fri May 17 09:17:27 2013 -0400
> Committer: Mike Sierra <le...@gmail.com>
> Committed: Fri May 17 09:17:27 2013 -0400
>
> ----------------------------------------------------------------------
> .../GlobalizationError/globalizationerror.md | 10 +++---
> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
> .../globalization.getCurrencyPattern.md | 21 +++++++------
> .../globalization/globalization.getDateNames.md | 6 ++--
> .../globalization.getDatePattern.md | 6 ++--
> .../globalization.getFirstDayOfWeek.md | 6 ++--
> .../globalization.getLocaleName.md | 6 ++--
> .../globalization.getNumberPattern.md | 6 ++--
> .../globalization.getPreferredLanguage.md | 6 ++--
> .../globalization.isDayLightSavingsTime.md | 6 ++--
> .../globalization.numberToString.md | 6 ++--
> .../globalization/globalization.stringToDate.md | 4 +--
> .../globalization.stringToNumber.md | 6 ++--
> 13 files changed, 63 insertions(+), 59 deletions(-)
> ----------------------------------------------------------------------
Re: [27/46] docs commit: amidst globalization api
Posted by Marcel Kinard <cm...@gmail.com>.
Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow
After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.
-- Marcel Kinard
On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:
> amidst globalization api
>
>
> Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
> Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/e2d7868b
> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
>
> Branch: refs/heads/master
> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
> Parents: d9648d0
> Author: Mike Sierra <le...@gmail.com>
> Authored: Fri May 17 09:17:27 2013 -0400
> Committer: Mike Sierra <le...@gmail.com>
> Committed: Fri May 17 09:17:27 2013 -0400
>
> ----------------------------------------------------------------------
> .../GlobalizationError/globalizationerror.md | 10 +++---
> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
> .../globalization.getCurrencyPattern.md | 21 +++++++------
> .../globalization/globalization.getDateNames.md | 6 ++--
> .../globalization.getDatePattern.md | 6 ++--
> .../globalization.getFirstDayOfWeek.md | 6 ++--
> .../globalization.getLocaleName.md | 6 ++--
> .../globalization.getNumberPattern.md | 6 ++--
> .../globalization.getPreferredLanguage.md | 6 ++--
> .../globalization.isDayLightSavingsTime.md | 6 ++--
> .../globalization.numberToString.md | 6 ++--
> .../globalization/globalization.stringToDate.md | 4 +--
> .../globalization.stringToNumber.md | 6 ++--
> 13 files changed, 63 insertions(+), 59 deletions(-)
> ----------------------------------------------------------------------
[27/46] docs commit: amidst globalization api
Posted by mw...@apache.org.
amidst globalization api
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/e2d7868b
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
Branch: refs/heads/master
Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
Parents: d9648d0
Author: Mike Sierra <le...@gmail.com>
Authored: Fri May 17 09:17:27 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Fri May 17 09:17:27 2013 -0400
----------------------------------------------------------------------
.../GlobalizationError/globalizationerror.md | 10 +++---
.../globalization/globalization.dateToString.md | 33 +++++++++++---------
.../globalization.getCurrencyPattern.md | 21 +++++++------
.../globalization/globalization.getDateNames.md | 6 ++--
.../globalization.getDatePattern.md | 6 ++--
.../globalization.getFirstDayOfWeek.md | 6 ++--
.../globalization.getLocaleName.md | 6 ++--
.../globalization.getNumberPattern.md | 6 ++--
.../globalization.getPreferredLanguage.md | 6 ++--
.../globalization.isDayLightSavingsTime.md | 6 ++--
.../globalization.numberToString.md | 6 ++--
.../globalization/globalization.stringToDate.md | 4 +--
.../globalization.stringToNumber.md | 6 ++--
13 files changed, 63 insertions(+), 59 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
index d5d3942..e9cec1e 100644
--- a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
+++ b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -49,7 +49,7 @@ Quick Example
When the following error callback is invoked, it should display a popup dialog with the text similar to "code: 3" and "message: ".
- function errorCB(error) {
+ function errorCallback(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
};
@@ -64,13 +64,13 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- function successCB(date) {
+ function successCallback(date) {
alert('month:' + date.month +
' day:' + date.day +
' year:' + date.year + '\n');
}
- function errorCB(error) {
+ function errorCallback(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
};
@@ -78,8 +78,8 @@ Full Example
function checkError() {
navigator.globalization.stringToDate(
'notADate',
- successCB,
- errorCB,
+ successCallback,
+ errorCallback,
{selector:'foobar'}
);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.dateToString.md b/docs/en/edge/cordova/globalization/globalization.dateToString.md
index 80192ea..9dd0e71 100644
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -22,26 +22,26 @@ globalization.dateToString
Returns a date formatted as a string according to the client's locale and timezone.
- navigator.globalization.dateToString(date, successCB, errorCB, options);
+ navigator.globalization.dateToString(date, successCallback, errorCallback, options);
Description
-----------
-It returns the formatted date string to the successCB callback with a
-properties object as a parameter. That object should have a `value`
-property with a `String` value.
+Returns the formatted date `String` via a `value` property accessible
+from the object passed as a parameter to the `successCallback`.
The inbound `date` parameter should be of type `Date`.
-If there is an error formatting the date, then the `errorCB` callback is
-invoked with a `GlobalizationError` object as a parameter. The expected
-code for this error is `GlobalizationError.FORMATTING\_ERROR`.
+If there is an error formatting the date, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.FORMATTING\_ERROR`.
+
+The `options` parameter is optional, and its default values are:
-The `options.formatLength` can be 'short', 'medium', 'long', or 'full'.
-The `options.selector` can be 'date', 'time' or 'date and time'.
+ {formatLength:'short', selector:'date and time'}
-The default options are `{formatLength:'short', selector:'date and time'}`.
-The `options` parameter is optional.
+The `options.formatLength` can be `short`, `medium`, `long`, or `full`.
+The `options.selector` can be `date`, `time` or `date and time`.
Supported Platforms
-------------------
@@ -54,11 +54,13 @@ Supported Platforms
Quick Example
-------------
-In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "date: 9/25/2012 4:21PM" using the default options.
+If the browser is set to the `en\_US` locale, this should display a
+popup dialog with text similar to `date: 9/25/2012 4:21PM` using the
+default options:
navigator.globalization.dateToString(
new Date(),
- function (date) {alert('date:' + date.value + '\n');},
+ function (date) {alert('date: ' + date.value + '\n');},
function () {alert('Error getting dateString\n');},
{formatLength:'short', selector:'date and time'}
);
@@ -90,4 +92,5 @@ Full Example
Windows Phone 8 Quirks
--------------
-- `formatLength` option supports only short and full values
+
+- The `formatLength` option supports only `short` and `full` values.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
index 4762698..968a940 100644
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@ -20,26 +20,27 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.getCurrencyPattern
===========
-Returns a pattern string for formatting and parsing currency values according
+Returns a pattern string to format and parse currency values according
to the client's user preferences and ISO 4217 currency code.
- navigator.globalization.getCurrencyPattern(currencyCode, successCB, errorCB);
+ navigator.globalization.getCurrencyPattern(currencyCode, successCallback, errorCallback);
Description
-----------
-It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:
+Returns the pattern to the `successCallback` with a `properties` object
+as a parameter. That object should have the following properties:
-- pattern {String}: The currency pattern for formatting and parsing currency values. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
-- code {String}: The ISO 4217 currency code for the pattern.
-- fraction {Number}: The number of fractional digits to use when parsing and formatting currency.
-- rounding {Number}: The rounding increment to use when parsing and formatting.
-- decimal: {String}: The decimal symbol to use for parsing and formatting.
-- grouping: {String}: The grouping symbol to use for parsing and formatting.
+- __pattern__ {String}: The currency pattern for formatting and parsing currency values. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
+- __code__ {String}: The ISO 4217 currency code for the pattern.
+- __fraction__ {Number}: The number of fractional digits to use when parsing and formatting currency.
+- __rounding__ {Number}: The rounding increment to use when parsing and formatting.
+- __decimal__: {String}: The decimal symbol to use for parsing and formatting.
+- __grouping__: {String}: The grouping symbol to use for parsing and formatting.
The inbound `currencyCode` parameter should be a String of one of the ISO 4217 currency codes, for example 'USD'.
-If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+If there is an error obtaining the pattern, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDateNames.md b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
index aa6f89a..fceaf64 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -22,14 +22,14 @@ globalization.getDateNames
Returns an array of either the names of the months or days of the week according to the client's user preferences and calendar.
- navigator.globalization.getDateNames(successCB, errorCB, options);
+ navigator.globalization.getDateNames(successCallback, errorCallback, options);
Description
-----------
-It returns the array of names to the successCB callback with a properties object as a parameter. That object should have a `value` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
+It returns the array of names to the `successCallback` with a properties object as a parameter. That object should have a `value` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
-If there is an error obtaining the names, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error obtaining the names, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
`options.type` can be 'narrow', or 'wide'.
`options.item` can be 'months', or 'days'.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
index 3c43674..03ae3c7 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
@@ -22,19 +22,19 @@ globalization.getDatePattern
Returns a pattern string for formatting and parsing dates according to the client's user preferences.
- navigator.globalization.getDatePattern(successCB, errorCB, options);
+ navigator.globalization.getDatePattern(successCallback, errorCallback, options);
Description
-----------
-It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:
+It returns the pattern to the `successCallback` with a properties object as a parameter. That object should have the following properties:
- pattern {String}: The date and time pattern for formatting and parsing dates. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
- timezone {String}: The abbreviated name of the time zone on the client
- utc\_offset {Number}: The current difference in seconds between the client's time zone and coordinated universal time.
- dst\_offset {Number}: 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.
-If there is an error obtaining the pattern, then the errorCB callback is invokedwith a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR.
+If there is an error obtaining the pattern, then the `errorCallback` is invokedwith a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR.
`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
`options.selector` can be 'date', 'time' or 'date and time'.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
index 15f02e0..84b23eb 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -22,14 +22,14 @@ globalization.getFirstDayOfWeek
Returns the first day of the week according to the client's user preferences and calendar.
- navigator.globalization.getFirstDayOfWeek(successCB, errorCB);
+ navigator.globalization.getFirstDayOfWeek(successCallback, errorCallback);
Description
-----------
-The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the successCB callback with a properties object as a parameter. That object should have a `value` property with a Number value.
+The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a Number value.
-If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error obtaining the pattern, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
index d07939a..6f23bc6 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -22,16 +22,16 @@ globalization.getLocaleName
Get the string identifier for the client's current locale setting.
- navigator.globalization.getLocaleName(successCB, errorCB);
+ navigator.globalization.getLocaleName(successCallback, errorCallback);
Description
-----------
-It returns the locale identifier string to the successCB callback with a
+It returns the locale identifier string to the `successCallback` with a
properties object as a parameter. That object should have a `value` property with a String value.
-If there is an error getting the locale, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error getting the locale, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
index be73239..0af8331 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -22,12 +22,12 @@ globalization.getNumberPattern
Returns a pattern string for formatting and parsing numbers according to the client's user preferences.
- navigator.globalization.getNumberPattern(successCB, errorCB, options);
+ navigator.globalization.getNumberPattern(successCallback, errorCallback, options);
Description
-----------
-It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:
+It returns the pattern to the `successCallback` with a properties object as a parameter. That object should have the following properties:
- pattern {String}: The number pattern for formatting and parsing numbers. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
- symbol {String}: The symbol to be used when formatting and parsing e.g., percent or currency symbol.
@@ -38,7 +38,7 @@ It returns the pattern to the successCB callback with a properties object as a p
- decimal: {String}: The decimal symbol to use for parsing and formatting.
- grouping: {String}: The grouping symbol to use for parsing and formatting.
-If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR.
+If there is an error obtaining the pattern, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR.
`options.type` can be 'decimal', 'percent', or 'currency'.
The default options are `{type:'decimal'}`. The `options` parameter is optional.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
index 8110432..a92a9b3 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -22,16 +22,16 @@ globalization.getPreferredLanguage
Get the string identifier for the client's current language.
- navigator.globalization.getPreferredLanguage(successCB, errorCB);
+ navigator.globalization.getPreferredLanguage(successCallback, errorCallback);
Description
-----------
-It returns the language identifier string to the successCB callback with a
+It returns the language identifier string to the `successCallback` with a
properties object as a parameter. That object should have a `value` property with a String value.
-If there is an error getting the language, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error getting the language, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
index 537339d..5d2b701 100644
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -22,16 +22,16 @@ globalization.isDayLightSavingsTime
Returns whether daylight savings time is in effect for a given date using the client's time zone and calendar.
- navigator.globalization.isDayLightSavingsTime(date, successCB, errorCB);
+ navigator.globalization.isDayLightSavingsTime(date, successCallback, errorCallback);
Description
-----------
-It returns whether or not daylight savings time is in effect to the successCB callback with a properties object as a parameter. That object should have a `dst` property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not.
+It returns whether or not daylight savings time is in effect to the `successCallback` with a properties object as a parameter. That object should have a `dst` property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not.
The inbound parameter `date` should be of type `Date`.
-If there is an error reading the date, then the errorCB callback is invoked. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error reading the date, then the `errorCallback` is invoked. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.numberToString.md b/docs/en/edge/cordova/globalization/globalization.numberToString.md
index c0c9e48..74e6ce9 100644
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.numberToString.md
@@ -22,14 +22,14 @@ globalization.numberToString
Returns a number formatted as a string according to the client's user preferences.
- navigator.globalization.numberToString(number, successCB, errorCB, options);
+ navigator.globalization.numberToString(number, successCallback, errorCallback, options);
Description
-----------
-It returns the formatted number string to the successCB callback with a properties object as a parameter. That object should have a `value` property with a String value.
+It returns the formatted number string to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a String value.
-If there is an error formatting the number, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+If there is an error formatting the number, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
`options.type` can be 'decimal', 'percent', or 'currency'. The default options are `{type:'decimal'}`. The `options` parameter is optional.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToDate.md b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
index fde3847..6849d0a 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
@@ -24,7 +24,7 @@ Parses a date formatted as a string according to the client's user
preferences and calendar using the time zone of the client and returns
the corresponding date object.
- navigator.globalization.stringToDate(dateString, successCB, errorCB, options);
+ navigator.globalization.stringToDate(dateString, successCallback, errorCallback, options);
Description
-----------
@@ -47,7 +47,7 @@ The inbound `dateString` parameter should be of type `String`.
The default options are `{formatLength:'short', selector:'date and time'}`.
The options parameter is optional.
-If there is an error parsing the date string, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
+If there is an error parsing the date string, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
index b0a2627..7928e6c 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
@@ -22,14 +22,14 @@ globalization.stringToNumber
Parses a number formatted as a string according to the client's user preferences and returns the corresponding number.
- navigator.globalization.stringToNumber(string, successCB, errorCB, options);
+ navigator.globalization.stringToNumber(string, successCallback, errorCallback, options);
Description
-----------
-It returns the number to the successCB callback with a properties object as a parameter. That object should have a `value` property with a Number value.
+It returns the number to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a Number value.
-If there is an error parsing the number string, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
+If there is an error parsing the number string, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
`options.type` can be 'decimal', 'percent', or 'currency'.
The default options are `{type:'decimal'}`. The `options` parameter is optional.
[38/46] docs commit: incorporate feedback on tech queries
Posted by mw...@apache.org.
incorporate feedback on tech queries
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/cf1dce9b
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/cf1dce9b
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/cf1dce9b
Branch: refs/heads/master
Commit: cf1dce9bce921546f3ec97cccfb146244839cb86
Parents: fbc5e1d
Author: Mike Sierra <le...@gmail.com>
Authored: Wed May 22 13:28:17 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Wed May 22 13:28:17 2013 -0400
----------------------------------------------------------------------
docs/en/edge/cordova/events/events.offline.md | 6 +++++-
docs/en/edge/cordova/events/events.online.md | 11 ++++++++---
docs/en/edge/cordova/events/events.pause.md | 15 +++++++--------
docs/en/edge/cordova/events/events.resume.md | 5 ++---
.../globalization/globalization.getNumberPattern.md | 1 -
5 files changed, 22 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/cf1dce9b/docs/en/edge/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.offline.md b/docs/en/edge/cordova/events/events.offline.md
index 0a4864a..0f2abe6 100644
--- a/docs/en/edge/cordova/events/events.offline.md
+++ b/docs/en/edge/cordova/events/events.offline.md
@@ -28,7 +28,11 @@ not connected to the Internet.
Details
-------
-The event fires when the network connection is lost.
+The `offline` event fires when a previously connected device loses a
+network connection so that an application can no longer access the
+Internet. It relies on the same information as the Connection API,
+and fires when the `connection.type` changes from `NONE` to any other
+value.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/cf1dce9b/docs/en/edge/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.online.md b/docs/en/edge/cordova/events/events.online.md
index 549359b..6230f95 100644
--- a/docs/en/edge/cordova/events/events.online.md
+++ b/docs/en/edge/cordova/events/events.online.md
@@ -28,8 +28,10 @@ device becomes connected to the Internet.
Details
-------
-When the application's network connection changes to being online, the
-online event is fired.
+The `online` event fires when a previously unconnected device receives
+a network connection to allow an application access to the Internet.
+It relies on the same information as the Connection API, and fires
+when the value of `connection.type` becomes `NONE`.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
@@ -93,7 +95,10 @@ Full Example
iOS Quirks
--------------------------
-During initial startup, the first `online` event (if applicable) takes at least a second to fire.
+
+During initial startup, the first `online` event (if applicable) takes
+at least a second to fire, prior to which `connection.type` is
+`UNKNOWN`.
Windows Phone 7 Quirks
--------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/cf1dce9b/docs/en/edge/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.pause.md b/docs/en/edge/cordova/events/events.pause.md
index 6615369..3dc7a33 100644
--- a/docs/en/edge/cordova/events/events.pause.md
+++ b/docs/en/edge/cordova/events/events.pause.md
@@ -27,9 +27,9 @@ The event fires when a Cordova application is put into the background.
Details
-------
-Cordova consists of two code bases: native and JavaScript. When the
-native code puts the application into the background, the `pause` event
-fires.
+The `pause` event fires when the native platform puts the application
+into the background, typically when the user switches to a different
+application.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
@@ -93,11 +93,10 @@ Full Example
iOS Quirks
--------------------------
-In the `pause` handler, any calls that go through Objective-C do not
-work, nor do any calls that are interactive, such as alerts. You
-can't make calls with `console.log()`, or any calls from plugins or
-the Cordova API. They are only processed when the app resumes, on the
-next run-loop.
+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
+interactive calls, such as alerts or `console.log()`. They are only
+processed when the app resumes, on the next run loop.
The iOS-specific `resign` event is available as an alternative to
`pause`, and detects when users enable the __Lock__ button to lock the
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/cf1dce9b/docs/en/edge/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.resume.md b/docs/en/edge/cordova/events/events.resume.md
index 2bded1c..d9c99d9 100644
--- a/docs/en/edge/cordova/events/events.resume.md
+++ b/docs/en/edge/cordova/events/events.resume.md
@@ -27,9 +27,8 @@ The event fires when a Cordova application is retrieved from the background.
Details
-------
-Cordova consists of two code bases: native and JavaScript. The
-`resume` event fires when the native code pulls the application from
-the background.
+The `resume` event fires when the native platform pulls the
+application out from the background.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/cf1dce9b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
index 8d81f57..f2d1031 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -49,7 +49,6 @@ The `options` parameter is optional, and default values are:
The `options.type` can be `decimal`, `percent`, or `currency`.
-
Supported Platforms
-------------------
[21/46] to start of file api
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocationError.md b/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
index c0091a0..4f35e6b 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md b/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
index b70a579..1e7416f 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
index 646fac7..870903f 100644
--- a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
+++ b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.dateToString.md b/docs/en/edge/cordova/globalization/globalization.dateToString.md
index 19c6c18..f748b37 100644
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
index 2f591cc..4762698 100644
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDateNames.md b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
index 92db64a..92863cd 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
index fd918b4..3c43674 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
index 810723d..ea2e0da 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
index 046efa4..4a30024 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
index 5be264f..be73239 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
index 51cb84d..6ffb40d 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
index 0f80525..2ecf085 100644
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.md b/docs/en/edge/cordova/globalization/globalization.md
index 15e787e..dacf13f 100644
--- a/docs/en/edge/cordova/globalization/globalization.md
+++ b/docs/en/edge/cordova/globalization/globalization.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.numberToString.md b/docs/en/edge/cordova/globalization/globalization.numberToString.md
index e0669a3..51e8cff 100644
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.numberToString.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToDate.md b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
index 07478ec..fde3847 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
index 65a4cca..db5cf70 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/inappbrowser/inappbrowser.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/inappbrowser.md b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
index c8df9ac..a1ef051 100644
--- a/docs/en/edge/cordova/inappbrowser/inappbrowser.md
+++ b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/inappbrowser/window.open.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/window.open.md b/docs/en/edge/cordova/inappbrowser/window.open.md
index 2652edb..95fb1d2 100644
--- a/docs/en/edge/cordova/inappbrowser/window.open.md
+++ b/docs/en/edge/cordova/inappbrowser/window.open.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/MediaError/mediaError.md b/docs/en/edge/cordova/media/MediaError/mediaError.md
index d0a1d8f..c466a05 100644
--- a/docs/en/edge/cordova/media/MediaError/mediaError.md
+++ b/docs/en/edge/cordova/media/MediaError/mediaError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/Parameters/mediaError.md b/docs/en/edge/cordova/media/Parameters/mediaError.md
index e1803b4..4eab2de 100644
--- a/docs/en/edge/cordova/media/Parameters/mediaError.md
+++ b/docs/en/edge/cordova/media/Parameters/mediaError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureCB.md b/docs/en/edge/cordova/media/capture/CaptureCB.md
index 8182554..b020fb0 100644
--- a/docs/en/edge/cordova/media/capture/CaptureCB.md
+++ b/docs/en/edge/cordova/media/capture/CaptureCB.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureError.md b/docs/en/edge/cordova/media/capture/CaptureError.md
index d94f885..a7dc6e2 100644
--- a/docs/en/edge/cordova/media/capture/CaptureError.md
+++ b/docs/en/edge/cordova/media/capture/CaptureError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureErrorCB.md b/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
index 948140a..b54e646 100644
--- a/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
+++ b/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/ConfigurationData.md b/docs/en/edge/cordova/media/capture/ConfigurationData.md
index 46fc55a..863ffe2 100644
--- a/docs/en/edge/cordova/media/capture/ConfigurationData.md
+++ b/docs/en/edge/cordova/media/capture/ConfigurationData.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md b/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
index a86e3fa..76662ae 100644
--- a/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFile.md b/docs/en/edge/cordova/media/capture/MediaFile.md
index fe3d9a1..b0cd33e 100644
--- a/docs/en/edge/cordova/media/capture/MediaFile.md
+++ b/docs/en/edge/cordova/media/capture/MediaFile.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -34,4 +34,4 @@ Properties
Methods
-------
-- __MediaFile.getFormatData:__ Retrieves the format information of the media file.
\ No newline at end of file
+- __MediaFile.getFormatData:__ Retrieves the format information of the media file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFileData.md b/docs/en/edge/cordova/media/capture/MediaFileData.md
index b29908c..dcb3cdc 100644
--- a/docs/en/edge/cordova/media/capture/MediaFileData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFileData.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/capture.md b/docs/en/edge/cordova/media/capture/capture.md
index ebef5cc..3fdefd5 100644
--- a/docs/en/edge/cordova/media/capture/capture.md
+++ b/docs/en/edge/cordova/media/capture/capture.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudio.md b/docs/en/edge/cordova/media/capture/captureAudio.md
index ad17b46..aceab94 100644
--- a/docs/en/edge/cordova/media/capture/captureAudio.md
+++ b/docs/en/edge/cordova/media/capture/captureAudio.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudioOptions.md b/docs/en/edge/cordova/media/capture/captureAudioOptions.md
index c918c50..a510d17 100644
--- a/docs/en/edge/cordova/media/capture/captureAudioOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureAudioOptions.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureImage.md b/docs/en/edge/cordova/media/capture/captureImage.md
index e88aad0..5930897 100644
--- a/docs/en/edge/cordova/media/capture/captureImage.md
+++ b/docs/en/edge/cordova/media/capture/captureImage.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureImageOptions.md b/docs/en/edge/cordova/media/capture/captureImageOptions.md
index f7ab810..f999766 100644
--- a/docs/en/edge/cordova/media/capture/captureImageOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureImageOptions.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureVideo.md b/docs/en/edge/cordova/media/capture/captureVideo.md
index fba61fe..7a75725 100644
--- a/docs/en/edge/cordova/media/capture/captureVideo.md
+++ b/docs/en/edge/cordova/media/capture/captureVideo.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureVideoOptions.md b/docs/en/edge/cordova/media/capture/captureVideoOptions.md
index 1a1ac24..627e7eb 100644
--- a/docs/en/edge/cordova/media/capture/captureVideoOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureVideoOptions.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.getCurrentPosition.md b/docs/en/edge/cordova/media/media.getCurrentPosition.md
index 1aecb0f..f858bb1 100644
--- a/docs/en/edge/cordova/media/media.getCurrentPosition.md
+++ b/docs/en/edge/cordova/media/media.getCurrentPosition.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/media.getDuration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.getDuration.md b/docs/en/edge/cordova/media/media.getDuration.md
index 40d8b2b..a558f31 100644
--- a/docs/en/edge/cordova/media/media.getDuration.md
+++ b/docs/en/edge/cordova/media/media.getDuration.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/media.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.md b/docs/en/edge/cordova/media/media.md
index 5559f8f..1632c1e 100644
--- a/docs/en/edge/cordova/media/media.md
+++ b/docs/en/edge/cordova/media/media.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/media.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.pause.md b/docs/en/edge/cordova/media/media.pause.md
index c937e66..4910c37 100644
--- a/docs/en/edge/cordova/media/media.pause.md
+++ b/docs/en/edge/cordova/media/media.pause.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/media.play.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.play.md b/docs/en/edge/cordova/media/media.play.md
index cc6abf9..67b508d 100644
--- a/docs/en/edge/cordova/media/media.play.md
+++ b/docs/en/edge/cordova/media/media.play.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/media.release.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.release.md b/docs/en/edge/cordova/media/media.release.md
index fb4f82a..6528cdc 100644
--- a/docs/en/edge/cordova/media/media.release.md
+++ b/docs/en/edge/cordova/media/media.release.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/media.seekTo.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.seekTo.md b/docs/en/edge/cordova/media/media.seekTo.md
index 96cbfc0..f737480 100644
--- a/docs/en/edge/cordova/media/media.seekTo.md
+++ b/docs/en/edge/cordova/media/media.seekTo.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.startRecord.md b/docs/en/edge/cordova/media/media.startRecord.md
index b0dee1b..f4f2d42 100644
--- a/docs/en/edge/cordova/media/media.startRecord.md
+++ b/docs/en/edge/cordova/media/media.startRecord.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/media.stop.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.stop.md b/docs/en/edge/cordova/media/media.stop.md
index 777dea7..52b9037 100644
--- a/docs/en/edge/cordova/media/media.stop.md
+++ b/docs/en/edge/cordova/media/media.stop.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/media/media.stopRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.stopRecord.md b/docs/en/edge/cordova/media/media.stopRecord.md
index fb2ddd0..e04e7cb 100644
--- a/docs/en/edge/cordova/media/media.stopRecord.md
+++ b/docs/en/edge/cordova/media/media.stopRecord.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/notification/notification.alert.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.alert.md b/docs/en/edge/cordova/notification/notification.alert.md
index e383ab9..c7a38c8 100644
--- a/docs/en/edge/cordova/notification/notification.alert.md
+++ b/docs/en/edge/cordova/notification/notification.alert.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.beep.md b/docs/en/edge/cordova/notification/notification.beep.md
index 6bccfd0..e59e625 100644
--- a/docs/en/edge/cordova/notification/notification.beep.md
+++ b/docs/en/edge/cordova/notification/notification.beep.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.confirm.md b/docs/en/edge/cordova/notification/notification.confirm.md
index 63e13c7..cd99bb2 100755
--- a/docs/en/edge/cordova/notification/notification.confirm.md
+++ b/docs/en/edge/cordova/notification/notification.confirm.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/notification/notification.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.md b/docs/en/edge/cordova/notification/notification.md
index 2f6c059..68f838d 100644
--- a/docs/en/edge/cordova/notification/notification.md
+++ b/docs/en/edge/cordova/notification/notification.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.prompt.md b/docs/en/edge/cordova/notification/notification.prompt.md
index 26192b3..78f3db7 100644
--- a/docs/en/edge/cordova/notification/notification.prompt.md
+++ b/docs/en/edge/cordova/notification/notification.prompt.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/notification/notification.vibrate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.vibrate.md b/docs/en/edge/cordova/notification/notification.vibrate.md
index 5a13ab3..20f7815 100644
--- a/docs/en/edge/cordova/notification/notification.vibrate.md
+++ b/docs/en/edge/cordova/notification/notification.vibrate.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/splashscreen/splashscreen.hide.md b/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
index 2b07d73..0a198bb 100644
--- a/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
+++ b/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/splashscreen/splashscreen.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/splashscreen/splashscreen.md b/docs/en/edge/cordova/splashscreen/splashscreen.md
index 93519c8..d939d9d 100644
--- a/docs/en/edge/cordova/splashscreen/splashscreen.md
+++ b/docs/en/edge/cordova/splashscreen/splashscreen.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/splashscreen/splashscreen.show.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/splashscreen/splashscreen.show.md b/docs/en/edge/cordova/splashscreen/splashscreen.show.md
index 3e22736..e50e623 100644
--- a/docs/en/edge/cordova/splashscreen/splashscreen.show.md
+++ b/docs/en/edge/cordova/splashscreen/splashscreen.show.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/database/database.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/database/database.md b/docs/en/edge/cordova/storage/database/database.md
index 8e84e45..1d56823 100644
--- a/docs/en/edge/cordova/storage/database/database.md
+++ b/docs/en/edge/cordova/storage/database/database.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/localstorage/localstorage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/localstorage/localstorage.md b/docs/en/edge/cordova/storage/localstorage/localstorage.md
index df95ad2..21ca8ff 100644
--- a/docs/en/edge/cordova/storage/localstorage/localstorage.md
+++ b/docs/en/edge/cordova/storage/localstorage/localstorage.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/parameters/display_name.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/parameters/display_name.md b/docs/en/edge/cordova/storage/parameters/display_name.md
index 69af089..910a980 100644
--- a/docs/en/edge/cordova/storage/parameters/display_name.md
+++ b/docs/en/edge/cordova/storage/parameters/display_name.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,4 +20,4 @@ license: Licensed to the Apache Software Foundation (ASF) under one
database_displayname
==================
-The display name of the database.
\ No newline at end of file
+The display name of the database.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/parameters/name.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/parameters/name.md b/docs/en/edge/cordova/storage/parameters/name.md
index c39dcbf..f77f967 100644
--- a/docs/en/edge/cordova/storage/parameters/name.md
+++ b/docs/en/edge/cordova/storage/parameters/name.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,4 +20,4 @@ license: Licensed to the Apache Software Foundation (ASF) under one
database_name
============
-The name of the database.
\ No newline at end of file
+The name of the database.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/parameters/size.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/parameters/size.md b/docs/en/edge/cordova/storage/parameters/size.md
index 9b46993..fd77dcd 100644
--- a/docs/en/edge/cordova/storage/parameters/size.md
+++ b/docs/en/edge/cordova/storage/parameters/size.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,4 +20,4 @@ license: Licensed to the Apache Software Foundation (ASF) under one
database_size
==============
-The size of the database in bytes.
\ No newline at end of file
+The size of the database in bytes.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/parameters/version.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/parameters/version.md b/docs/en/edge/cordova/storage/parameters/version.md
index 2e72923..199cb3b 100644
--- a/docs/en/edge/cordova/storage/parameters/version.md
+++ b/docs/en/edge/cordova/storage/parameters/version.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlerror/sqlerror.md b/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
index b700222..c56c16a 100644
--- a/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
+++ b/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
index 5a04a8f..13d0402 100644
--- a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
+++ b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
index 74fa5af..37587f2 100644
--- a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
+++ b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
index f1348f3..107668e 100644
--- a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
+++ b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/storage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/storage.md b/docs/en/edge/cordova/storage/storage.md
index d2ecc6c..cd679b2 100644
--- a/docs/en/edge/cordova/storage/storage.md
+++ b/docs/en/edge/cordova/storage/storage.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/storage/storage.opendatabase.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/storage.opendatabase.md b/docs/en/edge/cordova/storage/storage.opendatabase.md
index 444e566..9d3d19a 100644
--- a/docs/en/edge/cordova/storage/storage.opendatabase.md
+++ b/docs/en/edge/cordova/storage/storage.opendatabase.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
[31/46] docs commit: thru media
Posted by mw...@apache.org.
thru media
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/45f896ae
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/45f896ae
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/45f896ae
Branch: refs/heads/master
Commit: 45f896ae7aae46d630680259895820ccf900871c
Parents: 4977836
Author: Mike Sierra <le...@gmail.com>
Authored: Fri May 17 16:24:39 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Fri May 17 16:24:39 2013 -0400
----------------------------------------------------------------------
.../en/edge/cordova/camera/camera.getPicture.md | 2 +-
.../cordova/compass/compass.watchHeading.md | 2 +-
.../cordova/events/events.batterycritical.md | 4 +-
.../en/edge/cordova/events/events.batterylow.md | 2 +-
.../edge/cordova/events/events.batterystatus.md | 2 +-
.../file/directoryentry/directoryentry.md | 12 ++---
.../en/edge/cordova/file/fileentry/fileentry.md | 4 +-
.../cordova/file/filetransfer/filetransfer.md | 6 +--
.../geolocation.getCurrentPosition.md | 4 +-
.../geolocation/geolocation.watchPosition.md | 2 +-
.../parameters/geolocation.options.md | 2 +-
.../edge/cordova/media/MediaError/mediaError.md | 10 ++--
.../edge/cordova/media/Parameters/mediaError.md | 5 +-
docs/en/edge/cordova/media/capture/CaptureCB.md | 9 ++--
.../edge/cordova/media/capture/CaptureError.md | 12 ++---
.../cordova/media/capture/CaptureErrorCB.md | 10 ++--
.../cordova/media/capture/ConfigurationData.md | 22 +++++----
.../media/capture/MediaFile.getFormatData.md | 21 +++++++--
docs/en/edge/cordova/media/capture/MediaFile.md | 6 +--
.../edge/cordova/media/capture/MediaFileData.md | 49 +++++++++++---------
docs/en/edge/cordova/media/capture/capture.md | 13 +++---
.../edge/cordova/media/capture/captureAudio.md | 27 +++++++----
.../media/capture/captureAudioOptions.md | 8 ++--
.../edge/cordova/media/capture/captureImage.md | 34 +++++++++-----
.../media/capture/captureImageOptions.md | 6 +--
.../edge/cordova/media/capture/captureVideo.md | 37 +++++++++------
.../media/capture/captureVideoOptions.md | 11 +++--
.../cordova/media/media.getCurrentPosition.md | 10 ++--
docs/en/edge/cordova/media/media.getDuration.md | 6 ++-
docs/en/edge/cordova/media/media.md | 45 ++++++++++--------
docs/en/edge/cordova/media/media.pause.md | 4 +-
docs/en/edge/cordova/media/media.play.md | 35 ++++++++------
docs/en/edge/cordova/media/media.release.md | 10 ++--
docs/en/edge/cordova/media/media.seekTo.md | 10 ++--
docs/en/edge/cordova/media/media.startRecord.md | 15 +++---
docs/en/edge/cordova/media/media.stop.md | 5 +-
docs/en/edge/cordova/media/media.stopRecord.md | 7 +--
.../notification/notification.confirm.md | 3 +-
.../edge/cordova/notification/notification.md | 10 ++--
.../cordova/notification/notification.prompt.md | 2 +-
.../storage/sqlresultset/sqlresultset.md | 5 +-
.../storage/sqltransaction/sqltransaction.md | 2 +-
42 files changed, 288 insertions(+), 203 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.getPicture.md b/docs/en/edge/cordova/camera/camera.getPicture.md
index cae7aba..3fc21d6 100644
--- a/docs/en/edge/cordova/camera/camera.getPicture.md
+++ b/docs/en/edge/cordova/camera/camera.getPicture.md
@@ -58,7 +58,7 @@ example:
- 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
+__NOTE:__ Photo resolution on newer devices is quite good. Photos
selected from the device's gallery are not downscaled to a lower
quality, even if a `quality` parameter is specified. To avoid common
memory problems, set `Camera.destinationType` to `FILE_URI` rather
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeading.md b/docs/en/edge/cordova/compass/compass.watchHeading.md
index b3c9fd5..c617c60 100755
--- a/docs/en/edge/cordova/compass/compass.watchHeading.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeading.md
@@ -138,7 +138,7 @@ iOS Quirks
In iOS `compass.watchHeading` can also get the device's current
heading when it changes by a specified number of degrees. Each time
the heading changes by the specified number of degrees or more, the
-`headingSuccess` callback function is called. Specify the degrees of
+`headingSuccess` callback function executes. Specify the degrees of
change via the `filter` parameter in the `compassOptions` object.
Clear the watch as usual by passing the returned watch ID to
`compass.clearWatch`. This functionality replaces the previously
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterycritical.md b/docs/en/edge/cordova/events/events.batterycritical.md
index 166cc60..5ebea4b 100644
--- a/docs/en/edge/cordova/events/events.batterycritical.md
+++ b/docs/en/edge/cordova/events/events.batterycritical.md
@@ -31,8 +31,8 @@ Details
The event fires when the percentage of battery charge has reached the
critical battery threshold. The value is device-specific.
-The `batterycritical` handler is called with an object that contains
-two properties:
+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)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterylow.md b/docs/en/edge/cordova/events/events.batterylow.md
index 7014765..b156454 100644
--- a/docs/en/edge/cordova/events/events.batterylow.md
+++ b/docs/en/edge/cordova/events/events.batterylow.md
@@ -30,7 +30,7 @@ Details
The event fires when the percentage of battery charge has reached the
low battery threshold, device-specific value.
-The `batterylow` handler is called with an object that contains two
+The `batterylow` handler is passed an object that contains two
properties:
- __level__: The percentage of battery charge (0-100). _(Number)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterystatus.md b/docs/en/edge/cordova/events/events.batterystatus.md
index 57ed6ef..728aca2 100644
--- a/docs/en/edge/cordova/events/events.batterystatus.md
+++ b/docs/en/edge/cordova/events/events.batterystatus.md
@@ -30,7 +30,7 @@ Details
This event fires when the percentage of battery charge changes by at
least 1 percent, or if the device is plugged in or unplugged.
-The battery status handler is called with an object that contains two
+The battery status handler is passed an object that contains two
properties:
- __level__: The percentage of battery charge (0-100). _(Number)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index 661768d..a5b54e3 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -246,8 +246,8 @@ Deletes a directory. An error results if the app attempts to:
__Parameters:__
-- __successCallback__: A callback that is called after the directory has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__: A callback that is called if an error occurs when attempting to delete the directory. Invoked with a `FileError` object. _(Function)_
+- __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__
@@ -265,12 +265,12 @@ __Quick Example__
getParent
---------
-Look up the parent DirectoryEntry containing the directory.
+Look up the parent `DirectoryEntry` containing the directory.
__Parameters:__
-- __successCallback__: A callback that is called with the directory's parent DirectoryEntry. _(Function)_
-- __errorCallback__: A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a `FileError` object. _(Function)_
+- __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__
@@ -334,7 +334,7 @@ __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 is called if an error occurs when creating or looking up the file. Invoked with a `FileError` 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__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileentry/fileentry.md b/docs/en/edge/cordova/file/fileentry/fileentry.md
index 9689f26..4b6f651 100644
--- a/docs/en/edge/cordova/file/fileentry/fileentry.md
+++ b/docs/en/edge/cordova/file/fileentry/fileentry.md
@@ -259,8 +259,8 @@ 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)_
+- __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__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfer/filetransfer.md b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
index d1cfc08..46aca45 100644
--- a/docs/en/edge/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
@@ -64,8 +64,8 @@ __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 called with a `Metadata` object. _(Function)_
-- __errorCallback__: A callback that is called if an error occurs retrieving the `Metadata`. Invoked with a `FileTransferError` object. _(Function)_
+- __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)_
@@ -239,7 +239,7 @@ __Quick Example__
abort
--------------
-Aborts an in-progress transfer. The onerror callback is called with a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
+Aborts an in-progress transfer. The onerror callback is passed a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
__Supported Platforms__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
index 96c8be1..51beb4a 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -29,8 +29,8 @@ Returns the device's current position as a `Position` object.
Parameters
----------
-- __geolocationSuccess__: The callback that is called with the current position.
-- __geolocationError__: _(Optional)_ The callback that is called if there was an error.
+- __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/45f896ae/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
index 72693e4..21877dc 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
@@ -30,7 +30,7 @@ Parameters
----------
- __geolocationSuccess__: The callback that is passed the current position.
-- __geolocationError__: (Optional) The callback that executes if there was an error.
+- __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/45f896ae/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
index ff4d540..ba6cd54 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
@@ -29,7 +29,7 @@ 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 is invoked. 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)_
+- __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/45f896ae/docs/en/edge/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/MediaError/mediaError.md b/docs/en/edge/cordova/media/MediaError/mediaError.md
index e65d471..5652a27 100644
--- a/docs/en/edge/cordova/media/MediaError/mediaError.md
+++ b/docs/en/edge/cordova/media/MediaError/mediaError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,13 +20,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
MediaError
==========
-A `MediaError` object is returned to the `mediaError` callback function when an error occurs.
+A `MediaError` object is returned to the `mediaError` callback
+function when an error occurs.
Properties
----------
- __code__: One of the predefined error codes listed below.
-- __message__: Error message describing the details of the error.
+- __message__: An error message describing the details of the error.
Constants
---------
@@ -39,5 +40,6 @@ Constants
Description
-----------
-The `MediaError` object is returned to the user through the `mediaError` callback function when an error occurs.
+The `MediaError` object is passed to a `mediaError` callback function
+when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/Parameters/mediaError.md b/docs/en/edge/cordova/media/Parameters/mediaError.md
index f152ab4..08b4400 100644
--- a/docs/en/edge/cordova/media/Parameters/mediaError.md
+++ b/docs/en/edge/cordova/media/Parameters/mediaError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,8 @@ license: Licensed to the Apache Software Foundation (ASF) under one
mediaError
==========
-A user specified callback function that is invoked when there is an error in media functions.
+A user-specified callback function that executes when there is an
+error in media functions.
function(error) {
// Handle the error
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureCB.md b/docs/en/edge/cordova/media/capture/CaptureCB.md
index b020fb0..d1d7599 100644
--- a/docs/en/edge/cordova/media/capture/CaptureCB.md
+++ b/docs/en/edge/cordova/media/capture/CaptureCB.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,9 +27,12 @@ CaptureCB
Description
-----------
-This function is invoked after a successful capture operation has completed. This means a media file has been captured, and either the user has exited the media capture application, or the capture limit has been reached.
+This function executes after a successful capture operation completes.
+At this point a media file has been captured, and either the user has
+exited the media capture application, or the capture limit has been
+reached.
-Each MediaFile object describes a captured media file.
+Each `MediaFile` object describes a captured media file.
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureError.md b/docs/en/edge/cordova/media/capture/CaptureError.md
index 310f3e9..0268f06 100644
--- a/docs/en/edge/cordova/media/capture/CaptureError.md
+++ b/docs/en/edge/cordova/media/capture/CaptureError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -30,8 +30,8 @@ Properties
Constants
---------
-- CaptureError.`CAPTURE_INTERNAL_ERR`: Camera or microphone failed to capture image or sound.
-- CaptureError.`CAPTURE_APPLICATION_BUSY`: Camera application or audio capture application is currently serving other capture request.
-- CaptureError.`CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. limit parameter has value less than one).
-- CaptureError.`CAPTURE_NO_MEDIA_FILES`: User exited camera application or audio capture application before capturing anything.
-- CaptureError.`CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
+- `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/45f896ae/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureErrorCB.md b/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
index b54e646..f3771e6 100644
--- a/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
+++ b/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,9 +27,13 @@ CaptureErrorCB
Description
-----------
-This function is invoked if an error occurs when trying to launch a media capture operation and the capture application is busy, if an error occurs while the capture operation is taking place, or if the capture operation has been canceled by the user before any media files have been captured.
+This function executes if an error occurs when trying to launch a
+media capture operation. Failure scenarios include when the capture
+application is busy, a capture operation is already taking place, or
+the user cancels the operation before any media files are captured.
-This function is invoked with a CaptureError object containing an appropriate error code.
+This function executes with a `CaptureError` object containing an
+appropriate error `code`.
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/ConfigurationData.md b/docs/en/edge/cordova/media/capture/ConfigurationData.md
index c86eafb..361f45a 100644
--- a/docs/en/edge/cordova/media/capture/ConfigurationData.md
+++ b/docs/en/edge/cordova/media/capture/ConfigurationData.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -25,22 +25,24 @@ ConfigurationData
Description
-----------
-This object is used to describe media capture modes supported by the device. The configuration data includes the MIME type, and capture dimensions (for video or image capture).
+Describes media capture modes supported by the device. The
+configuration data includes the MIME type, and capture dimensions for
+video or image capture.
The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). Examples:
-- video/3gpp
-- video/quicktime
-- image/jpeg
-- audio/amr
-- audio/wav
+- `video/3gpp`
+- `video/quicktime`
+- `image/jpeg`
+- `audio/amr`
+- `audio/wav`
Properties
----------
-- __type__: The ASCII-encoded string in lower case representing the media type. (DOMString)
-- __height__: The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-- __width__: The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
+- __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/45f896ae/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md b/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
index 76662ae..03fdd00 100644
--- a/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -30,7 +30,11 @@ MediaFile.getFormatData
Description
-----------
-This function asynchronously attempts to retrieve the format information for the media file. If successful, it invokes the MediaFileDataSuccessCB callback with a MediaFileData object. If the attempt fails, this function will invoke the MediaFileDataErrorCB callback.
+This function asynchronously attempts to retrieve the format
+information for the media file. If successful, it invokes the
+`MediaFileDataSuccessCB` callback with a `MediaFileData` object. If
+the attempt fails, this function invokes the `MediaFileDataErrorCB`
+callback.
Supported Platforms
-------------------
@@ -43,12 +47,19 @@ Supported Platforms
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. Therefore, all MediaFileData objects will be returned with default values. See MediaFileData documentation.
+
+Does not provide an API for information about media files, so all
+`MediaFileData` objects return with default values.
Android Quirks
--------------
-The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
+
+The API to access media file format information is limited, so not all
+`MediaFileData` properties are supported.
iOS Quirks
----------
-The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
+
+The API to access media file format information is limited, so not all
+`MediaFileData` properties are supported.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFile.md b/docs/en/edge/cordova/media/capture/MediaFile.md
index eae4810..3bca7aa 100644
--- a/docs/en/edge/cordova/media/capture/MediaFile.md
+++ b/docs/en/edge/cordova/media/capture/MediaFile.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,8 +27,8 @@ Properties
- __name__: The name of the file, without path information. (DOMString)
- __fullPath__: The full path of the file, including the name. (DOMString)
-- __type__: The mime type (DOMString)
-- __lastModifiedDate__: The date and time that the file was last modified. (Date)
+- __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/45f896ae/docs/en/edge/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFileData.md b/docs/en/edge/cordova/media/capture/MediaFileData.md
index 4ff8939..545b549 100644
--- a/docs/en/edge/cordova/media/capture/MediaFileData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFileData.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -26,37 +26,40 @@ Properties
----------
- __codecs__: The actual format of the audio and video content. (DOMString)
-- __bitrate__: The average bitrate of the content. In case of an image, this attribute has value 0. (Number)
-- __height__: The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-- __width__: The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-- __duration__: The length of the video or sound clip in seconds. In the case of an image, this attribute has value 0. (Number)
+- __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
--------------------------
-There is no API that provides format information of media files. So the MediaFileData object returned by the MediaFile.getFormatData function will have the following default values:
-- __codecs__: Not supported. The attribute will always be null.
-- __bitrate__: Not supported. The attribute will always be 0.
-- __height__: Not supported. The attribute will always be 0.
-- __width__: Not supported. The attribute will always be 0.
-- __duration__: Not supported. The attribute will always be 0.
+No API provides format information for media files, so the
+`MediaFileData` object returned by `MediaFile.getFormatData` features
+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
--------------
-Support for the MediaFileData properties is as follows:
+Supports the following `MediaFileData` properties:
-- __codecs__: Not supported. The attribute will always be null.
-- __bitrate__: Not supported. The attribute will always be 0.
-- __height__: Supported. (Image and video files only).
-- __width__: Supported. (Image and video files only).
-- __duration__: Supported. (Audio and video files only).
+- __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
----------
-Support for the MediaFileData properties is as follows:
+Supports the following `MediaFileData` properties:
-- __codecs__: Not supported. The attribute will always be null.
-- __bitrate__: Supported on iOS4 devices for audio only. The attribute will always be 0 for image and video.
-- __height__: Supported. (Image and video files only).
-- __width__: Supported. (Image and video files only).
-- __duration__: Supported. (Audio and video files only).
+- __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/45f896ae/docs/en/edge/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/capture.md b/docs/en/edge/cordova/media/capture/capture.md
index ffa8553..013d11b 100644
--- a/docs/en/edge/cordova/media/capture/capture.md
+++ b/docs/en/edge/cordova/media/capture/capture.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Capture
=======
-> Provides access to the audio, image, and video capture capabilities of the device.
+> Provides access to the device's audio, image, and video capture capabilities.
Objects
-------
@@ -46,7 +46,8 @@ Methods
Scope
-----
-The __capture__ object is assigned to the __navigator.device__ object, and therefore has global scope.
+The `capture` object is assigned to the `navigator.device` object, and
+therefore has global scope.
// The global capture object
var capture = navigator.device.capture;
@@ -61,9 +62,9 @@ Properties
Methods
-------
-- capture.captureAudio: Launch the device audio recording application for recording audio clip(s).
-- capture.captureImage: Launch the device camera application for taking image(s).
-- capture.captureVideo: Launch the device video recorder application for recording video(s).
+- `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
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudio.md b/docs/en/edge/cordova/media/capture/captureAudio.md
index e32d96c..cfc318a 100644
--- a/docs/en/edge/cordova/media/capture/captureAudio.md
+++ b/docs/en/edge/cordova/media/capture/captureAudio.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -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 captured audio clip file(s).
+> Start the audio recorder application and return information about the captured audio clip file(s).
navigator.device.capture.captureAudio(
CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
@@ -29,11 +29,22 @@ capture.captureAudio
Description
-----------
-This method starts an asynchronous operation to capture audio recordings using the device's default audio recording application. The operation allows the device user to capture multiple recordings in a single session.
+Starts an asynchronous operation to capture audio recordings using the
+device's default audio recording application. The operation allows
+the device user to capture multiple recordings in a single session.
-The capture operation ends when either the user exits the audio recording application, or the maximum number of recordings, specified by the __limit__ parameter in CaptureAudioOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single audio clip.
+The capture operation ends when either the user exits the audio
+recording application, or the maximum number of recordings specified
+by `CaptureAudioOptions.limit` is reached. If no `limit` parameter
+value is specified, it defaults to one (1), and the capture operation
+terminates after the user records a single audio clip.
-When the capture operation is finished, it will invoke the CaptureCallback callback with an array of MediaFile objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the CaptureErrorCallback callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation finishes, the `CaptureCallback` executes
+with an array of `MediaFile` objects describing each captured audio
+clip file. If the user terminates the operation before an audio clip
+is captured, the `CaptureErrorCallback` executes with a `CaptureError`
+object, featuring the `CaptureError.CAPTURE_NO_MEDIA_FILES` error
+code.
Supported Platforms
-------------------
@@ -128,14 +139,14 @@ Full Example
BlackBerry WebWorks Quirks
--------------------------
-- Cordova for BlackBerry WebWorks attempts to launch the __Voice Notes Recorder__ application, provided by RIM, to capture the audio recordings. The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
+- Cordova for BlackBerry WebWorks attempts to launch the __Voice Notes Recorder__ application, provided by RIM, to capture audio recordings. The app receives a `CaptureError.CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
iOS Quirks
----------
-- iOS does not have a default audio recording application so a simple user interface is provided.
+- iOS does not have a default audio recording application, so a simple user interface is provided.
Windows Phone 7 and 8 Quirks
----------
-- Windows Phone 7 does not have a default audio recording application so a simple user interface is provided.
+- Windows Phone 7 does not have a default audio recording application, so a simple user interface is provided.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudioOptions.md b/docs/en/edge/cordova/media/capture/captureAudioOptions.md
index 583a7f5..c7d7ac2 100644
--- a/docs/en/edge/cordova/media/capture/captureAudioOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureAudioOptions.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -39,14 +39,14 @@ Quick Example
Android Quirks
--------------
-- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
+- The `duration` parameter is not supported. Recording lengths cannot be limited programmatically.
BlackBerry WebWorks Quirks
--------------------------
-- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
+- The `duration` parameter is not supported. Recording lengths cannot be limited programmatically.
iOS Quirks
----------
-- The __limit__ parameter is not supported. One recording can be created for each invocation.
+- The `limit` parameter is not supported, so only one recording can be created for each invocation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureImage.md b/docs/en/edge/cordova/media/capture/captureImage.md
index 5930897..3bbc124 100644
--- a/docs/en/edge/cordova/media/capture/captureImage.md
+++ b/docs/en/edge/cordova/media/capture/captureImage.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -29,11 +29,21 @@ capture.captureImage
Description
-----------
-This method starts an asynchronous operation to capture images using the device camera application. The operation allows the device user to capture multiple images in a single session.
+Starts an asynchronous operation to capture images using the device's
+camera application. The operation allows users to capture more than
+one image in a single session.
-The capture operation ends when either the user exits the camera application, or the maximum number of images, specified by the __limit__ parameter in CaptureImageOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user captures a single image.
+The capture operation ends either when the user closes the camera
+application, or the maximum number of recordings specified by
+`CaptureAudioOptions.limit` is reached. If no `limit` value is
+specified, it defaults to one (1), and the capture operation
+terminates after the user captures a single image.
-When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured image file. If the operation is terminated by the user before an image is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation finishes, it invokes the `CaptureCB`
+callback with an array of `MediaFile` objects describing each captured
+image file. If the user terminates the operation before capturing an
+image, the `CaptureErrorCB` callback executes with a `CaptureError`
+object featuring a `CaptureError.CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------
@@ -49,7 +59,7 @@ Windows Phone 7 Quirks
----------------------
Invoking the native camera application while your device is connected
-via Zune will not work, and the error callback will be triggered.
+via Zune does not work, and the error callback executes.
Quick Example
-------------
@@ -135,24 +145,24 @@ Full Example
Bada Quirks
-----------
-Bada supports _captureImage_ just like the other platforms. However there is _another_ mode where you can capture a video or an image straight in the webview without launching any camera app. In order to do that you need to:
+Bada supports `captureImage` just like the other platforms, but
+features _another_ mode allowing video or image capture straight into
+the WebView without launching any camera app. Here's how:
-1. create a _<div>_ element somewhere in your document and give it an id (such as "preview").
+1. Create an element with an `id` attribute somewhere in the HTML:
<div id="preview"></div>
-2. Initialize the camera preview with the following method
+2. Initialize the camera preview as follows:
navigator.camera.showPreview("preview");
-3. Once you get the preview you can
-
- 3.1 Capture an image with
+3. Once you the preview displays, capture the image with code such as the following:
var options = { destinationFilename: "images/cam01.jpg", highRes: false};
navigator.capture.captureImage(success, fail, options);
-3. Hide the camera preview with the following method
+4. Dismiss the camera preview as follows:
navigator.camera.hidePreview("preview");
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureImageOptions.md b/docs/en/edge/cordova/media/capture/captureImageOptions.md
index 4dcda3b..b751bd1 100644
--- a/docs/en/edge/cordova/media/capture/captureImageOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureImageOptions.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -25,7 +25,7 @@ CaptureImageOptions
Properties
----------
-- __limit__: The maximum number of images the device user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+- __limit__: The maximum number of images the user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
Quick Example
-------------
@@ -38,4 +38,4 @@ Quick Example
iOS Quirks
----------
-- The __limit__ parameter is not supported. One image is taken per invocation.
+- The __limit__ parameter is not supported, and only one image is taken per invocation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureVideo.md b/docs/en/edge/cordova/media/capture/captureVideo.md
index 7a75725..cb9c591 100644
--- a/docs/en/edge/cordova/media/capture/captureVideo.md
+++ b/docs/en/edge/cordova/media/capture/captureVideo.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -29,11 +29,22 @@ capture.captureVideo
Description
-----------
-This method starts an asynchronous operation to capture video recordings using the device video recording application. The operation allows the device user to capture multiple recordings in a single session.
+Starts an asynchronous operation to capture video recordings using the
+device's video recording application. The operation allows the user
+to capture more than one recordings in a single session.
-The capture operation ends when either the user exits the video recording application, or the maximum number of recordings, specified by the __limit__ parameter in CaptureVideoOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single video clip.
+The capture operation ends when either the user exits the video
+recording application, or the maximum number of recordings specified
+by `CaptureVideoOptions.limit` is reached. If no `limit` parameter
+value is specified, it defaults to one (1), and the capture operation
+terminates after the user records a single video clip.
-When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured video clip file. If the operation is terminated by the user before an video clip is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation finishes, it the `CaptureCB` callback
+executes with an array of `MediaFile` objects describing each captured
+video clip file. If the user terminates the operation before
+capturing a video clip, the `CaptureErrorCB` callback executes with a
+`CaptureError` object featuring a
+`CaptureError.CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------
@@ -129,32 +140,32 @@ Full Example
BlackBerry WebWorks Quirks
--------------------------
-- Cordova for BlackBerry WebWorks attempts to launch the __Video Recorder__ application, provided by RIM, to capture the video recordings. The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
+- Cordova for BlackBerry WebWorks attempts to launch the __Video Recorder__ application, provided by RIM, to capture video recordings. The app receives a `CaptureError.CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
Bada 2.x Quirks
---------------
-Bada supports _captureVideo_ just like the other platforms. However there is _another_ mode where you can capture a video or an image straight in the webview without launching any camera apps. In order to do that you need to:
+Bada supports `captureVideo` just like the other platforms, but
+features _another_ mode allowing video or image capture straight into
+the WebView without launching any camera app. Here's how:
-1. create a _<div>_ element somewhere in your document and give it an id (such as "preview").
+1. Create an element with an `id` attribute somewhere in the HTML:
<div id="preview"></div>
-2. Initialize the camera preview with the following method
+2. Initialize the camera preview as follows:
navigator.camera.showPreview("preview");
-3. Once you get the preview you can
-
- 3.1 Start capturing a video with
+3. Once the preview is available, use code such as this to start capturing a video:
navigator.capture.startVideoCapture(success, fail, {duration: 5000, destinationFilename: "videos/a.3gp"});
- 3.2 Stop the video capture with
+4. Use this to stop the video capture:
navigator.capture.stopVideoCapture();
-3. Hide the camera preview with the following method
+5. Dismiss the camera preview as follows:
navigator.camera.hidePreview("preview");
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureVideoOptions.md b/docs/en/edge/cordova/media/capture/captureVideoOptions.md
index f3072fa..1df0a72 100644
--- a/docs/en/edge/cordova/media/capture/captureVideoOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureVideoOptions.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -25,7 +25,7 @@ CaptureVideoOptions
Properties
----------
-- __limit__: The maximum number of video clips the device user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+- __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
@@ -39,10 +39,11 @@ Quick Example
BlackBerry WebWorks Quirks
--------------------------
-- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
+- The __duration__ parameter is not supported, so the length of recordings cannot be limited programmatically.
iOS Quirks
----------
-- The __limit__ parameter is not supported. One video is recorded per invocation.
-- The __duration__ parameter is not supported. Recording lengths cannot be limited programmatically.
+- The __limit__ parameter is not supported. Only one video is recorded per invocation.
+- The __duration__ parameter is not supported. The length of recordings cannot be limited programmatically.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.getCurrentPosition.md b/docs/en/edge/cordova/media/media.getCurrentPosition.md
index f858bb1..2284b5c 100644
--- a/docs/en/edge/cordova/media/media.getCurrentPosition.md
+++ b/docs/en/edge/cordova/media/media.getCurrentPosition.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,13 +27,15 @@ Returns the current position within an audio file.
Parameters
----------
-- __mediaSuccess__: The callback that is called with the current position in seconds.
-- __mediaError__: (Optional) The callback that is called if there was an error.
+- __mediaSuccess__: The callback that is passed the current position in seconds.
+- __mediaError__: (Optional) The callback to execute if an error occurs.
Description
-----------
-Function `media.getCurrentPosition` is an asynchronous function that returns the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object.
+An asynchronous function that returns the current position of the
+underlying audio file of a `Media` object. Also updates the `Media`
+object's `position` parameter.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.getDuration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.getDuration.md b/docs/en/edge/cordova/media/media.getDuration.md
index a558f31..b7825dd 100644
--- a/docs/en/edge/cordova/media/media.getDuration.md
+++ b/docs/en/edge/cordova/media/media.getDuration.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,9 @@ Returns the duration of an audio file.
Description
-----------
-Function `media.getDuration` is a synchronous function that returns the duration of the audio file in seconds, if known. If the duration is unknown, a value of -1 is returned.
+The `media.getDuration` method executes synchronously, returning the
+duration of the audio file in seconds, if known. If the duration is
+unknown, it returns a value of -1.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.md b/docs/en/edge/cordova/media/media.md
index 1632c1e..09c7037 100644
--- a/docs/en/edge/cordova/media/media.md
+++ b/docs/en/edge/cordova/media/media.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -24,20 +24,24 @@ Media
var media = new Media(src, mediaSuccess, [mediaError], [mediaStatus]);
-Note: The current implementation does not adhere to a W3C specification for media capture, and is provided for convenience only. A future implementation will adhere to the latest W3C specification and may deprecate the current APIs.
+__NOTE:__ The current implementation does not adhere to a W3C
+specification for media capture, and is provided for convenience only.
+A future implementation will adhere to the latest W3C specification
+and may deprecate the current APIs.
Parameters
----------
- __src__: A URI containing the audio content. _(DOMString)_
-- __mediaSuccess__: (Optional) The callback that is invoked after a Media object has completed the current play/record or stop action. _(Function)_
-- __mediaError__: (Optional) The callback that is invoked if there was an error. _(Function)_
-- __mediaStatus__: (Optional) The callback that is invoked to indicate status changes. _(Function)_
+- __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
---------
-The following constants are reported as the only parameter to the __mediaStatus__ callback function.
+The following constants are reported as the only parameter to the
+`mediaStatus` callback:
- `Media.MEDIA_NONE` = 0;
- `Media.MEDIA_STARTING` = 1;
@@ -48,22 +52,22 @@ The following constants are reported as the only parameter to the __mediaStatus_
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 audio file.
-- media.pause: Pause playing audio file.
-- media.release: Releases the underlying OS'es audio resources.
-- media.seekTo: Moves the position within the audio file.
-- media.startRecord: Start recording audio file.
-- media.stopRecord: Stop recording audio file.
-- media.stop: Stop playing audio file.
+- `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.startRecord`: Start recording an audio file.
+- `media.stopRecord`: Stop recording an audio file.
+- `media.stop`: Stop playing an audio file.
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.
+- __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
-------------------
@@ -133,5 +137,6 @@ Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en
No permissions are required.
### Windows Phone Quirks
- Only one media file can be played back at a time.
- There are strict restrictions as to how your application interacts with other media. See http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx
+- Only one media file can be played back at a time.
+
+- There are strict restrictions on how your application interacts with other media. See [Windows Phone Developer Center](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/45f896ae/docs/en/edge/cordova/media/media.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.pause.md b/docs/en/edge/cordova/media/media.pause.md
index 4910c37..116e3ea 100644
--- a/docs/en/edge/cordova/media/media.pause.md
+++ b/docs/en/edge/cordova/media/media.pause.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,7 @@ Pauses playing an audio file.
Description
-----------
-Function `media.pause` is a synchronous function that pauses playing an audio file.
+The `media.pause` method executes synchronously, and pauses playing an audio file.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.play.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.play.md b/docs/en/edge/cordova/media/media.play.md
index 67b508d..c489704 100644
--- a/docs/en/edge/cordova/media/media.play.md
+++ b/docs/en/edge/cordova/media/media.play.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,8 @@ Starts or resumes playing an audio file.
Description
-----------
-Function `media.play` is a synchronous function that starts or resumes playing an audio file.
+The `media.play` method executes synchronously, and starts or resumes
+playing an audio file.
Supported Platforms
-------------------
@@ -168,28 +169,32 @@ Full Example
BlackBerry WebWorks Quirks
----------
-- BlackBerry devices support a limited number of simultaneous audio channels. CDMA devices only support a single audio channel. Other devices support up to two simultaneous channels. Attempting to play more audio files then the supported amount will result in previous playback being stopped.
+- BlackBerry devices support a limited number of simultaneous audio
+ channels. CDMA devices only support a single audio channel. Other
+ devices support up to two simultaneous channels. An attempt to play
+ more audio files than the supported amount results in previous
+ playback being stopped.
-iOS Quirk
----------
+iOS Quirks
+----------
-- __numberOfLoops__
-
- Pass in this option to the **play** method to specify the number of times you want the media file to play. e.g:
+- __numberOfLoops__: Pass this option to the `play` method to specify
+ the number of times you want the media file to play, e.g.:
var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
myMedia.play({ numberOfLoops: 2 })
-- __playAudioWhenScreenIsLocked__
-
- Pass in this option to the **play** method to specify whether you want to play the audio of the media file when the screen is locked (this defaults to true if not set). If this is set to true, it will ignore the state of the hardware mute button. e.g:
+- __playAudioWhenScreenIsLocked__: Pass in this option to the `play`
+ method to specify whether you want to allow playback when the screen
+ is locked. If set to `true` (the default value), the state of the
+ hardware mute button is ignored, e.g.:
var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
myMedia.play({ playAudioWhenScreenIsLocked : false })
-- __order of file search__
-
- When only a file name or simple path is provided, iOS will search in the www for the file and then in the application documents/tmp directory.
+- __order of file search__: When only a file name or simple path is
+ provided, iOS searches in the `www` directory for the file, then in
+ the application's `documents/tmp` directory:
var myMedia = new Media("audio/beer.mp3")
- myMedia.play() // will first look for file in www/audio/beer.mp3 then in <application>/documents/tmp/audio/beer.mp3
+ myMedia.play() // first looks for file in www/audio/beer.mp3 then in <application>/documents/tmp/audio/beer.mp3
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.release.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.release.md b/docs/en/edge/cordova/media/media.release.md
index 6528cdc..d7f933d 100644
--- a/docs/en/edge/cordova/media/media.release.md
+++ b/docs/en/edge/cordova/media/media.release.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,14 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
media.release
=================
-Releases the underlying operating systems audio resources.
+Releases the underlying operating system's audio resources.
media.release();
Description
-----------
-Function `media.release` is a synchronous function that releases the underlying operating systems audio resources. This function is particularly important for Android as there are a finite amount of OpenCore instances for media playback. Developers should call the 'release' function when they no longer need the Media resource.
+The `media.release` method executes synchronously, releasing the
+underlying operating system's audio resources. This is particularly
+important for Android, since there are a finite amount of OpenCore
+instances for media playback. Applications should call the `release`
+function for any `Media` resource that is no longer needed.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.seekTo.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.seekTo.md b/docs/en/edge/cordova/media/media.seekTo.md
index f737480..f1e47c0 100644
--- a/docs/en/edge/cordova/media/media.seekTo.md
+++ b/docs/en/edge/cordova/media/media.seekTo.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,12 +27,14 @@ Sets the current position within an audio file.
Parameters
----------
-- __milliseconds__: The position to set the playback position within the audio in milliseconds. .
+- __milliseconds__: The position to set the playback position within the audio, in milliseconds.
Description
-----------
-Function `media.seekTo` is an asynchronous function that updates the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object.
+The `media.seekTo` executes asynchronously, updating the current
+playback position within an audio file referenced by a `Media`
+object. Also updates the `Media` object's `position` parameter.
Supported Platforms
-------------------
@@ -154,4 +156,4 @@ Full Example
BlackBerry WebWorks Quirks
----------
-- This API is not supported on BlackBerry OS 5 devices.
+- Not supported on BlackBerry OS 5 devices.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.startRecord.md b/docs/en/edge/cordova/media/media.startRecord.md
index f4f2d42..e4e7d2d 100644
--- a/docs/en/edge/cordova/media/media.startRecord.md
+++ b/docs/en/edge/cordova/media/media.startRecord.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,8 @@ Starts recording an audio file.
Description
-----------
-Function `media.startRecord` is a synchronous function that starts recording an audio file.
+The `media.startRecord` method executes synchronously, starts a
+recording for an audio file.
Supported Platforms
-------------------
@@ -132,18 +133,18 @@ Full Example
Android Quirks
----------
-- Android devices record audio in Adaptive Multi-Rate format. The specified file should end with a .amr extension.
+- Android devices record audio in Adaptive Multi-Rate format. The specified file should end with a _.amr_ extension.
BlackBerry WebWorks Quirks
----------
-- BlackBerry devices record audio in Adaptive Multi-Rate format. The specified file must end with a .amr extension.
+- BlackBerry devices record audio in Adaptive Multi-Rate format. The specified file must end with a _.amr_ extension.
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 will be placed in the <application>/documents/tmp directory. This can be accessed via the File apis using LocalFileSystem.TEMPORARY. Subdirectories are not created at record time and must already exist. Thus, myRecording.wav will work but recordings/myRecording.wav will not if the recordings directory does not already exist at <application>/documents/tmp/.
+- 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")
@@ -151,4 +152,4 @@ iOS Quirks
Tizen Quirks
----------
-- This API is not supported on Tizen devices.
+- Not supported on Tizen devices.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.stop.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.stop.md b/docs/en/edge/cordova/media/media.stop.md
index 52b9037..00b311b 100644
--- a/docs/en/edge/cordova/media/media.stop.md
+++ b/docs/en/edge/cordova/media/media.stop.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,8 @@ Stops playing an audio file.
Description
-----------
-Function `media.stop` is a synchronous function that stops playing an audio file.
+The `media.stop` method executes synchronously to stop playing an
+audio file.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/media/media.stopRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.stopRecord.md b/docs/en/edge/cordova/media/media.stopRecord.md
index e04e7cb..0a97e6c 100644
--- a/docs/en/edge/cordova/media/media.stopRecord.md
+++ b/docs/en/edge/cordova/media/media.stopRecord.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,7 +27,8 @@ Stops recording an audio file.
Description
-----------
-Function `media.stopRecord` is a synchronous function that stops recording an audio file.
+The `media.stopRecord` method executes synchronously, stopping the
+recording of an audio file.
Supported Platforms
-------------------
@@ -137,4 +138,4 @@ Full Example
Tizen Quirks
----------
-- This API is not supported on Tizen devices.
+- Not supported on Tizen devices.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.confirm.md b/docs/en/edge/cordova/notification/notification.confirm.md
index 086b943..b7c8c16 100755
--- a/docs/en/edge/cordova/notification/notification.confirm.md
+++ b/docs/en/edge/cordova/notification/notification.confirm.md
@@ -37,7 +37,8 @@ Function `notification.confirm` displays a native dialog box that is more custom
confirmCallback
---------------
-The `confirmCallback` is called when the user has pressed one of the buttons on the confirmation dialog box.
+The `confirmCallback` executes when the user presses one of the
+buttons on the confirmation dialog box.
The callback takes the argument `buttonIndex` _(Number)_, which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/notification/notification.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.md b/docs/en/edge/cordova/notification/notification.md
index 68f838d..e18b13b 100644
--- a/docs/en/edge/cordova/notification/notification.md
+++ b/docs/en/edge/cordova/notification/notification.md
@@ -25,11 +25,11 @@ Notification
Methods
-------
-- notification.alert
-- notification.confirm
-- notification.prompt
-- notification.beep
-- notification.vibrate
+- `notification.alert`
+- `notification.confirm`
+- `notification.prompt`
+- `notification.beep`
+- `notification.vibrate`
Permissions
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.prompt.md b/docs/en/edge/cordova/notification/notification.prompt.md
index ce947d2..631c80d 100644
--- a/docs/en/edge/cordova/notification/notification.prompt.md
+++ b/docs/en/edge/cordova/notification/notification.prompt.md
@@ -37,7 +37,7 @@ Function `notification.prompt` displays a native dialog box that is more customi
promptCallback
---------------
-The `promptCallback` is called when the user has pressed one of the buttons on the prompt dialog box.
+The `promptCallback` executes when the user has pressed one of the buttons on the prompt dialog box.
The callback takes the argument `results` which contains the following properties:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
index 13d0402..6f1d86c 100644
--- a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
+++ b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
@@ -20,7 +20,8 @@ license: Licensed to the Apache Software Foundation (ASF) under one
SQLResultSet
=======
-When the executeSql method of a SQLTransaction is called it will invoke it's callback with a SQLResultSet.
+When the `executeSql` method of a `SQLTransaction` is called it
+invokes its callback with a `SQLResultSet`.
Properties
-------
@@ -32,7 +33,7 @@ Properties
Details
-------
-When you call the SQLTransaction executeSql method its callback methods is called with a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowsAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.
+When you call the SQLTransaction executeSql method its callback methods is passed a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowsAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/45f896ae/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
index 107668e..ea61b30 100644
--- a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
+++ b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
@@ -30,7 +30,7 @@ Methods
Details
-------
-When you call a Database objects transaction method, its callback methods is called with a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
+When you call a Database objects transaction method, its callback method is passed a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
Supported Platforms
-------------------
[29/46] docs commit: glob API
Posted by mw...@apache.org.
glob API
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/f4bf4426
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/f4bf4426
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/f4bf4426
Branch: refs/heads/master
Commit: f4bf44267d2ad2b99431bd0447d8577d2024b327
Parents: 9dcee9b
Author: Mike Sierra <le...@gmail.com>
Authored: Fri May 17 11:47:07 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Fri May 17 11:47:07 2013 -0400
----------------------------------------------------------------------
.../file/directoryentry/directoryentry.md | 2 +-
.../geolocation.getCurrentPosition.md | 2 +-
.../parameters/geolocation.options.md | 2 +-
.../GlobalizationError/globalizationerror.md | 7 +--
.../globalization/globalization.dateToString.md | 6 +--
.../globalization.getCurrencyPattern.md | 13 +++--
.../globalization/globalization.getDateNames.md | 28 +++++++----
.../globalization.getDatePattern.md | 33 ++++++++-----
.../globalization.getFirstDayOfWeek.md | 17 +++++--
.../globalization.getLocaleName.md | 14 ++++--
.../globalization.getNumberPattern.md | 50 +++++++++++---------
.../globalization.getPreferredLanguage.md | 14 ++++--
.../globalization.isDayLightSavingsTime.md | 18 +++++--
.../edge/cordova/globalization/globalization.md | 8 ++--
.../globalization.numberToString.md | 19 ++++++--
.../globalization/globalization.stringToDate.md | 33 ++++++++-----
.../globalization.stringToNumber.md | 25 +++++++---
17 files changed, 184 insertions(+), 107 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index c5d87cd..661768d 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -333,7 +333,7 @@ __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 invoked with a `FileEntry` object. _(Function)_
+- __successCallback__: A callback that is passed a `FileEntry` object. _(Function)_
- __errorCallback__: A callback that is called if an error occurs when creating or looking up the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
index cc10464..96c8be1 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -39,7 +39,7 @@ Description
`geolocation.getCurrentPosition` is an asynchronous function. It
returns the device's current position to the `geolocationSuccess`
callback with a `Position` object as the parameter. If there is an
-error, the `geolocationError` callback is invoked with a
+error, the `geolocationError` callback is passed a
`PositionError` object.
Supported Platforms
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
index d4754e5..ff4d540 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
@@ -29,7 +29,7 @@ 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 is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback is invoked with 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)_
+- __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 is invoked. 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/f4bf4426/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
index e9cec1e..d5af9a9 100644
--- a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
+++ b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -30,7 +30,7 @@ Properties
- GlobalizationError.FORMATTING\_ERROR: 1
- GlobalizationError.PARSING\_ERROR: 2
- GlobalizationError.PATTERN\_ERROR: 3
-- __message__: A text message that includes the error explanation and/or details (`String`)
+- __message__: A text message that includes the error's explanation and/or details (`String`)
Description
-----------
@@ -47,7 +47,8 @@ Supported Platforms
Quick Example
-------------
-When the following error callback is invoked, it should display a popup dialog with the text similar to "code: 3" and "message: ".
+When the following error callback executes, it displays a
+popup dialog with the text similar to `code: 3` and `message:`
function errorCallback(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.dateToString.md b/docs/en/edge/cordova/globalization/globalization.dateToString.md
index 9dd0e71..9c0c403 100644
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.md
@@ -54,9 +54,9 @@ Supported Platforms
Quick Example
-------------
-If the browser is set to the `en\_US` locale, this should display a
-popup dialog with text similar to `date: 9/25/2012 4:21PM` using the
-default options:
+If the browser is set to the `en\_US` locale, this displays a popup
+dialog with text similar to `date: 9/25/2012 4:21PM` using the default
+options:
navigator.globalization.dateToString(
new Date(),
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
index 724c43c..35bb96e 100644
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -42,9 +42,8 @@ The inbound `currencyCode` parameter should be a `String` of one of
the ISO 4217 currency codes, for example 'USD'.
If there is an error obtaining the pattern, then the `errorCallback`
-is invoked with a `GlobalizationError` object as a parameter. The
-expected code for this error is
-`GlobalizationError.FORMATTING\_ERROR`.
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.FORMATTING\_ERROR`.
Supported Platforms
-------------------
@@ -56,9 +55,9 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the `en\_US` locale and the selected currency
-is United States Dollars, this example should display a popup dialog with text
-similar to the results that follow:
+When the browser is set to the `en\_US` locale and the selected
+currency is United States Dollars, this example displays a popup
+dialog with text similar to the results that follow:
navigator.globalization.getCurrencyPattern(
'USD',
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDateNames.md b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
index 70b7552..656be1d 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,22 +20,30 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.getDateNames
===========
-Returns an array of either the names of the months or days of the week according to the client's user preferences and calendar.
+Returns an array of the names of the months or days of the week,
+depending on the client's user preferences and calendar.
navigator.globalization.getDateNames(successCallback, errorCallback, options);
Description
-----------
-It returns the array of names to the `successCallback` with a properties object as a parameter. That object should have a `value` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
+Returns the array of names to the `successCallback` with a
+`properties` object as a parameter. That object contains a `value`
+property with an `Array` of `String` values. The array features names
+starting from either the first month in the year or the first day of
+the week, depending on the option selected.
+
+If there is an error obtaining the names, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
-If there is an error obtaining the names, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
+The `options` parameter is optional, and its default values are:
-`options.type` can be 'narrow', or 'wide'.
-`options.item` can be 'months', or 'days'.
+ {type:'wide', item:'months'}
-The default options are `{type:'wide', item:'months'}`.
-The options parameter is optional.
+The value of `options.type` can be `narrow` or `wide`.
+The value of `options.item` can be `months` or `days`.
Supported Platforms
-------------------
@@ -48,7 +56,9 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a series of 12 popup dialogs, one per month, with text similar to "month: January"
+When the browser is set to the `en\_US` locale, this example displays
+a series of twelve popup dialogs, one per month, with text similar to
+`month: January`:
navigator.globalization.getDateNames(
function (names) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
index 2662634..5a07c55 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,27 +20,33 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.getDatePattern
===========
-Returns a pattern string to format and parse dates according to the client's user preferences.
+Returns a pattern string to format and parse dates according to the
+client's user preferences.
navigator.globalization.getDatePattern(successCallback, errorCallback, options);
Description
-----------
-It returns the pattern to the `successCallback` with a properties object as a parameter. That object should have the following properties:
+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, then the `errorCallback` is invokedwith a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PATTERN\_ERROR`.
+If there is an error obtaining the pattern, the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.PATTERN\_ERROR`.
+
+The `options` parameter is optional, and defaults to the following values:
-`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
-`options.selector` can be 'date', 'time' or 'date and time'.
+ {formatLength:'short', selector:'date and time'}
-The default options are `{formatLength:'short', selector:'date and time'}`.
-The options parameter is optional.
+The `options.formatLength` can be `short`, `medium`, `long`, or
+`full`. The `options.selector` can be `date`, `time` or `date and
+time`.
Supported Platforms
-------------------
@@ -53,7 +59,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "pattern: M/d/yyyy h:mm a".
+When the browser is set to the `en\_US` locale, this example displays
+a popup dialog with text such as `pattern: M/d/yyyy h:mm a`:
function checkDatePattern() {
navigator.globalization.getDatePattern(
@@ -91,8 +98,8 @@ Full Example
Windows Phone 8 Quirks
--------------
-- `formatLength` option supports only short and full values.
-- `pattern` property for `date and time` pattern returns only full datetime format.
-- `timezone` property returns full time zone name
-- `dst_offset` returned property is not supported and always returns zero.
+- 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/f4bf4426/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
index ff8856a..49f9156 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,16 +20,22 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.getFirstDayOfWeek
===========
-Returns the first day of the week according to the client's user preferences and calendar.
+Returns the first day of the week according to the client's user
+preferences and calendar.
navigator.globalization.getFirstDayOfWeek(successCallback, errorCallback);
Description
-----------
-The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a Number value.
+The days of the week are numbered starting from 1, where 1 is assumed
+to be Sunday. Returns the day to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `Number` value.
-If there is an error obtaining the pattern, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
+If there is an error obtaining the pattern, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
@@ -42,7 +48,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "day: 1".
+When the browser is set to the `en\_US` locale, this displays a
+popup dialog with text similar to `day: 1`.
navigator.globalization.getFirstDayOfWeek(
function (day) {alert('day: ' + day.value + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
index 952b153..fbe0689 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -28,10 +28,13 @@ Get the string identifier for the client's current locale setting.
Description
-----------
-It returns the locale identifier string to the `successCallback` with a
-properties object as a parameter. That object should have a `value` property with a String value.
+Returns the locale identifier string to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `String` value.
-If there is an error getting the locale, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
+If there is an error getting the locale, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
@@ -44,7 +47,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with the text "locale: en\_US".
+When the browser is set to the `en\_US` locale, this displays a popup
+dialog with the text `locale: en\_US`.
navigator.globalization.getLocaleName(
function (locale) {alert('locale: ' + locale.value + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
index 56bcc6f..8d81f57 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,10 +27,11 @@ Returns a pattern string to format and parse numbers according to the client's u
Description
-----------
-It returns the pattern to the `successCallback` with a properties object as a parameter. That object should have the following properties:
+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 be used when formatting and parsing e.g., percent or currency symbol. _(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)_
@@ -38,10 +39,16 @@ It returns the pattern to the `successCallback` with a properties object as a pa
- __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` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PATTERN\_ERROR`.
+If there is an error obtaining the pattern, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.PATTERN\_ERROR`.
+
+The `options` parameter is optional, and default values are:
+
+ {type:'decimal'}
+
+The `options.type` can be `decimal`, `percent`, or `currency`.
-`options.type` can be 'decimal', 'percent', or 'currency'.
-The default options are `{type:'decimal'}`. The `options` parameter is optional.
Supported Platforms
-------------------
@@ -54,18 +61,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to:
-
- pattern: #,##0.###
- symbol: .
- fraction: 0
- rounding: 0
- positive:
- negative: -
- decimal: .
- grouping: ,
-
-.
+When the browser is set to the `en\_US` locale, this should display a
+popup dialog with text similar to the results that follow:
navigator.globalization.getNumberPattern(
function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
@@ -80,6 +77,17 @@ When the browser is set to the en\_US locale, this should display a popup dialog
{type:'decimal'}
);
+Results:
+
+ pattern: #,##0.###
+ symbol: .
+ fraction: 0
+ rounding: 0
+ positive:
+ negative: -
+ decimal: .
+ grouping: ,
+
Full Example
------------
@@ -114,7 +122,5 @@ Full Example
Windows Phone 8 Quirks
----------------
-- `pattern` property is not supported; empty string is always returned.
-- `fraction` property is not supported; zero is always returned.
-
-
+- 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/f4bf4426/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
index a436f9f..7370832 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -28,10 +28,13 @@ Get the string identifier for the client's current language.
Description
-----------
-It returns the language identifier string to the `successCallback` with a
-properties object as a parameter. That object should have a `value` property with a String value.
+Returns the language identifier string to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `String` value.
-If there is an error getting the language, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
+If there is an error getting the language, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
@@ -44,7 +47,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with the text "language: English".
+When the browser is set to the `en\_US` locale, this should display a
+popup dialog with the text `language: English`:
navigator.globalization.getPreferredLanguage(
function (language) {alert('language: ' + language.value + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
index e01b226..e6541cf 100644
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,18 +20,24 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.isDayLightSavingsTime
===========
-Returns whether daylight savings time is in effect for a given date using the client's time zone and calendar.
+Indicates whether daylight savings time is in effect for a given date
+using the client's time zone and calendar.
navigator.globalization.isDayLightSavingsTime(date, successCallback, errorCallback);
Description
-----------
-It returns whether or not daylight savings time is in effect to the `successCallback` with a properties object as a parameter. That object should have a `dst` property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not.
+Indicates whether or not daylight savings time is in effect to the
+`successCallback` with a `properties` object as a parameter. That object
+should have a `dst` property with a `Boolean` value. A `true` value
+indicates that daylight savings time is in effect for the given date,
+and `false` indicates that it is not.
The inbound parameter `date` should be of type `Date`.
-If there is an error reading the date, then the `errorCallback` is invoked. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
+If there is an error reading the date, then the `errorCallback`
+executes. The error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
@@ -44,7 +50,9 @@ Supported Platforms
Quick Example
-------------
-In the case during the summer when the browser is set to a DST-enabled timezone, this should display a popup dialog with text similar to "dst: true".
+During the summer, and if the browser is set to a DST-enabled
+timezone, this should display a popup dialog with text similar to
+`dst: true`:
navigator.globalization.isDayLightSavingsTime(
new Date(),
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.md b/docs/en/edge/cordova/globalization/globalization.md
index dacf13f..b473ec9 100644
--- a/docs/en/edge/cordova/globalization/globalization.md
+++ b/docs/en/edge/cordova/globalization/globalization.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,8 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Globalization
======
-The `globalization` object obtains information and performs operations specific to the user's locale and timezone.
+Obtains information and performs operations specific to the user's
+locale and timezone.
Objects
-------
@@ -46,7 +47,8 @@ Methods
Variable Scope
--------------
-The `globalization` object is a child of the `navigator` object, and therefore has global scope.
+The `globalization` object is a child of the `navigator` object, and
+therefore has global scope.
// The global globalization object
var globalization = navigator.globalization;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.numberToString.md b/docs/en/edge/cordova/globalization/globalization.numberToString.md
index ed61012..a049999 100644
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.numberToString.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,11 +27,19 @@ Returns a number formatted as a string according to the client's user preference
Description
-----------
-It returns the formatted number string to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a String value.
+Returns the formatted number string to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `String` value.
+
+If there is an error formatting the number, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.FORMATTING\_ERROR`.
+
+The `options` parameter is optional, and its default values are:
-If there is an error formatting the number, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.FORMATTING\_ERROR`.
+ {type:'decimal'}
-`options.type` can be 'decimal', 'percent', or 'currency'. The default options are `{type:'decimal'}`. The `options` parameter is optional.
+The `options.type` can be 'decimal', 'percent', or 'currency'.
Supported Platforms
-------------------
@@ -44,7 +52,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 3.142"
+When the browser is set to the `en\_US` locale, this displays a popup
+dialog with text similar to `number: 3.142`:
navigator.globalization.numberToString(
3.1415926,
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToDate.md b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
index 29d8e39..65c0c95 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,16 +20,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.stringToDate
===========
-Parses a date formatted as a string according to the client's user
-preferences and calendar using the time zone of the client and returns
-the corresponding date object.
+Parses a date formatted as a string, according to the client's user
+preferences and calendar using the time zone of the client, and
+returns the corresponding date object.
navigator.globalization.stringToDate(dateString, successCallback, errorCallback, options);
Description
-----------
-It returns the date to the success callback with a properties object as a parameter. That object should have the following properties:
+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)_
@@ -41,13 +42,18 @@ It returns the date to the success callback with a properties object as a parame
The inbound `dateString` parameter should be of type `String`.
-`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
-`options.selector` can be 'date', 'time' or 'date and time'.
+The `options` parameter is optional, and defaults to the following
+values:
+
+ {formatLength:'short', selector:'date and time'}
-The default options are `{formatLength:'short', selector:'date and time'}`.
-The options parameter is optional.
+The `options.formatLength` can be `short`, `medium`, `long`, or
+`full`. The `options.selector` can be `date`, `time` or `date and
+time`.
-If there is an error parsing the date string, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PARSING\_ERROR`.
+If there is an error parsing the date string, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.PARSING\_ERROR`.
Supported Platforms
-------------------
@@ -60,7 +66,10 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "month:8 day:25 year:2012". Note that the month integer is one less than the string, as the month integer represents an index.
+When the browser is set to the `en\_US` locale, this displays a
+popup dialog with text similar to `month:8 day:25 year:2012`. Note
+that the month integer is one less than the string, as the month
+integer represents an array index.
navigator.globalization.stringToDate(
'9/25/2012',
@@ -102,4 +111,4 @@ Full Example
Windows Phone 8 Quirks
------------------
-- `formatLength` option supports only short and full values
+- The `formatLength` option supports only `short` and `full` values.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
index d6ecb19..90313c1 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,19 +20,29 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.stringToNumber
===========
-Parses a number formatted as a string according to the client's user preferences and returns the corresponding number.
+Parses a number formatted as a string according to the client's user
+preferences and returns the corresponding number.
navigator.globalization.stringToNumber(string, successCallback, errorCallback, options);
Description
-----------
-It returns the number to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a Number value.
+Returns the number to the `successCallback` with a `properties` object
+as a parameter. That object should have a `value` property with a
+`Number` value.
+
+If there is an error parsing the number string, then the
+`errorCallback` executes with a `GlobalizationError` object as a
+parameter. The error's expected code is
+`GlobalizationError.PARSING\_ERROR`.
+
+The `options` parameter is optional, and defaults to the following
+values:
-If there is an error parsing the number string, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PARSING\_ERROR`.
+ {type:'decimal'}
-`options.type` can be 'decimal', 'percent', or 'currency'.
-The default options are `{type:'decimal'}`. The `options` parameter is optional.
+The `options.type` can be `decimal`, `percent`, or `currency`.
Supported Platforms
-------------------
@@ -45,7 +55,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 1234.56".
+When the browser is set to the `en\_US` locale, this should display a
+popup dialog with text similar to `number: 1234.56`:
navigator.globalization.stringToNumber(
'1234.56',
[10/46] docs commit: numerous nonlinear global edits
Posted by mw...@apache.org.
numerous nonlinear global edits
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/958f8d20
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/958f8d20
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/958f8d20
Branch: refs/heads/master
Commit: 958f8d20e59a8c505ea797a4d760659c670c62c3
Parents: 7cc8809
Author: Mike Sierra <le...@gmail.com>
Authored: Mon Apr 29 12:49:48 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon Apr 29 12:49:48 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/command-line/index.md | 13 +-
docs/en/edge/guide/cordova-webview/ios.md | 36 +--
.../edge/guide/getting-started/android/index.md | 26 +-
.../en/edge/guide/getting-started/bada/index.md | 28 +-
.../guide/getting-started/blackberry/index.md | 6 +-
docs/en/edge/guide/getting-started/ios/index.md | 2 +-
.../edge/guide/getting-started/symbian/index.md | 8 +-
.../edge/guide/getting-started/tizen/index.md | 14 +-
.../edge/guide/getting-started/webos/index.md | 4 +-
.../guide/getting-started/windows-8/index.md | 18 +-
.../getting-started/windows-phone-7/index.md | 2 +-
.../getting-started/windows-phone-8/index.md | 2 +-
.../plugin-development/blackberry/index.md | 2 +-
docs/en/edge/guide/plugin-development/index.md | 2 +-
.../edge/guide/plugin-development/ios/index.md | 3 +-
.../plugin-development/windows-phone/index.md | 4 +-
.../guide/project-settings/android/index.md | 4 +-
.../edge/guide/project-settings/bada/index.md | 2 +-
.../en/edge/guide/project-settings/ios/index.md | 2 +-
.../en/edge/guide/project-settings/wp8/index.md | 2 +-
docs/en/edge/guide/upgrading/ios/index.md | 288 +++++++++----------
21 files changed, 233 insertions(+), 235 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/command-line/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/command-line/index.md b/docs/en/edge/guide/command-line/index.md
index d97878d..3675408 100644
--- a/docs/en/edge/guide/command-line/index.md
+++ b/docs/en/edge/guide/command-line/index.md
@@ -212,10 +212,9 @@ and then choose 'no' when prompted with:
### Logging
-Unfortunately streaming logs directly from the device is not
-supported at this time. However, BlackBerry offers built-in Web
-Inspector support for Playbook and BlackBerry smartphone devices running
-BlackBerry OS 7.0 and above. Additionally, you can access your
-application's logs (including any calls to `console.log`) on your device
-by holding down the ALT key from the home screen and hitting "lglg"
-keys.
+Unfortunately, streaming logs directly from the device is currently
+unsupported. However, BlackBerry offers built-in Web Inspector support
+for Playbook and BlackBerry smartphone devices running BlackBerry OS
+7.0 and above. You can also access your application's logs (including
+any calls to `console.log`) on your device by holding down the ''ALT''
+key from the home screen and typing ''lglg'' keys.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/cordova-webview/ios.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/ios.md b/docs/en/edge/guide/cordova-webview/ios.md
index 9b2cd09..323c82a 100644
--- a/docs/en/edge/guide/cordova-webview/ios.md
+++ b/docs/en/edge/guide/cordova-webview/ios.md
@@ -21,7 +21,7 @@ Embedding Cordova WebView on iOS
================================
Beginning with Cordova 1.4, you can use Cordova as a component in your
-iOS applications. This component is code-named "Cleaver".
+iOS applications. This component is code-named 'Cleaver'.
New Cordova-based applications created using the Xcode template
provided in Cordova 1.4 or greater use Cleaver. (The template is
@@ -45,16 +45,16 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
4. **Copy** the `config.xml` file into your project folder on disk (see **Prerequisites** above)
5. **Drag and drop** the `config.xml` file into the Project Navigator of Xcode
-6. **Choose** the radio-button **"Create groups for any added folders"**, select the **Finish** button
+6. **Choose** the **Create groups for any added folders** radio button, and press **Finish**
7. **Drag and drop** the `CordovaLib.xcodeproj` file into the Project Navigator of Xcode (from the permanent folder location above, and it should be in the CordovaLib sub-folder)
8. Select `CordovaLib.xcodeproj` in the Project Navigator
9. 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):
+10. Choose **Relative to Group** in the **File Inspector** for the drop-down menu for **Location**
+11. Select the **project icon** in the Project Navigator, select your **Target**, then select the **Build Settings** tab
+12. Add `-all_load` and `-Obj-C` for the **Other Linker Flags** value
+13. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **Build Phases** tab
+14. Expand **Link Binaries with Libraries**
+15. Select the **+** button, and add these **frameworks** (and optionally in the Project Navigator, **move** them under the Frameworks group):
AddressBook.framework
AddressBookUI.framework
@@ -67,14 +67,14 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
MobileCoreServices.framework
CoreMedia.framework
-16. Expand **"Target Dependencies"** - the top box labeled like this if you have multiple boxes!
-17. Select the **"+" button**, and add the `CordovaLib` build product
-18. Expand **"Link Binaries with Libraries"** - the top box labeled like
+16. Expand **Target Dependencies** - the top box labeled like this if you have multiple boxes!
+17. Select the **+** button, and add the `CordovaLib` build product
+18. Expand **Link Binaries with Libraries** - the top box labeled like
this if you have multiple boxes!
-19. Select the **"+" button**, and add `libCordova.a`
-20. Set the Xcode preference **"Xcode Preferences -> Locations -> Derived Data -> Advanced…"** to **"Unique"**
-21. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
-22. Search for **"Header Search Paths"**. For that setting, add these three values below (with quotes):
+19. Select the **+** button, and add `libCordova.a`
+20. Set the Xcode preference **Xcode Preferences → Locations → Derived Data → Advanced...** to **Unique**
+21. Select the **project icon** in the Project Navigator, select your **Target**, then select the **Build Settings** tab
+22. Search for **Header Search Paths**. For that setting, add these three values below (with quotes):
"$(TARGET_BUILD_DIR)/usr/local/lib/include"
@@ -82,7 +82,7 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
"$(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
------------------------------------
@@ -95,7 +95,7 @@ Using CDVViewController in your code
CDVViewController* viewController = [CDVViewController new];
-3. (_OPTIONAL_) Set the `wwwFolderName` property (defaults to `"www"`):
+3. (_OPTIONAL_) Set the `wwwFolderName` property (defaults to `www`):
viewController.wwwFolderName = @"myfolder";
@@ -125,7 +125,7 @@ Adding your HTML, CSS and JavaScript assets
1. Create a **new folder** in your project **on disk**, for example, name it `www`
2. Put your **HTML, CSS and JavaScript assets** into this folder
3. **Drag and drop** the folder into the Project Navigator of Xcode
-4. **Choose** the radio-button **"Create folder references for any added folders"**
+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`.
/*
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/android/index.md b/docs/en/edge/guide/getting-started/android/index.md
index 09892fe..60812d8 100644
--- a/docs/en/edge/guide/getting-started/android/index.md
+++ b/docs/en/edge/guide/getting-started/android/index.md
@@ -53,12 +53,12 @@ platforms are deprecated as they dip below 5% on Google's
`touch ~/.bash_profile; open ~/.bash_profile`
-- You need to add the path to your Android SDK platform-tools and tools directory. This example uses "/Development/android-sdk-macosx" as the SDK's install directory. Add the following line:
+- You need to add the path to your Android SDK `platform-tools` and `tools` directory. This example uses `/Development/android-sdk-macosx` as the SDK's install directory. Add the following line:
`export PATH=${PATH}:/Development/android-sdk-macosx/platform-tools:/Development/android-sdk-macosx/tools`
- Save the file and quit the text editor.
-- Execute your .bash_profile to update your PATH.
+- Execute your `.bash_profile` to update your PATH.
`source ~/.bash_profile`
@@ -69,7 +69,7 @@ platforms are deprecated as they dip below 5% on Google's
- From the Desktop, right-click My Computer and click Properties.
- Click Advanced System Settings link in the left column.
-- In the System Properties window click the Environment Variables button.
+- In the System Properties window, click the Environment Variables button.
- Select the PATH variable from the System variables section.
- Select the Edit button.
- You need to add the path to your Android SDK platform-tools and tools directory. This example uses `C:\Development\android-sdk-windows` as the SDK's install directory. Append the following into the text box:
@@ -90,26 +90,26 @@ platforms are deprecated as they dip below 5% on Google's
<package_name> is the package name, e.g. com.YourCompany.YourAppName
<project_name> is the project name, e.g. YourApp (Must not contain spaces and dashes)
-- If you're getting an 'An unexpected error occurred" error, try the command again prefixed with `sudo`
+- If you get an __An unexpected error occurred__ error, try the command again prefixed with `sudo`
- Launch Eclipse, and select menu item **New Project**:
- Select the directory you used for `<project_folder_path>`
- Click Finish.
-If your project has a red X indicating there is a problem follow these additional steps:
+If your project has a red __X__ indicating there is a problem follow
+these additional steps:
-- Right click on the project folder.
-- In the Properties dialog that is displayed select Android from the navigation pane.
-- For the project build target select the highest Android API level you have installed.
-- Click OK
-- Then from the Project menu bar item select Clean.
-- This should correct all the errors in the project.
+- Right-click on the project folder.
+- In the resulting __Properties__ dialog, select __Android__ from the navigation pane.
+- For the project build target, select the highest Android API level you have installed.
+- Click __OK__
+- Select __Clean__ from the __Project__ menu. This should correct all the errors in the project.
5A. Deploy to Emulator
----------------------
-- Right click the project and go to **Run As > Android Application**
+- Right-click the project and go to **Run As > Android Application**
- Eclipse asks you to select an appropriate AVD. If there isn't one, then you'll need to create it.
__NOTE:__ For a faster experience, use an Intel-based emulator image.
@@ -125,5 +125,5 @@ __NOTE:__ For a faster experience, use an Intel-based emulator image.
--------------------
- Make sure USB debugging is enabled on your device and plug it into your system. Information can be found on the [Android Developer Site](http://developer.android.com/tools/device.html)
-- Right click the project and go to **Run As > Android Application**
+- Right-click the project and go to **Run As > Android Application**
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/getting-started/bada/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/bada/index.md b/docs/en/edge/guide/getting-started/bada/index.md
index 5cb84d0..730891e 100644
--- a/docs/en/edge/guide/getting-started/bada/index.md
+++ b/docs/en/edge/guide/getting-started/bada/index.md
@@ -26,7 +26,7 @@ This guide describes how to set up your development environment for Cordova and
---------------
- Windows
-- You need the bada 1.2 SDK to use cordova-bada (which is no longer available on Samsung's website)
+- You need the bada 1.2 SDK to use cordova-bada (which is no longer available on Samsung's website)
2. Install SDK + Cordova
-------------------------
@@ -36,55 +36,55 @@ This guide describes how to set up your development environment for Cordova and
3. Set up New Project
--------------------
-- In Bada IDE, select _File_ -> Import project -> Bada C++ / Flash Project.
- - __NOTE:__ Bada 1.2 select "Bada Application Project"
+- In Bada IDE, select __File → Import project → Bada C++ / Flash Project__.
+ - __NOTE:__ In Bada 1.2 select __Bada Application Project__
-- Make sure "Select root directory" is checked and then click Browse
-- Browse to Cordova bada project folder (bada for 1.2 and bada-wac for 2.x) and select it. Make sure "Copy projects into workspace is checked"
+- Make sure __Select root directory__ is checked, then click __Browse__
+- Browse to the Cordova bada project folder (bada for 1.2 and bada-wac for 2.x) and select it. Make sure __Copy projects into workspace__ is checked.
-- Click "Finish"
+- Click __Finish__
4. Hello World
--------------
-**Bada 2.x**: Your HTML/CSS/JavaScript code lives under the Res/ folder. Make sure your index.html contains the following two lines in the <head> section.
+**Bada 2.x**: Your HTML/CSS/JavaScript code lives under the `Res/` folder. Make sure your `index.html` contains the following two lines in the `<head>` section:
<link href="osp://webapp/css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="osp://webapp/js/webapp_core.js"></script>
-**Bada 1.2**: Your HTML/CSS/JavaScript code lives under the Res/ folder. Make sure your index.html contains the following line.
+**Bada 1.2**: Your HTML/CSS/JavaScript code lives under the `Res/` folder. Make sure your `index.html` contains the following line:
<script type="text/javascript" src="cordova/cordova.js"> </script>
5A. Deploy to Simulator
-----------------------
-- **Bada 2.x**: Right click on your project s folder and select Run As -> bada Emulator Web Application
+- **Bada 2.x**: Right-click on your project s folder and select Run As -> bada Emulator Web Application
-- **Bada 1.2**: Right click on your project' folder and select Build configurations -> Set Active -> Simulator-Debug
+- **Bada 1.2**: Right-click on your project' folder and select Build configurations -> Set Active -> Simulator-Debug
-- Right click on your project's folder and select Run As -> bada Simulator Application. You need to close the emulator every time you update your app!
+- Right-click on your project's folder and select Run As -> bada Simulator Application. You need to close the emulator every time you update your app!
5B. Deploy to Device
--------------------
- Make sure your device is properly configured
-**Bada 2.x**: Right click on your project's folder and select Run As -> bada Target Web Application
+**Bada 2.x**: Right-click on your project's folder and select Run As -> bada Target Web Application
**Bada 1.2**:
-- Right click on your project's folder and select Build configurations -> Set Active -> Target-Debug
-- Right click on your project's folder and select Run As -> bada Target Application. You need to close the emulator every time you update your app!
+- Right-click on your project's folder and select __Build configurations → Set Active → Target-Debug__
+- Right-click on your project's folder and select __Run As → bada Target Application__. You need to close the emulator every time you update your app!
Done!
-----
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/getting-started/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/blackberry/index.md b/docs/en/edge/guide/getting-started/blackberry/index.md
index 5cbbdfd..401b0ac 100644
--- a/docs/en/edge/guide/getting-started/blackberry/index.md
+++ b/docs/en/edge/guide/getting-started/blackberry/index.md
@@ -130,14 +130,14 @@ BlackBerry PlayBook
BlackBerry Smartphone (OS5-7)
- `./cordova/run blackberry`
-Answer "n" when prompted "Do you have a BlackBerry device connected to your computer? (y/n)"
+When prompted __Do you have a BlackBerry device connected to your computer? (y/n)__, answer __n__.
The application is installed to the simulator's home screen. Note that on BlackBerry OS 5, it is installed in the `Downloads` folder.
7B. Deploy to Device (Windows and Mac)
--------------------------------------
-To deploy your app to a device you must have registered for, and setup BlackBerry Code Signing Keys. See section 3 for details. Also, to deploy apps on BlackBerry 10 or PlayBook, the device must be set to Development Mode which can be enabled from the Settings > Security menu.
+To deploy your app to a device you must have registered for, and setup BlackBerry Code Signing Keys. See section 3 for details. Also, to deploy apps on BlackBerry 10 or PlayBook, the device must be set to Development Mode which can be enabled from the __Settings → Security__ menu.
- Open the project.properties file with your favorite editor and customize the following properties:
@@ -167,7 +167,7 @@ BlackBerry PlayBook
BlackBerry Smartphone (OS5-7)
- `./cordova/run blackberry`
-Answer "y" when prompted "Do you have a BlackBerry device connected to your computer? (y/n)"
+When prompted __Do you have a BlackBerry device connected to your computer? (y/n)__, answer __y__.
The application is installed to the device's home screen. Note, on BlackBerry OS 5 the application is installed in the Downloads folder.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/ios/index.md b/docs/en/edge/guide/getting-started/ios/index.md
index 6dd9f29..3967fff 100644
--- a/docs/en/edge/guide/getting-started/ios/index.md
+++ b/docs/en/edge/guide/getting-started/ios/index.md
@@ -190,7 +190,7 @@ project files. This tutorial uses `~/Documents/CordovaXY`, where the
### Deprecation Warnings
When an application programming interface (API) is changed or replaced
-by another API, it is marked as "deprecated." The API still works in
+by another API, it is marked as _deprecated_. The API still works in
the near term, but is eventually removed. Some of these deprecated
interfaces are reflected in Apache Cordova, and Xcode issues warnings
about them when you build and deploy an application. The Xcode
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/getting-started/symbian/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/symbian/index.md b/docs/en/edge/guide/getting-started/symbian/index.md
index 9fb99a8..dd865f7 100644
--- a/docs/en/edge/guide/getting-started/symbian/index.md
+++ b/docs/en/edge/guide/getting-started/symbian/index.md
@@ -37,7 +37,7 @@ There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGa
2. Install SDK + Cordova
-------------------------
-- Download and install [cygwin](http://www.cygwin.com/setup.exe) (Windows only). Make sure you select "make" as it is not included by default
+- Download and install [cygwin](http://www.cygwin.com/setup.exe) (Windows only). Make sure you select `make` as it is not included by default.
- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the Android directory.
3. Set up New Project
@@ -48,9 +48,9 @@ There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGa
4. Hello World
--------------
-- Open up index.html located in phonegap/symbian/framework/www with your favourite editor.
-- In the `body` tag, remove the line `"Build your phonegap app here! Dude!"` and add the line `<h1>Hello World</h1>`
-- In cygwin/terminal, type `make`. This produces a `phonegap-symbian.wrt/app.wgz` file.
+- Edit the `index.html` file located in `phonegap/symbian/framework/www`.
+- In the `body` tag, remove the line `Build your phonegap app here! Dude!` and add the line `<h1>Hello World</h1>`
+- In `cygwin/terminal`, type `make`. This produces a `phonegap-symbian.wrt/app.wgz` file.
5A. Deploy to Simulator
-----------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/getting-started/tizen/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/tizen/index.md b/docs/en/edge/guide/getting-started/tizen/index.md
index 33f1ee3..6ccf740 100644
--- a/docs/en/edge/guide/getting-started/tizen/index.md
+++ b/docs/en/edge/guide/getting-started/tizen/index.md
@@ -39,7 +39,7 @@ This guide describes how to set up your development environment for Cordova and
- **Method #1: Import a Cordova Tizen project sample**
- Launch Tizen Eclipse IDE
- - Select **File** -> **Import** -> **Tizen Web Project**
+ - Select **File → Import → Tizen Web Project**
@@ -47,7 +47,7 @@ This guide describes how to set up your development environment for Cordova and
- Make sure that **Select root directory** is checked
- Make sure **Copy projects into workspace** is checked
- Click **Browse**
- - Browse to one of the Cordova Tizen "samples" project directory (e.g: `/cordova-basic`) and select it
+ - Browse to one of the Cordova Tizen `samples` project directory (e.g: `/cordova-basic`) and select it
@@ -59,7 +59,7 @@ This guide describes how to set up your development environment for Cordova and
- **Method #2: Use Tizen Eclipse IDE Cordova Tizen project templates**
- Launch Tizen Eclipse IDE
- - Select **File** -> **New** -> **Tizen Web Project**
+ - Select **File → New → Tizen Web Project**
- Select **User Template** and **User defined** items
- Select one of the Tizen Cordova template (e.g: **CordovaBasicTemplate**)
- Fill-up the **Project name** and its target **Location**
@@ -82,7 +82,7 @@ This guide describes how to set up your development environment for Cordova and
- A widget package should have been generated in your project root directory (e.g: `cordova-basic.wgt`)
- - **Note** that the provided samples Tizen Cordova projects are not basic hello world applications. They contain a simple example usage of the Battery Cordova API.
+ - __NOTE:__ The provided samples Tizen Cordova projects are not basic hello world applications. They contain a simple example usage of the Battery Cordova API.
5A. Deploy to Simulator
-----------------------
@@ -94,12 +94,12 @@ This guide describes how to set up your development environment for Cordova and
5B. Deploy to Device/Emulator
--------------------
-- Make sure that your target device is properly launched/connected/configured ("Date and Time" settings must have been set correctly)
-- Select your application deployment target with the **Connection Explorer** view (Select **Window** Menu -> **Show View** -> **Connection Explorer** )
+- Make sure that your target device is properly launched/connected/configured. __Date and Time__ settings must have been set correctly.
+- Select your application deployment target with the **Connection Explorer** view (Select **Window → Show View → Connection Explorer**.)
-- **Right Click** your project in the **Project Explorer** view and Select **Run As** and **Tizen Web Application**
+- **Right-click** your project in the **Project Explorer** view and select **Run As** and **Tizen Web Application**
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/getting-started/webos/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/webos/index.md b/docs/en/edge/guide/getting-started/webos/index.md
index 6d60026..141a3e4 100644
--- a/docs/en/edge/guide/getting-started/webos/index.md
+++ b/docs/en/edge/guide/getting-started/webos/index.md
@@ -38,10 +38,10 @@ Video Tutorials:
- Download and install [Virtual Box](http://www.virtualbox.org/)
- Download and install [WebOS SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321/)
-- Download and install [cygwin SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321) (Windows only). Make sure you select "make" as it is not included by default
+- Download and install [cygwin SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321) (Windows only). Make sure you select `make` as it is not included by default
- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `webOS` directory.
- Download and install XCode from the [Mac App Store](http://itunes.apple.com/ca/app/xcode/id497799835?mt=12) (OSX only)
-- Download and install Command Line Tools for XCode (OSX only); this can be done by going to XCode's Preferences -> Downloads -> Components and then click install on Command Line Tools
+- Download and install Command Line Tools for XCode (OSX only); this can be done by going to XCode's Preferences → Downloads → Components and then click install on Command Line Tools
3. Set up New Project
--------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/getting-started/windows-8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/windows-8/index.md b/docs/en/edge/guide/getting-started/windows-8/index.md
index adef5d4..d8face5 100644
--- a/docs/en/edge/guide/getting-started/windows-8/index.md
+++ b/docs/en/edge/guide/getting-started/windows-8/index.md
@@ -25,10 +25,10 @@ environment and run a sample application. Note that Cordova used to
be called PhoneGap, so some of the sites still use the old PhoneGap
name.
-Microsoft deprecated the name "Metro-style apps" in Windows 8 and
-Windows RT. MSDN now refers to this type of app as a "Windows Store"
+Microsoft deprecated the name _Metro-style apps_ in Windows 8 and
+Windows RT. MSDN now refers to this type of app as a _Windows Store_
app, and this guide follows that convention. Also, in this guide
-"Windows 8" signifies both Windows 8 and Windows RT.
+_Windows 8_ signifies both Windows 8 and Windows RT.
1. Requirements
---------------
@@ -48,20 +48,22 @@ Follow the instructions [here](http://www.windowsstore.com/) to submit your apps
3. Set up New Project
--------------------
-You can already build Windows 8 apps using the "HTML/JavaScript track" available in Windows Store apps. The purpose of Cordova in Windows Store apps is to expose the same APIs used on all the other Cordova platforms.
+You can already build Windows 8 apps using the _HTML/JavaScript track_
+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** 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** in this example.
-- Microsoft continues to use `default.html` as the default home page, but most web developers use `index.html`. (Plus it's likely that in the other platform variants of your project you are using `index.html` as the name of your default page.) To fix this, in Solution Explorer rename the `default.html` file to `index.html`. Then double-click the **package.appxmanifest** file and change the **Start page** value to **index.html**.
+- Microsoft continues to use `default.html` as the default home page, but most web developers use `index.html`. (Plus it's likely that in the other platform variants of your project you are using `index.html` as the name of your default page.) To fix this, in Solution Explorer rename the `default.html` file to `index.html`. Then double-click the `package.appxmanifest` file and change the **Start page** value to `index.html`.
-- To include **cordova.js** in your project, right-click on the **js** folder in Solution Explorer and select **Add - New Item**. Locate the **cordova.js** file in the **lib\windows-8** folder noted above.
+- To include `cordova.js` in your project, right-click on the **js** folder in Solution Explorer and select **Add → New Item**. Locate the `cordova.js` file in the **lib\windows-8** folder noted above.
-- Edit the code for **index.html**. Add a reference to **cordova.js**. You can do this manually, or by dragging the file from Solution Explorer.
+- 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.
### Adding the reference...
<!-- WinJS references -->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/getting-started/windows-phone-7/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/windows-phone-7/index.md b/docs/en/edge/guide/getting-started/windows-phone-7/index.md
index 2ff44df..704c64c 100644
--- a/docs/en/edge/guide/getting-started/windows-phone-7/index.md
+++ b/docs/en/edge/guide/getting-started/windows-phone-7/index.md
@@ -45,7 +45,7 @@ __NOTE:__ Running in VM does not work well. If you are on a Mac, you need to set
- Copy the `CordovaStarter-x.x.x.zip` to the `\My Documents\Visual Studio 2010\Templates\ProjectTemplates\` folder.
(If the template file does not exist, you need to build it as described in 2.1 below.)
if you have just installed VisualStudio, you should launch it once to create this folder
-if you prefer, you may add the project instead to the "Silverlight for Windows Phone" subfolder of "Visual C#". This is up to you, and only affects where the project template is shown when creating a new project. Also, You may need to create this folder.
+if you prefer, you may add the project instead to the `Silverlight for Windows Phone` subfolder of `Visual C#`. This is up to you, and only affects where the project template is shown when creating a new project. Also, You may need to create this folder.
2.1. Building the template
-----------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/getting-started/windows-phone-8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/windows-phone-8/index.md b/docs/en/edge/guide/getting-started/windows-phone-8/index.md
index 8938f47..490fbe1 100644
--- a/docs/en/edge/guide/getting-started/windows-phone-8/index.md
+++ b/docs/en/edge/guide/getting-started/windows-phone-8/index.md
@@ -45,7 +45,7 @@ __NOTE:__ Applications built with Apache Cordova for Windows Phone 8 run only on
- 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 )
- - 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.
+ - 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 and/or submit it to Market Place.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/plugin-development/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/blackberry/index.md b/docs/en/edge/guide/plugin-development/blackberry/index.md
index d7c8dea..3e4fc30 100644
--- a/docs/en/edge/guide/plugin-development/blackberry/index.md
+++ b/docs/en/edge/guide/plugin-development/blackberry/index.md
@@ -120,7 +120,7 @@ and [str] are the arguments we are passing in.
So if we look at the code above, we can see that within the execute
method, we are first looking for what actions are coming in. The Echo
-plugin has only one action, "echo", so we will be only checking for
+plugin has only one action, `echo`, so we will be only checking for
that. If our plugin had more actions, it's simply a matter of adding
more conditional tests to check for those actions.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/plugin-development/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/index.md b/docs/en/edge/guide/plugin-development/index.md
index 6201c95..5d43824 100644
--- a/docs/en/edge/guide/plugin-development/index.md
+++ b/docs/en/edge/guide/plugin-development/index.md
@@ -50,7 +50,7 @@ thing you _must_ use to communicate between the Cordova JavaScript
"action", ["firstArgument", "secondArgument", 42,
false]);
-The parameters explained in more detail:
+The parameters are detailed below:
1. `function(winParam) {}` - Success function callback. Assuming your
`exec` call completes successfully, this function is invoked
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/plugin-development/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/ios/index.md b/docs/en/edge/guide/plugin-development/ios/index.md
index 5228896..be6e916 100644
--- a/docs/en/edge/guide/plugin-development/ios/index.md
+++ b/docs/en/edge/guide/plugin-development/ios/index.md
@@ -148,7 +148,8 @@ 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.
+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.
This plugin only supports one action, the `echo` action. First, we
grab the echo string using the `objectAtIndex` method on our `args`,
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/plugin-development/windows-phone/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/windows-phone/index.md b/docs/en/edge/guide/plugin-development/windows-phone/index.md
index 6ec0bd3..8b16fe3 100644
--- a/docs/en/edge/guide/plugin-development/windows-phone/index.md
+++ b/docs/en/edge/guide/plugin-development/windows-phone/index.md
@@ -26,10 +26,10 @@ application JavaScript code and manages native API calls. There is a BaseCommand
(`WP7CordovaClassLib.Cordova.Commands.BaseCommand`) class in C# which you can extend,
and it comes with the majority of the 'plumbing' built for you already.
-1. Select your project, and right click choose 'Add -> New Item ...'
+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", ...)`
+ - 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;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/project-settings/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/android/index.md b/docs/en/edge/guide/project-settings/android/index.md
index 20b0ea1..e4b627a 100644
--- a/docs/en/edge/guide/project-settings/android/index.md
+++ b/docs/en/edge/guide/project-settings/android/index.md
@@ -29,8 +29,8 @@ The `config.xml` settings file controls various settings of Cordova. This is app
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. Format for the value is "Title, Message"
-3. **loadingPageDialog** - Display a native loading dialog when loading sub-pages. Format for the value is "Title, Message"
+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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/project-settings/bada/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/bada/index.md b/docs/en/edge/guide/project-settings/bada/index.md
index 6d3f7a6..ab7be31 100644
--- a/docs/en/edge/guide/project-settings/bada/index.md
+++ b/docs/en/edge/guide/project-settings/bada/index.md
@@ -13,7 +13,7 @@
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied. See the License for the
+# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/project-settings/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/ios/index.md b/docs/en/edge/guide/project-settings/ios/index.md
index ed4404d..60e1129 100644
--- a/docs/en/edge/guide/project-settings/ios/index.md
+++ b/docs/en/edge/guide/project-settings/ios/index.md
@@ -31,7 +31,7 @@ Various preferences (as **<preference>** tags) default on not breaking exi
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"
+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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/958f8d20/docs/en/edge/guide/project-settings/wp8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/wp8/index.md b/docs/en/edge/guide/project-settings/wp8/index.md
index 7d9ca64..5a59d78 100644
--- a/docs/en/edge/guide/project-settings/wp8/index.md
+++ b/docs/en/edge/guide/project-settings/wp8/index.md
@@ -22,4 +22,4 @@
Project Settings for Windows Phone 8
===================================
-Windows Phone 8 does not currently have any additional configurable features.
\ No newline at end of file
+Windows Phone 8 does not currently have any additional configurable features.
[07/46] docs commit: Merge branch 'copy_edit' of
https://github.com/mike-sierra/cordova-docs into copy_edit
Posted by mw...@apache.org.
Merge branch 'copy_edit' of https://github.com/mike-sierra/cordova-docs into copy_edit
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/47976246
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/47976246
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/47976246
Branch: refs/heads/master
Commit: 47976246566eb28289d1ede591829d45ff8b55b2
Parents: 726c963 b151e34
Author: Mike Sierra <le...@gmail.com>
Authored: Mon Apr 29 11:35:38 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon Apr 29 11:35:38 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/overview/apis.md | 25 +++
docs/en/edge/guide/overview/index.md | 29 +++
docs/en/edge/guide/overview/support.html | 302 ++++++++++++++++++++++++++
docs/en/edge/guide/overview/support.md | 302 ++++++++++++++++++++++++++
4 files changed, 658 insertions(+)
----------------------------------------------------------------------
[30/46] docs commit: thru inappbrowser
Posted by mw...@apache.org.
thru inappbrowser
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/49778362
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/49778362
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/49778362
Branch: refs/heads/master
Commit: 4977836297f97c2e31f8107831323b8a7f1fa353
Parents: f4bf442
Author: Mike Sierra <le...@gmail.com>
Authored: Fri May 17 13:06:14 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Fri May 17 13:06:14 2013 -0400
----------------------------------------------------------------------
.../accelerometer/acceleration/acceleration.md | 8 +-
.../camera/parameter/CameraPopoverOptions.md | 10 +--
.../cordova/camera/parameter/cameraError.md | 2 +-
.../cordova/camera/parameter/cameraOptions.md | 22 ++---
.../cordova/camera/parameter/cameraSuccess.md | 2 +-
.../contacts/parameters/contactSuccess.md | 2 +-
.../geolocation/parameters/geolocationError.md | 2 +-
.../parameters/geolocationSuccess.md | 2 +-
.../GlobalizationError/globalizationerror.md | 4 +-
.../edge/cordova/inappbrowser/inappbrowser.md | 90 ++++++++++----------
.../en/edge/cordova/inappbrowser/window.open.md | 39 +++++----
.../edge/cordova/media/Parameters/mediaError.md | 2 +-
.../cordova/notification/notification.alert.md | 8 +-
.../cordova/notification/notification.beep.md | 2 +-
.../notification/notification.confirm.md | 10 +--
.../cordova/notification/notification.prompt.md | 12 +--
.../notification/notification.vibrate.md | 2 +-
17 files changed, 107 insertions(+), 112 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
index cae085e..e365106 100644
--- a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
+++ b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
@@ -25,10 +25,10 @@ Contains `Accelerometer` data captured at a specific point in time.
Properties
----------
-- __x__: Amount of acceleration on the x-axis. (in m/s^2) (`Number`)
-- __y__: Amount of acceleration on the y-axis. (in m/s^2) (`Number`)
-- __z__: Amount of acceleration on the z-axis. (in m/s^2) (`Number`)
-- __timestamp__: Creation timestamp in milliseconds. (`DOMTimeStamp`)
+- __x__: Amount of acceleration on the x-axis. (in m/s^2) _(Number)_
+- __y__: Amount of acceleration on the y-axis. (in m/s^2) _(Number)_
+- __z__: Amount of acceleration on the z-axis. (in m/s^2) _(Number)_
+- __timestamp__: Creation timestamp in milliseconds. _(DOMTimeStamp)_
Description
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
index dec818e..c88c544 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
@@ -34,15 +34,15 @@ or album.
CameraPopoverOptions
--------------------
-- __x__: x pixel coordinate of screen element onto which to anchor the popover. (`Number`)
+- __x__: x pixel coordinate of screen element onto which to anchor the popover. _(Number)_
-- __y__: y pixel coordinate of screen element onto which to anchor the popover. (`Number`)
+- __y__: y pixel coordinate of screen element onto which to anchor the popover. _(Number)_
-- __width__: width, in pixels, of the screen element onto which to anchor the popover. (`Number`)
+- __width__: width, in pixels, of the screen element onto which to anchor the popover. _(Number)_
-- __height__: height, in pixels, of the screen element onto which to anchor the popover. (`Number`)
+- __height__: height, in pixels, of the screen element onto which to anchor the popover. _(Number)_
-- __arrowDir__: Direction the arrow on the popover should point. Defined in `Camera.PopoverArrowDirection` (`Number`)
+- __arrowDir__: Direction the arrow on the popover should point. Defined in `Camera.PopoverArrowDirection` _(Number)_
Camera.PopoverArrowDirection = {
ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/camera/parameter/cameraError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraError.md b/docs/en/edge/cordova/camera/parameter/cameraError.md
index c89b0fa..fced900 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraError.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraError.md
@@ -29,4 +29,4 @@ onError callback function that provides an error message.
Parameters
----------
-- __message__: The message is provided by the device's native code. (`String`)
+- __message__: The message is provided by the device's native code. _(String)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraOptions.md b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
index d3385dd..4e70f9f 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
@@ -35,9 +35,9 @@ Optional parameters to customize the camera settings.
Options
-------
-- __quality__: Quality of saved image. Range is [0, 100]. (`Number`)
+- __quality__: Quality of saved image. Range is [0, 100]. _(Number)_
-- __destinationType__: Choose the format of the return value. Defined in `navigator.camera.DestinationType` (`Number`)
+- __destinationType__: Choose the format of the return value. Defined in `navigator.camera.DestinationType` _(Number)_
Camera.DestinationType = {
DATA_URL : 0, // Return image as base64-encoded string
@@ -45,7 +45,7 @@ Options
NATIVE_URI : 2 // Return image native URI (e.g. assets-library:// on iOS or content:// on Android)
};
-- __sourceType__: Set the source of the picture. Defined in `navigator.camera.PictureSourceType` (`Number`)
+- __sourceType__: Set the source of the picture. Defined in `navigator.camera.PictureSourceType` _(Number)_
Camera.PictureSourceType = {
PHOTOLIBRARY : 0,
@@ -53,19 +53,19 @@ Options
SAVEDPHOTOALBUM : 2
};
-- __allowEdit__: Allow simple editing of image before selection. (`Boolean`)
+- __allowEdit__: Allow simple editing of image before selection. _(Boolean)_
-- __encodingType__: Choose the returned image file's encoding. Defined in `navigator.camera.EncodingType` (`Number`)
+- __encodingType__: Choose the returned image file's encoding. Defined in `navigator.camera.EncodingType` _(Number)_
Camera.EncodingType = {
JPEG : 0, // Return JPEG encoded image
PNG : 1 // Return PNG encoded image
};
-- __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`)
+- __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`)
+- __mediaType__: Set the type of media to select from. Only works when `PictureSourceType` is `PHOTOLIBRARY` or `SAVEDPHOTOALBUM`. Defined in `nagivator.camera.MediaType` _(Number)_
Camera.MediaType = {
PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
@@ -73,10 +73,10 @@ Options
ALLMEDIA : 2 // allow selection from all media types
};
-- __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`)
+- __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`)
+- __cameraDirection__: Choose the camera to use (front- or back-facing). Defined in `navigator.camera.Direction` _(Number)_
Camera.Direction = {
BACK : 0, // Use the back-facing camera
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraSuccess.md b/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
index d9ceb75..45a0a2e 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
@@ -29,7 +29,7 @@ onSuccess callback function that provides the image data.
Parameters
----------
-- __imageData__: Base64 encoding of the image data, _or_ the image file URI, depending on `cameraOptions` in effect. (`String`)
+- __imageData__: Base64 encoding of the image data, _or_ the image file URI, depending on `cameraOptions` in effect. _(String)_
Example
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
index 0cf2a83..fb8b284 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
@@ -29,7 +29,7 @@ Success callback function that provides the `Contact` array resulting from a `co
Parameters
----------
-- __contacts__: The contact array resulting from a find operation. (`Contact`)
+- __contacts__: The contact array resulting from a find operation. _(Contact)_
Example
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocationError.md b/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
index 66cdefd..c087165 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
@@ -30,4 +30,4 @@ geolocation functions.
Parameters
----------
-- __error__: The error returned by the device. (`PositionError`)
+- __error__: The error returned by the device. _(PositionError)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md b/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
index da61fc0..8df414a 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
@@ -32,7 +32,7 @@ or when the position changes (when called from
Parameters
----------
-- __position__: The geolocation position returned by the device. (`Position`)
+- __position__: The geolocation position returned by the device. _(Position)_
Example
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
index d5af9a9..9916d7f 100644
--- a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
+++ b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -25,12 +25,12 @@ An object representing a error from the Globalization API.
Properties
----------
-- __code__: One of the following codes representing the error type (`Number`)
+- __code__: One of the following codes representing the error type _(Number)_
- GlobalizationError.UNKNOWN\_ERROR: 0
- GlobalizationError.FORMATTING\_ERROR: 1
- GlobalizationError.PARSING\_ERROR: 2
- GlobalizationError.PATTERN\_ERROR: 3
-- __message__: A text message that includes the error's explanation and/or details (`String`)
+- __message__: A text message that includes the error's explanation and/or details _(String)_
Description
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/inappbrowser/inappbrowser.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/inappbrowser.md b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
index fc63a43..d85aa4a 100644
--- a/docs/en/edge/cordova/inappbrowser/inappbrowser.md
+++ b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
InAppBrowser
============
-> The InAppBrowser is a web-browser that is shown in your app when you use the `window.open` call.
+> The `InAppBrowser` is a web browser that displays in the app when calling `window.open`.
var ref = window.open('http://apache.org', '_blank', 'location=yes');
@@ -60,20 +60,19 @@ Permissions
addEventListener
================
-> Adds a listener for an event from the InAppBrowser.
+> Adds a listener for an event from the `InAppBrowser`.
ref.addEventListener(eventname, callback);
-- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
-- __eventname__: the event to listen for (`String`)
+- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
+- __eventname__: the event to listen for _(String)_
- loadstart - event fired when the InAppBrowser starts to load a URL
- loadstop - event fired when the InAppBrowser finished loading a URL
- loaderror - event fired when the InAppBrowser encounters an error loading a URL
- exit - event fired when the InAppBrowser window is closed
+ - __loadstart__: event fires when the `InAppBrowser` starts to load a URL.
+ - __loadstop__: event fires when the `InAppBrowser` finishes loading a URL.
+ - __loaderror__: event fires when the `InAppBrowser` encounters an error when loading a URL.
+ - __exit__: event fires when the `InAppBrowser` window is closed.
-- __callback__: the function that is called when the event is fired.
-The function is passed an `InAppBrowserEvent` object.
+- __callback__: the function that executes when the event fires. The function is passed an `InAppBrowserEvent` object as a parameter.
Supported Platforms
-------------------
@@ -122,19 +121,19 @@ Full Example
removeEventListener
===================
-> Removes a listener for an event from the InAppBrowser.
+> Removes a listener for an event from the `InAppBrowser`.
ref.removeEventListener(eventname, callback);
-- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
-- __eventname__: the event to stop listening for (`String`)
+- __ref__: reference to the `InAppBrowser` window. _(InAppBrowser)_
+- __eventname__: the event to stop listening for. _(String)_
- loadstart - event fired when the InAppBrowser starts to load a URL
- loadstop - event fired when the InAppBrowser finished loading a URL
- loaderror - event fired when the InAppBrowser encounters an error loading a URL
- exit - event fired when the InAppBrowser window is closed
+ - __loadstart__: event fires when the `InAppBrowser` starts to load a URL.
+ - __loadstop__: event fires when the `InAppBrowser` finishes loading a URL.
+ - __loaderror__: event fires when the `InAppBrowser` encounters an error loading a URL.
+ - __exit__: event fires when the `InAppBrowser` window is closed.
-- __callback__: the function that was to be called when the event is fired.
+- __callback__: the function to execute when the event fires.
The function is passed an `InAppBrowserEvent` object.
Supported Platforms
@@ -209,11 +208,11 @@ Full Example
close
=====
-> Closes the InAppBrowser window.
+> Closes the `InAppBrowser` window.
ref.close();
-- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
+- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
Supported Platforms
-------------------
@@ -263,21 +262,20 @@ Full Example
executeScript
=============
-> Injects JavaScript code into the InAppBrowser window
+> Injects JavaScript code into the `InAppBrowser` window
ref.executeScript(details, callback);
-- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
-- __injectDetails__: details of the script ot run (`Object`)
- - Supported keys: (exactly one of "file" or "code" should be present)
-
- "file" - URL of the script to inject
- "code" - Text of the script to inject
-
-- __callback__: the function that is to be called in the Cordova application after the JavaScript code is injected.
- - If the injected script is of type "code", then the callback is called with a single argument, which is
- the return value of the script, wrapped in an Array. (For multi-line scripts, this is the return value of the
- last statement, or the last expression evaluated.)
+- __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
+ script, wrapped in an `Array`. For multi-line scripts, this is
+ the return value of the last statement, or the last expression
+ evaluated.
Supported Platforms
-------------------
@@ -343,18 +341,15 @@ Full Example
insertCSS
=========
-> Injects CSS into the InAppBrowser window
+> Injects CSS into the `InAppBrowser` window.
ref.insertCSS(details, callback);
-- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
-- __injectDetails__: details of the script ot run (`Object`)
- - Supported keys: (exactly one of "file" or "code" should be present)
-
- "file" - URL of the stylesheet to inject
- "code" - Text of the stylesheet to inject
-
-- __callback__: the function that is to be called in the Cordova application after the CSS is injected.
+- __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
-------------------
@@ -420,12 +415,13 @@ Full Example
InAppBrowserEvent
=================
-The object that is passed to the callback function from an addEventListener call on an InAppBrowser object.
+The object that is passed to the callback function from an
+`addEventListener` call on an `InAppBrowser` object.
Properties
----------
-- __type__: the eventname (`String`) - one of loadstart, loadstop, loaderror or exit
-- __url__: the URL that was loaded (`String`)
-- __code__: the error code (`Number`) - only in the case of loaderror
-- __message__: the error message (`String`) - only in the case of loaderror
+- __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/49778362/docs/en/edge/cordova/inappbrowser/window.open.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/window.open.md b/docs/en/edge/cordova/inappbrowser/window.open.md
index 802d90f..eec3a42 100644
--- a/docs/en/edge/cordova/inappbrowser/window.open.md
+++ b/docs/en/edge/cordova/inappbrowser/window.open.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,34 +20,34 @@ license: Licensed to the Apache Software Foundation (ASF) under one
window.open
===========
-Opens a URL in a new InAppBrowser instance, the current browser instance, or the system browser.
+Opens a URL in a new `InAppBrowser` instance, the current browser
+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 you have Unicode characters in your URL.
-- __target__: the target to load the URL in (`String`) (Optional, Default: "_self")
+- __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 URL is in the white-list, else it opens in the InAppBrowser
- _blank - always open in the InAppBrowser
- _system - always open in the system web browser
-
+ - `_self`: Opens in the Cordova WebView if the URL is in the white list, otherwise it opens in the `InAppBrowser`.
+ - `_blank`: Opens in the `InAppBrowser`.
+ - `_system`: Opens in the system's web browser.
-- __options__: options for the InAppBrowser (`String`) (Optional, Default: "location=yes")
+- __options__: Options for the `InAppBrowser`. Optional, defaulting to: `location=yes`. _(String)_
- The options string must not contain any blank space, each feature name and value must be separated by a comma. Feature names are case insensitive. Only the value below is supported on all platforms:
+ The `options` string must not contain any blank space, and each feature's name/value pairs must be separated by a comma. Feature names are case insensitive. All platforms support the value below:
- - __location__: set to 'yes' or 'no' to turn the location bar on or off for the InAppBrowser
+ - __location__: Set to `yes` or `no` to turn the `InAppBrowser`'s location bar on or off.
iOS only
--------
- - __enableViewportScale__: set to 'yes' or 'no' to prevent viewport scaling through a meta tag (defaults to 'no')
- - __mediaPlaybackRequiresUserAction__: set to 'yes' or 'no' to not allow autoplayed HTML5 video (defaults to 'no')
- - __allowInlineMediaPlayback__: set to 'yes' or 'no' to allow inline HTML5 media playback, also, the video element in the HTML document must also include the webkit-playsinline attribute (defaults to 'no')
- - __keyboardDisplayRequiresUserAction__: set to 'yes' or 'no' to open the keyboard when form elements get focus via the JavaScript focus() call (defaults to 'yes')
- - __suppressesIncrementalRendering__: set to 'yes' or 'no' to wait until all new view content has been received before it is rendered (defaults to 'no')
- - __presentationstyle__: set to 'pagesheet', 'formsheet' or 'fullscreen' to set the [presentation style](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle) (defaults to 'fullscreen')
- - __transitionstyle__: set to 'fliphorizontal', 'crossdissolve' or 'coververtical' to set the [transition style](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle) (defaults to 'coververtical')
+ - __enableViewportScale__: Set to `yes` or `no` to prevent viewport scaling through a meta tag (defaults to `no`).
+ - __mediaPlaybackRequiresUserAction__: Set to `yes` or `no` to prevent HTML5 audio or video from autoplaying (defaults to `no`).
+ - __allowInlineMediaPlayback__: Set to `yes` or `no` to allow inline HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. The HTML's `video` element must also include the `webkit-playsinline` attribute (defaults to `no`)
+ - __keyboardDisplayRequiresUserAction__: Set to `yes` or `no` to open the keyboard when form elements receive focus via JavaScript's `focus()` call (defaults to `yes`).
+ - __suppressesIncrementalRendering__: Set to `yes` or `no` to wait until all new view content is received before being rendered (defaults to `no`).
+ - __presentationstyle__: Set to `pagesheet`, `formsheet` or `fullscreen` to set the [presentation style](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle) (defaults to `fullscreen`).
+ - __transitionstyle__: Set to `fliphorizontal`, `crossdissolve` or `coververtical` to set the [transition style](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle) (defaults to `coververtical`).
Supported Platforms
-------------------
@@ -92,4 +92,3 @@ Full Example
<body>
</body>
</html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/Parameters/mediaError.md b/docs/en/edge/cordova/media/Parameters/mediaError.md
index 9236c86..f152ab4 100644
--- a/docs/en/edge/cordova/media/Parameters/mediaError.md
+++ b/docs/en/edge/cordova/media/Parameters/mediaError.md
@@ -29,4 +29,4 @@ A user specified callback function that is invoked when there is an error in med
Parameters
----------
-- __error__: The error returned by the device. (`MediaError`)
+- __error__: The error returned by the device. _(MediaError)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/notification/notification.alert.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.alert.md b/docs/en/edge/cordova/notification/notification.alert.md
index 11a0724..0957677 100644
--- a/docs/en/edge/cordova/notification/notification.alert.md
+++ b/docs/en/edge/cordova/notification/notification.alert.md
@@ -24,10 +24,10 @@ 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, Default: "Alert")
-- __buttonName__: Button name (`String`) (Optional, Default: "OK")
+- __message__: Dialog message _(String)_
+- __alertCallback__: Callback to invoke when alert dialog is dismissed. _(Function)_
+- __title__: Dialog title _(String)_ (Optional, Default: "Alert")
+- __buttonName__: Button name _(String)_ (Optional, Default: "OK")
Description
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.beep.md b/docs/en/edge/cordova/notification/notification.beep.md
index 56f8df2..7eed928 100644
--- a/docs/en/edge/cordova/notification/notification.beep.md
+++ b/docs/en/edge/cordova/notification/notification.beep.md
@@ -24,7 +24,7 @@ The device will play a beep sound.
navigator.notification.beep(times);
-- __times__: The number of times to repeat the beep (`Number`)
+- __times__: The number of times to repeat the beep _(Number)_
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.confirm.md b/docs/en/edge/cordova/notification/notification.confirm.md
index 9b977ae..086b943 100755
--- a/docs/en/edge/cordova/notification/notification.confirm.md
+++ b/docs/en/edge/cordova/notification/notification.confirm.md
@@ -24,10 +24,10 @@ Shows 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, Default: "Confirm")
-- __buttonLabels__: Comma separated string with button labels (`String`) (Optional, Default: "OK,Cancel")
+- __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, Default: "Confirm")
+- __buttonLabels__: Comma separated string with button labels _(String)_ (Optional, Default: "OK,Cancel")
Description
-----------
@@ -39,7 +39,7 @@ confirmCallback
The `confirmCallback` is called when the user has pressed one of the buttons on the confirmation dialog box.
-The callback takes the argument `buttonIndex` (`Number`), which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc.
+The callback takes the argument `buttonIndex` _(Number)_, which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.prompt.md b/docs/en/edge/cordova/notification/notification.prompt.md
index 56e07e6..ce947d2 100644
--- a/docs/en/edge/cordova/notification/notification.prompt.md
+++ b/docs/en/edge/cordova/notification/notification.prompt.md
@@ -24,10 +24,10 @@ Shows a customizable prompt dialog box.
navigator.notification.prompt(message, promptCallback, [title], [buttonLabels])
-- __message__: Dialog message (`String`)
-- __promptCallback__: Callback to invoke when a button is pressed (`Function`)
-- __title__: Dialog title (`String`) (Optional, Default: "Prompt")
-- __buttonLabels__: Array of strings for the button labels (`Array`) (Optional, Default: ["OK","Cancel"])
+- __message__: Dialog message _(String)_
+- __promptCallback__: Callback to invoke when a button is pressed _(Function)_
+- __title__: Dialog title _(String)_ (Optional, Default: "Prompt")
+- __buttonLabels__: Array of strings for the button labels _(Array)_ (Optional, Default: ["OK","Cancel"])
Description
-----------
@@ -41,8 +41,8 @@ The `promptCallback` is called when the user has pressed one of the buttons on t
The callback takes the argument `results` which contains the following properties:
-- __buttonIndex__: (`Number`), which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc.
-- __input1__: (`String`), which is the text entered in the prompt dialog box.
+- __buttonIndex__: _(Number)_, which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc.
+- __input1__: _(String)_, which is the text entered in the prompt dialog box.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49778362/docs/en/edge/cordova/notification/notification.vibrate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.vibrate.md b/docs/en/edge/cordova/notification/notification.vibrate.md
index 54ed5fe..fcc92f2 100644
--- a/docs/en/edge/cordova/notification/notification.vibrate.md
+++ b/docs/en/edge/cordova/notification/notification.vibrate.md
@@ -24,7 +24,7 @@ Vibrates the device for the specified amount of time.
navigator.notification.vibrate(milliseconds)
-- __time__: Milliseconds to vibrate the device. 1000 milliseconds equals 1 second (`Number`)
+- __time__: Milliseconds to vibrate the device. 1000 milliseconds equals 1 second _(Number)_
Supported Platforms
-------------------
[16/46] docs commit: incremental edits
Posted by mw...@apache.org.
incremental edits
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/90486027
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/90486027
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/90486027
Branch: refs/heads/master
Commit: 90486027f67fe8225cda6cac9ae697d82ad6848a
Parents: bfc9025
Author: Mike Sierra <le...@gmail.com>
Authored: Tue May 14 14:07:06 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Tue May 14 14:07:06 2013 -0400
----------------------------------------------------------------------
.../accelerometer/acceleration/acceleration.md | 7 ++-
.../accelerometer/accelerometer.clearWatch.md | 4 +-
.../accelerometer.getCurrentAcceleration.md | 15 +++--
.../edge/cordova/accelerometer/accelerometer.md | 4 +-
.../accelerometer.watchAcceleration.md | 26 ++++++---
.../parameters/accelerometerError.md | 4 +-
.../parameters/accelerometerOptions.md | 6 +-
.../parameters/accelerometerSuccess.md | 6 +-
docs/en/edge/cordova/camera/camera.cleanup.md | 11 ++--
.../en/edge/cordova/camera/camera.getPicture.md | 59 ++++++++++++++------
docs/en/edge/cordova/camera/camera.md | 2 +-
.../camera/parameter/CameraPopoverHandle.md | 4 +-
.../camera/parameter/CameraPopoverOptions.md | 21 ++++---
.../cordova/camera/parameter/cameraError.md | 4 +-
.../cordova/camera/parameter/cameraOptions.md | 48 ++++++++--------
.../cordova/camera/parameter/cameraSuccess.md | 6 +-
.../edge/cordova/compass/compass.clearWatch.md | 2 +-
.../cordova/compass/compass.clearWatchFilter.md | 4 +-
.../compass/compass.getCurrentHeading.md | 9 ++-
docs/en/edge/cordova/compass/compass.md | 2 +-
.../cordova/compass/compass.watchHeading.md | 35 +++++++++---
.../compass/compass.watchHeadingFilter.md | 2 +-
.../compass/compassError/compassError.md | 2 +-
.../cordova/compass/parameters/compassError.md | 2 +-
.../compass/parameters/compassHeading.md | 18 +++---
.../compass/parameters/compassOptions.md | 10 ++--
.../compass/parameters/compassSuccess.md | 4 +-
docs/en/edge/cordova/connection/connection.md | 6 +-
.../edge/cordova/connection/connection.type.md | 18 +++---
29 files changed, 204 insertions(+), 137 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
index 9b81fe8..ea72f91 100644
--- a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
+++ b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -33,7 +33,10 @@ Properties
Description
-----------
-This object is created and populated by Cordova, and returned by an `Accelerometer` method. The x, y, z acceleration values include the effect of gravity (9.81 m/s^2), so at when a device is lying flat on a table facing up, the value returned should be x=0, y=0, z=9.81.
+This object is created and populated by Cordova, and returned by an
+`Accelerometer` method. Acceleration values include the effect of
+gravity (9.81 m/s^2), so that when a device lies flat and facing up,
+_x_, _y_, and _z_ values returned should be `0`, `0`, and `9.81`.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
index 54e34fe..e5467f5 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
accelerometer.clearWatch
========================
-Stop watching the `Acceleration` referenced by the watch ID parameter.
+Stop watching the `Acceleration` referenced by the `watchID` parameter.
navigator.accelerometer.clearWatch(watchID);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index ba2c701..8ff09a6 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,16 +20,19 @@ license: Licensed to the Apache Software Foundation (ASF) under one
accelerometer.getCurrentAcceleration
====================================
-Get the current acceleration along the x, y, and z axis.
+Get the current acceleration along the _x_, _y_, and _z_ axes.
navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
Description
-----------
-The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation. The accelerometer can detect 3D movement along the x, y, and z axis.
+The accelerometer is a motion sensor that detects the change (_delta_)
+in movement relative to the current device orientation, in three
+dimensions along the _x_, _y_, and _z_ axis.
-The acceleration is returned using the `accelerometerSuccess` callback function.
+These acceleration values are returned to the `accelerometerSuccess`
+callback function.
Supported Platforms
-------------------
@@ -105,6 +108,6 @@ Full Example
iPhone Quirks
-------------
-- iPhone doesn't have the concept of getting the current acceleration at any given point.
+- iPhone 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 will give you the last value reported from a Cordova `watchAccelerometer` call.
+- Thus, the `getCurrentAcceleration` function yields the last value reported from a Cordova `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.md b/docs/en/edge/cordova/accelerometer/accelerometer.md
index 3f68d04..c578dbf 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Accelerometer
=============
-> Captures device motion in the x, y, and z direction.
+> Captures device motion in the _x_, _y_, and _z_ direction.
Methods
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
index 985105a..25592fc 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
accelerometer.watchAcceleration
===============================
-At a regular interval, get the acceleration along the x, y, and z axis.
+At a regular interval, get the acceleration along the _x_, _y_, and _z_ axis.
var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
accelerometerError,
@@ -29,11 +29,19 @@ At a regular interval, get the acceleration along the x, y, and z axis.
Description
-----------
-The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current position. The accelerometer can detect 3D movement along the x, y, and z axis.
+The accelerometer is a motion sensor that detects the change (delta)
+in movement relative to the current position. The accelerometer can
+detect 3D movement along the _x_, _y_, and _z_ axis.
-The `accelerometer.watchAcceleration` gets the device's current acceleration at a regular interval. Each time the `Acceleration` is retrieved, the `accelerometerSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object.
+The `accelerometer.watchAcceleration` method retrieves the device's
+current `Acceleration` at a regular interval, executing the
+`accelerometerSuccess` callback function each time. Specify the
+interval in milliseconds via the `acceleratorOptions` object's
+`frequency` parameter.
-The returned watch ID references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer.
+The returned watch ID references the accelerometer's watch interval,
+and can be used with `accelerometer.clearWatch` to stop watching the
+accelerometer.
Supported Platforms
-------------------
@@ -133,6 +141,8 @@ Full Example
iPhone Quirks
-------------
-- At the interval requested, Cordova will call the success callback function and pass the accelerometer results.
-- However, in requests to the device Cordova restricts the interval to minimum of every 40ms and a maximum of every 1000ms.
- - For example, if you request an interval of 3 seconds (3000ms), Cordova will request an interval of 1 second from the device but invoke the success callback at the requested interval of 3 seconds.
+- Cordova calls the success callback function at the interval
+ requested, but restricts the range of requests to the device between
+ 40ms and 1000ms. For example, if you request an interval of 3
+ seconds, (3000ms), Cordova requests data from the device every 1
+ second, but only executes the success callback every 3 seconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
index c908c16..5faf51e 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -24,4 +24,4 @@ onError callback function for acceleration functions.
function() {
// Handle the error
- }
\ No newline at end of file
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
index 197f416..f52c045 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,9 +20,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
accelerometerOptions
====================
-An optional parameter to customize the retrieval of the accelerometer.
+An optional parameter to customize the retrieval of accelerometer values.
Options
-------
-- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
+- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
index 277fca8..9cdcdf7 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
accelerometerSuccess
====================
-onSuccess callback function that provides the Acceleration information.
+onSuccess callback function that provides the `Acceleration` information.
function(acceleration) {
// Do something
@@ -39,4 +39,4 @@ Example
'Acceleration Y: ' + acceleration.y + '\n' +
'Acceleration Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
- };
\ No newline at end of file
+ };
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/camera/camera.cleanup.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.cleanup.md b/docs/en/edge/cordova/camera/camera.cleanup.md
index fbf9e13..f1e5153 100644
--- a/docs/en/edge/cordova/camera/camera.cleanup.md
+++ b/docs/en/edge/cordova/camera/camera.cleanup.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,15 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
camera.cleanup
=================
-Cleans up the image files that were taken by the camera, that were stored in a temporary storage location.
+Cleans up the photos taken by the camera and made available in a
+temporary storage location.
navigator.camera.cleanup( cameraSuccess, cameraError );
Description
-----------
-Cleans up the image files stored in the temporary storage location, when the function `camera.getPicture` is used with `Camera.sourceType = Camera.PictureSourceType.CAMERA` and `Camera.destinationType = Camera.DestinationType.FILE_URI`
-
+Cleans up the image files stored in the temporary storage location
+after calling `camera.getPicture`. Applies only when the value of
+`Camera.sourceType` equals `Camera.PictureSourceType.CAMERA` and the
+`Camera.destinationType` equals `Camera.DestinationType.FILE_URI`.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.getPicture.md b/docs/en/edge/cordova/camera/camera.getPicture.md
index 368b79b..8f97851 100644
--- a/docs/en/edge/cordova/camera/camera.getPicture.md
+++ b/docs/en/edge/cordova/camera/camera.getPicture.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,31 +20,49 @@ license: Licensed to the Apache Software Foundation (ASF) under one
camera.getPicture
=================
-Takes a photo using the camera or retrieves a photo from the device's album.
-The image is passed to the success callback as a base64 encoded `String` or as the URI of an image file.
-The method itself returns a CameraPopoverHandle object, which can be used to reposition the file selection popover.
+Takes a photo using the camera, or retrieves a photo from the device's
+image gallery. The image is passed to the success callback as a
+base64-encoded `String`, or as the URI for the image file. The method
+itself returns a `CameraPopoverHandle` object that can be used to
+reposition the file selection popover.
navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] );
Description
-----------
-Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `Camera.sourceType = Camera.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
+The `camera.getPicture` function opens the device's default camera
+application that allows the user to take a picture. This behavior
+occurs by default, when `Camera.sourceType` equals
+`Camera.PictureSourceType.CAMERA`. Once the photo is taken, the
+camera application closes and the application is restored.
-If `Camera.sourceType = Camera.PictureSourceType.PHOTOLIBRARY` or `Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected. A `CameraPopoverHandle` object, which can be used to reposition the photo chooser dialog (eg. when the device orientation changes) is returned by `camera.getPicture`.
+If `Camera.sourceType` is `Camera.PictureSourceType.PHOTOLIBRARY` or
+`Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a dialog displays
+that allows users to select an existing image. The
+`camera.getPicture` function returns a `CameraPopoverHandle` object,
+which can be used to reposition the image selection dialog, for
+example, when the device orientation changes.
-The return value will be sent to the `cameraSuccess` function, in one of the following formats, depending on the `cameraOptions` you specify:
+The return value is sent to the `cameraSuccess` callback function, in
+one of the following formats, depending on the specified
+`cameraOptions`:
-- A `String` containing the Base64 encoded photo image (default).
-- A `String` representing the image file location on local storage.
+- A `String` containing the Base64-encoded photo image (default).
+- A `String` representing the image file location on local storage.
-You can do whatever you want with the encoded image or URI, for example:
+You can do whatever you want with the encoded image or URI, for
+example:
-- Render the image in an `<img>` tag _(see example below)_
+- 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:__ The image quality of pictures taken using the camera on newer devices is quite good, and images from the Photo Album will not be downscaled to a lower quality, even if a quality parameter is specified. ___Encoding such images using Base64 has caused memory issues on many newer devices. Therefore, using FILE_URI as the 'Camera.destinationType' is highly recommended.___
+**NOTE:** Photo resolution on newer devices is quite good. Photos
+selected from the device's gallery are not downscaled to a lower
+quality, even if a `quality` parameter is specified. To avoid common
+memory problems, set `Camera.destinationType` to `FILE_URI` rather
+than `DATA_URL`.
Supported Platforms
-------------------
@@ -61,7 +79,10 @@ Supported Platforms
iOS Quirks
----------
-Including a JavaScript alert() in either of the callback functions can cause problems. Wrap the alert in a setTimeout() to allow the iOS image picker or popover to fully close before the alert is displayed:
+Including a JavaScript `alert()` in either of the callback functions
+can cause problems. Wrap the alert within a `setTimeout()` to allow
+the iOS image picker or popover to fully close before the alert
+displays:
setTimeout(function() {
// do your thing here!
@@ -71,21 +92,23 @@ Windows Phone 7 Quirks
----------------------
Invoking the native camera application while your device is connected
-via Zune will not work, and the error callback will be triggered.
+via Zune does not work, and triggers an error callback.
Tizen Quirks
----------------------
-Only 'destinationType: Camera.DestinationType.FILE_URI' and 'sourceType: Camera.PictureSourceType.PHOTOLIBRARY' are supported.
+Tizen only supports a `destinationType` of
+`Camera.DestinationType.FILE_URI` and a `sourceType` of
+`Camera.PictureSourceType.PHOTOLIBRARY`.
Quick Example
-------------
-Take photo and retrieve Base64-encoded image:
+Take a photo and retrieve it as a Base64-encoded image:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
destinationType: Camera.DestinationType.DATA_URL
- });
+ });
function onSuccess(imageData) {
var image = document.getElementById('myImage');
@@ -96,7 +119,7 @@ Take photo and retrieve Base64-encoded image:
alert('Failed because: ' + message);
}
-Take photo and retrieve image file location:
+Take a photo and retrieve the image's file location:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
destinationType: Camera.DestinationType.FILE_URI });
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.md b/docs/en/edge/cordova/camera/camera.md
index 026ccdb..797b00d 100644
--- a/docs/en/edge/cordova/camera/camera.md
+++ b/docs/en/edge/cordova/camera/camera.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
index 94ab149..180e83f 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -38,7 +38,7 @@ setPosition
Set the position of the popover.
__Parameters:__
-- cameraPopoverOptions - the CameraPopoverOptions specifying the new position
+- `cameraPopoverOptions`: the `CameraPopoverOptions` that specify the new position
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
index 6314e8a..79b755b 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,7 +20,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
CameraPopoverOptions
====================
-Parameters only used by iOS to specify the anchor element location and arrow direction of popover used on iPad when selecting images from the library or album.
+iOS-only parameters that specify the anchor element location and arrow
+direction of the popover when selecting images from an iPad's library
+or album.
{ x : 0,
y : 32,
@@ -32,15 +34,15 @@ Parameters only used by iOS to specify the anchor element location and arrow dir
CameraPopoverOptions
--------------------
-- __x:__ x pixel coordinate of element on the screen to anchor popover onto. (`Number`)
+- __x:__ x pixel coordinate of screen element onto which to anchor the popover. (`Number`)
-- __y:__ y pixel coordinate of element on the screen to anchor popover onto. (`Number`)
+- __y:__ y pixel coordinate of screen element onto which to anchor the popover. (`Number`)
-- __width:__ width, in pixels, of the element on the screen to anchor popover onto. (`Number`)
+- __width:__ width, in pixels, of the screen element onto which to anchor the popover. (`Number`)
-- __height:__ height, in pixels, of the element on the screen to anchor popover onto. (`Number`)
+- __height:__ height, in pixels, of the screen element onto which to anchor the popover. (`Number`)
-- __arrowDir:__ Direction the arrow on the popover should point. Defined in Camera.PopoverArrowDirection (`Number`)
+- __arrowDir:__ Direction the arrow on the popover should point. Defined in `Camera.PopoverArrowDirection` (`Number`)
Camera.PopoverArrowDirection = {
ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants
@@ -50,7 +52,10 @@ CameraPopoverOptions
ARROW_ANY : 15
};
-Note that the size of the popover may change to adjust to the direction of the arrow and orientation of the screen. Make sure to account for orientation changes when specifying the anchor element location.
+Note that the size of the popover may change to adjust to the
+direction of the arrow and orientation of the screen. Make sure to
+account for orientation changes when specifying the anchor element
+location.
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/camera/parameter/cameraError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraError.md b/docs/en/edge/cordova/camera/parameter/cameraError.md
index 7ee091b..1460a8e 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraError.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraError.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -29,4 +29,4 @@ onError callback function that provides an error message.
Parameters
----------
-- __message:__ The message is provided by the device's native code. (`String`)
\ No newline at end of file
+- __message:__ The message is provided by the device's native code. (`String`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraOptions.md b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
index de0fba7..30f8832 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -37,15 +37,15 @@ Options
- __quality:__ Quality of saved image. Range is [0, 100]. (`Number`)
-- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`)
+- __destinationType:__ Choose the format of the return value. Defined in `navigator.camera.DestinationType` (`Number`)
Camera.DestinationType = {
- DATA_URL : 0, // Return image as base64 encoded string
- FILE_URI : 1, // Return image file URI
- NATIVE_URI : 2 // Return image native URI (eg. assets-library:// on iOS or content:// on Android)
+ DATA_URL : 0, // Return image as base64 encoded string
+ FILE_URI : 1, // Return image file URI
+ NATIVE_URI : 2 // Return image native URI (e.g. assets-library:// on iOS or content:// on Android)
};
-- __sourceType:__ Set the source of the picture. Defined in nagivator.camera.PictureSourceType (`Number`)
+- __sourceType:__ Set the source of the picture. Defined in `navigator.camera.PictureSourceType` (`Number`)
Camera.PictureSourceType = {
PHOTOLIBRARY : 0,
@@ -55,39 +55,39 @@ Options
- __allowEdit:__ Allow simple editing of image before selection. (`Boolean`)
-- __encodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`)
+- __encodingType:__ Choose the returned image file's encoding. Defined in `navigator.camera.EncodingType` (`Number`)
Camera.EncodingType = {
JPEG : 0, // Return JPEG encoded image
PNG : 1 // Return PNG encoded image
};
-- __targetWidth:__ Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained. (`Number`)
-- __targetHeight:__ Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (`Number`)
+- __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`)
+- __mediaType:__ Set the type of media to select from. Only works when `PictureSourceType` is `PHOTOLIBRARY` or `SAVEDPHOTOALBUM`. Defined in `nagivator.camera.MediaType` (`Number`)
Camera.MediaType = {
- PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
- VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
- ALLMEDIA : 2 // allow selection from all media types
+ PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
+ VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
+ ALLMEDIA : 2 // allow selection from all media types
};
- __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 to specify popover location in iPad. Defined in CameraPopoverOptions.
-- __cameraDirection:__ Choose the camera to use (front- or back-facing). Defined in navigator.camera.Direction (`Number`)
+- __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 = {
- BACK : 0, // Use the back-facing camera
- FRONT : 1 // Use the front-facing camera
+ BACK : 0, // Use the back-facing camera
+ FRONT : 1 // Use the front-facing camera
};
Android Quirks
--------------
- Ignores the `allowEdit` parameter.
-- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
+- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
BlackBerry Quirks
-----------------
@@ -95,9 +95,9 @@ BlackBerry Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Application must have key injection permissions to close native Camera application after photo is taken.
-- Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).
-- Camera.MediaType is not supported.
+- 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.
@@ -107,7 +107,7 @@ webOS Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Camera.MediaType is not supported.
+- `Camera.MediaType` is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
- Ignores the `cameraDirection` parameter.
@@ -115,8 +115,8 @@ webOS Quirks
iOS Quirks
--------------
-- Set `quality` below 50 to avoid memory error on some devices.
-- When `destinationType.FILE_URI` is used, photos are saved in the application's temporary directory. Developers may delete the contents of this directory using the navigator.fileMgr APIs if storage space is a concern.
+- 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.
Windows Phone 7 and 8 Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraSuccess.md b/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
index 773fba4..ab213c6 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -29,7 +29,7 @@ onSuccess callback function that provides the image data.
Parameters
----------
-- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `cameraOptions` used. (`String`)
+- __imageData:__ Base64 encoding of the image data, _or_ the image file URI, depending on `cameraOptions` in effect. (`String`)
Example
-------
@@ -39,4 +39,4 @@ Example
function cameraCallback(imageData) {
var image = document.getElementById('myImage');
image.src = "data:image/jpeg;base64," + imageData;
- }
\ No newline at end of file
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.clearWatch.md b/docs/en/edge/cordova/compass/compass.clearWatch.md
index b36846a..120923c 100755
--- a/docs/en/edge/cordova/compass/compass.clearWatch.md
+++ b/docs/en/edge/cordova/compass/compass.clearWatch.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.clearWatchFilter.md b/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
index 8c92c03..92b7c9c 100644
--- a/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
+++ b/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,4 +20,4 @@ license: Licensed to the Apache Software Foundation (ASF) under one
compass.clearWatchFilter
========================
-No longer supported as of 1.6. See `compass.clearWatch`.
\ No newline at end of file
+No longer supported as of 1.6. See `compass.clearWatch`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
index 30cde63..97f42bd 100755
--- a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
+++ b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -27,9 +27,12 @@ Get the current compass heading.
Description
-----------
-The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
+The compass is a sensor that detects the direction or heading that the
+device is pointed. It measures the heading in degrees from 0 to
+359.99.
-The compass heading information is returned via a CompassHeading object using the `compassSuccess` callback function.
+The compass heading information is returned via a `CompassHeading`
+object using the `compassSuccess` callback function.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.md b/docs/en/edge/cordova/compass/compass.md
index d85be8c..7797f10 100755
--- a/docs/en/edge/cordova/compass/compass.md
+++ b/docs/en/edge/cordova/compass/compass.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeading.md b/docs/en/edge/cordova/compass/compass.watchHeading.md
index f7661d8..b6d925e 100755
--- a/docs/en/edge/cordova/compass/compass.watchHeading.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeading.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -27,18 +27,25 @@ At a regular interval, get the compass heading in degrees.
Description
-----------
-The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
+The compass is a sensor that detects the direction or heading that the
+device is pointed. It measures the heading in degrees from 0 to
+359.99.
-The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `compassOptions` object.
+The `compass.watchHeading` gets the device's current heading at a
+regular interval. Each time the heading is retrieved, the
+`headingSuccess` callback function is executed. Specify the interval
+in milliseconds via the `frequency` parameter in the `compassOptions`
+object.
-The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass.
+The returned watch ID references the compass watch interval. The watch
+ID can be used with `compass.clearWatch` to stop watching the compass.
Supported Platforms
-------------------
- Android
- iPhone
-- Windows Phone 7 and 8 ( if available in hardware )
+- Windows Phone 7 and 8 (if available in hardware)
- Bada 1.2 & 2.x
- webOS
- Tizen
@@ -129,6 +136,18 @@ Full Example
iOS Quirks
--------------
-In iOS `compass.watchHeading` can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `compassOptions` object. Clear the watch as normal by passing the returned watch ID to `compass.clearWatch`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
-
-In iOS only one watchHeading can be in effect at one time. If a watchHeading via filter is in effect, calling getCurrentHeading or watchHeading will use the existing filter value for specifying heading changes. On iOS watching heading changes via a filter is more efficient than via time.
+In iOS `compass.watchHeading` can also get the device's current
+heading when it changes by a specified number of degrees. Each time
+the heading changes by the specified number of degrees or more, the
+`headingSuccess` callback function is called. Specify the degrees of
+change via the `filter` parameter in the `compassOptions` object.
+Clear the watch as usual by passing the returned watch ID to
+`compass.clearWatch`. This functionality replaces the previously
+separate, iOS-only `watchHeadingFilter` and `clearWatchFilter`
+functions, which were removed in version 1.6.
+
+Only one `watchHeading` can be in effect at one time in iOS. If a
+`watchHeading` uses a filter, calling `getCurrentHeading` or
+`watchHeading` uses the existing filter value to specify heading
+changes. Watching heading changes with a filter is more efficient than
+with time intervals.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md b/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
index 6a0283f..f64c2c7 100644
--- a/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compassError/compassError.md b/docs/en/edge/cordova/compass/compassError/compassError.md
index 989b4dc..ef594e6 100644
--- a/docs/en/edge/cordova/compass/compassError/compassError.md
+++ b/docs/en/edge/cordova/compass/compassError/compassError.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassError.md b/docs/en/edge/cordova/compass/parameters/compassError.md
index 67023ec..1751d55 100755
--- a/docs/en/edge/cordova/compass/parameters/compassError.md
+++ b/docs/en/edge/cordova/compass/parameters/compassError.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassHeading.md b/docs/en/edge/cordova/compass/parameters/compassHeading.md
index 935ea06..dc15e5c 100644
--- a/docs/en/edge/cordova/compass/parameters/compassHeading.md
+++ b/docs/en/edge/cordova/compass/parameters/compassHeading.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,29 +20,27 @@ license: Licensed to the Apache Software Foundation (ASF) under one
compassHeading
==========
-A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs.
+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 could not be determined. _(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
-----------
-The `CompassHeading` object is returned to the user through the `compassSuccess` callback function.
+The `CompassHeading` object is returned to the `compassSuccess` callback function.
Android Quirks
--------------
-- trueHeading is not supported. It will report the same value as magneticHeading
-- headingAccuracy will always be 0 as there is no difference between the magneticHeading and trueHeading on Android.
+- `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 running via `navigator.geolocation.watchLocation()`
-- For iOS > 4 devices, if the device is rotated and the app supports that orientation, the heading values will be reported
-back with respect to the current orientation.
-
+- `trueHeading` is only returned when location services are enabled via `navigator.geolocation.watchLocation()`
+- For iOS > 4 devices, 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/90486027/docs/en/edge/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassOptions.md b/docs/en/edge/cordova/compass/parameters/compassOptions.md
index d271a6d..62e84a3 100755
--- a/docs/en/edge/cordova/compass/parameters/compassOptions.md
+++ b/docs/en/edge/cordova/compass/parameters/compassOptions.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -30,16 +30,16 @@ Options
Android Quirks
______________
-- filter is not supported.
+- `filter` is not supported.
Windows Phone 7 and 8 Quirks
--------------
-- filter is not supported.
+- `filter` is not supported.
Bada Quirks
-----------
-- filter is not supported.
+- `filter` is not supported.
Tizen Quirks
-----------
-- filter is not supported.
+- `filter` is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassSuccess.md b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
index 1b0fc9c..6822357 100644
--- a/docs/en/edge/cordova/compass/parameters/compassSuccess.md
+++ b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
compassSuccess
==============
-onSuccess callback function that provides the compass heading information via a compassHeading object.
+onSuccess callback function that provides the compass heading information via a `compassHeading` object.
function(heading) {
// Do something
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.md b/docs/en/edge/cordova/connection/connection.md
index ebecd12..bb773e9 100644
--- a/docs/en/edge/cordova/connection/connection.md
+++ b/docs/en/edge/cordova/connection/connection.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,9 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Connection
==========
-> The `connection` object gives access to the device's cellular and wifi connection information.
-
-This object is exposed as `navigator.connection`.
+> The `connection` object, exposed via `navigator.connection`, provides information about the device's cellular and wifi connection.
Properties
----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/90486027/docs/en/edge/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.type.md b/docs/en/edge/cordova/connection/connection.type.md
index c18e58b..c346890 100644
--- a/docs/en/edge/cordova/connection/connection.type.md
+++ b/docs/en/edge/cordova/connection/connection.type.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,12 +20,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
connection.type
===================
-Checks the active network connection that is being used.
+Checks the currently active network connection.
Description
-----------
-This property is a fast way to determine the device's network connection state, and type of connection.
+This property offers a fast way to determine the device's network
+connection state, and type of connection.
Supported Platforms
-------------------
@@ -106,11 +107,12 @@ Full Example
API Change
----------
-Before Cordova 2.3.0, the Connection object existed at: `navigator.network.connection`.
-To match the spec, this was changed to `navigator.connection` in 2.3.0.
-
-`navigator.network.connection` still exists, but is now deprecated and will be removed in a future release.
+Prior to Cordova 2.3.0, the `Connection` object was accessed via
+`navigator.network.connection`. It was changed to
+`navigator.connection` in 2.3.0 to match the W3C specification. It's
+still available at its original location, but is deprecated and will
+eventually be removed.
iOS Quirks
----------
@@ -121,7 +123,7 @@ iOS Quirks
Bada Quirks
-----------
-- Bada can only detect a WiFi or cellular connection.
+- Bada can only distinguish a WiFi and cellular connection.
- `navigator.connection.type` is set to `Connection.CELL_2G` for all cellular data.
webOS Quirks
[02/46] docs commit: stub
Posted by mw...@apache.org.
stub
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/d33b8879
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/d33b8879
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/d33b8879
Branch: refs/heads/master
Commit: d33b8879d9902b490001c4cc274cfb0efca3104e
Parents: 1cf6a8c
Author: Mike Sierra <le...@gmail.com>
Authored: Wed Apr 24 13:27:38 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Wed Apr 24 13:27:38 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/overview/cli.md | 22 ----------------------
docs/en/edge/guide/overview/primer.md | 22 ++++++++++++++++++++++
docs/en/edge/guide/overview/support.md | 22 ++++++++++++++++++++++
3 files changed, 44 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d33b8879/docs/en/edge/guide/overview/cli.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/cli.md b/docs/en/edge/guide/overview/cli.md
deleted file mode 100644
index 862fb08..0000000
--- a/docs/en/edge/guide/overview/cli.md
+++ /dev/null
@@ -1,22 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-Primer on Command-line Deployment
-=================================
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d33b8879/docs/en/edge/guide/overview/primer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/primer.md b/docs/en/edge/guide/overview/primer.md
new file mode 100644
index 0000000..053572b
--- /dev/null
+++ b/docs/en/edge/guide/overview/primer.md
@@ -0,0 +1,22 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Command-line Deployment Primer
+==============================
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d33b8879/docs/en/edge/guide/overview/support.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/support.md b/docs/en/edge/guide/overview/support.md
new file mode 100644
index 0000000..3ea9cf5
--- /dev/null
+++ b/docs/en/edge/guide/overview/support.md
@@ -0,0 +1,22 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Supported Features
+==================
+
[12/46] docs commit: submenus
Posted by mw...@apache.org.
submenus
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/85730c32
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/85730c32
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/85730c32
Branch: refs/heads/master
Commit: 85730c325103ec553163d1674b7fe578d4d6e8e0
Parents: d0b7494
Author: Mike Sierra <le...@gmail.com>
Authored: Mon Apr 29 13:31:09 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon Apr 29 13:31:09 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/getting-started/bada/index.md | 8 ++++----
docs/en/edge/guide/getting-started/webos/index.md | 2 +-
docs/en/edge/guide/getting-started/windows-8/index.md | 2 +-
3 files changed, 6 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/85730c32/docs/en/edge/guide/getting-started/bada/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/bada/index.md b/docs/en/edge/guide/getting-started/bada/index.md
index 730891e..44bf15f 100644
--- a/docs/en/edge/guide/getting-started/bada/index.md
+++ b/docs/en/edge/guide/getting-started/bada/index.md
@@ -65,22 +65,22 @@ This guide describes how to set up your development environment for Cordova and
5A. Deploy to Simulator
-----------------------
-- **Bada 2.x**: Right-click on your project s folder and select Run As -> bada Emulator Web Application
+- **Bada 2.x**: Right-click on your project's folder and select __Run As → bada Emulator Web Application__
-- **Bada 1.2**: Right-click on your project' folder and select Build configurations -> Set Active -> Simulator-Debug
+- **Bada 1.2**: Right-click on your project' folder and select __Build configurations → Set Active → Simulator-Debug--__
-- Right-click on your project's folder and select Run As -> bada Simulator Application. You need to close the emulator every time you update your app!
+- Right-click on your project's folder and select __Run As → bada Simulator Application__. Note that you need to close the emulator every time you update your app.
5B. Deploy to Device
--------------------
- Make sure your device is properly configured
-**Bada 2.x**: Right-click on your project's folder and select Run As -> bada Target Web Application
+**Bada 2.x**: Right-click on your project's folder and select __Run As → bada Target Web Application__
**Bada 1.2**:
- Right-click on your project's folder and select __Build configurations → Set Active → Target-Debug__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/85730c32/docs/en/edge/guide/getting-started/webos/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/webos/index.md b/docs/en/edge/guide/getting-started/webos/index.md
index 141a3e4..71f9740 100644
--- a/docs/en/edge/guide/getting-started/webos/index.md
+++ b/docs/en/edge/guide/getting-started/webos/index.md
@@ -41,7 +41,7 @@ Video Tutorials:
- Download and install [cygwin SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321) (Windows only). Make sure you select `make` as it is not included by default
- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `webOS` directory.
- Download and install XCode from the [Mac App Store](http://itunes.apple.com/ca/app/xcode/id497799835?mt=12) (OSX only)
-- Download and install Command Line Tools for XCode (OSX only); this can be done by going to XCode's Preferences → Downloads → Components and then click install on Command Line Tools
+- Download and install Command Line Tools for XCode (OSX only); this can be done by going to __Preferences → Downloads → Components__ and then click install on Command Line Tools
3. Set up New Project
--------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/85730c32/docs/en/edge/guide/getting-started/windows-8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/windows-8/index.md b/docs/en/edge/guide/getting-started/windows-8/index.md
index d8face5..d3fd647 100644
--- a/docs/en/edge/guide/getting-started/windows-8/index.md
+++ b/docs/en/edge/guide/getting-started/windows-8/index.md
@@ -53,7 +53,7 @@ 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** 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.
[45/46] docs commit: Merge branch 'mike-sierra/copy_edit' into master.
Posted by mw...@apache.org.
Merge branch 'mike-sierra/copy_edit' into master.
Conflicts:
docs/en/edge/cordova/file/filewriter/filewriter.md
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/459dba09
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/459dba09
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/459dba09
Branch: refs/heads/master
Commit: 459dba096c1c45815eeb4f9aebf054bc3fb31730
Parents: 3e06f38 bf39501
Author: Michael Brooks <mi...@michaelbrooks.ca>
Authored: Wed Jun 12 10:47:59 2013 -0700
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Wed Jun 12 10:47:59 2013 -0700
----------------------------------------------------------------------
.../accelerometer/acceleration/acceleration.md | 16 +-
.../accelerometer/accelerometer.clearWatch.md | 23 +-
.../accelerometer.getCurrentAcceleration.md | 16 +-
.../accelerometer.watchAcceleration.md | 36 +--
.../parameters/accelerometerOptions.md | 2 +-
.../parameters/accelerometerSuccess.md | 2 +-
docs/en/edge/cordova/camera/camera.cleanup.md | 6 +-
.../en/edge/cordova/camera/camera.getPicture.md | 32 +-
.../camera/parameter/CameraPopoverHandle.md | 2 +-
.../camera/parameter/CameraPopoverOptions.md | 38 +--
.../cordova/camera/parameter/cameraError.md | 2 +-
.../cordova/camera/parameter/cameraOptions.md | 24 +-
.../cordova/camera/parameter/cameraSuccess.md | 2 +-
.../edge/cordova/compass/compass.clearWatch.md | 20 +-
.../compass/compass.getCurrentHeading.md | 14 +-
docs/en/edge/cordova/compass/compass.md | 4 +-
.../cordova/compass/compass.watchHeading.md | 26 +-
.../compass/compassError/compassError.md | 6 +-
.../compass/parameters/compassHeading.md | 11 +-
.../compass/parameters/compassOptions.md | 4 +-
.../compass/parameters/compassSuccess.md | 2 +-
.../edge/cordova/connection/connection.type.md | 74 ++---
.../en/edge/cordova/contacts/Contact/contact.md | 202 ++++++-------
.../contacts/ContactAddress/contactaddress.md | 122 ++++----
.../contacts/ContactError/contactError.md | 2 +-
.../contacts/ContactField/contactfield.md | 115 +++----
.../ContactFindOptions/contactfindoptions.md | 62 ++--
.../cordova/contacts/ContactName/contactname.md | 95 +++---
.../ContactOrganization/contactorganization.md | 91 +++---
.../en/edge/cordova/contacts/contacts.create.md | 12 +-
docs/en/edge/cordova/contacts/contacts.find.md | 95 +++---
.../contacts/parameters/contactFindOptions.md | 5 +-
.../contacts/parameters/contactSuccess.md | 2 +-
docs/en/edge/cordova/device/device.cordova.md | 7 +-
docs/en/edge/cordova/device/device.model.md | 11 +-
docs/en/edge/cordova/device/device.name.md | 9 +-
docs/en/edge/cordova/device/device.platform.md | 5 +-
docs/en/edge/cordova/device/device.uuid.md | 7 +-
docs/en/edge/cordova/device/device.version.md | 7 +-
.../en/edge/cordova/events/events.backbutton.md | 19 +-
.../cordova/events/events.batterycritical.md | 36 +--
.../en/edge/cordova/events/events.batterylow.md | 32 +-
.../edge/cordova/events/events.batterystatus.md | 32 +-
.../edge/cordova/events/events.deviceready.md | 25 +-
.../edge/cordova/events/events.endcallbutton.md | 12 +-
.../en/edge/cordova/events/events.menubutton.md | 15 +-
docs/en/edge/cordova/events/events.offline.md | 29 +-
docs/en/edge/cordova/events/events.online.md | 29 +-
docs/en/edge/cordova/events/events.pause.md | 42 +--
docs/en/edge/cordova/events/events.resume.md | 41 ++-
.../edge/cordova/events/events.searchbutton.md | 17 +-
.../cordova/events/events.startcallbutton.md | 17 +-
.../cordova/events/events.volumedownbutton.md | 17 +-
.../cordova/events/events.volumeupbutton.md | 17 +-
.../file/directoryentry/directoryentry.md | 191 ++++++------
.../file/directoryreader/directoryreader.md | 11 +-
docs/en/edge/cordova/file/file.md | 2 +-
.../en/edge/cordova/file/fileentry/fileentry.md | 130 ++++----
.../en/edge/cordova/file/fileerror/fileerror.md | 8 +-
docs/en/edge/cordova/file/fileobj/fileobj.md | 27 +-
.../edge/cordova/file/filereader/filereader.md | 182 +++++------
.../edge/cordova/file/filesystem/filesystem.md | 47 +--
.../cordova/file/filetransfer/filetransfer.md | 159 +++++-----
.../file/filetransfererror/filetransfererror.md | 14 +-
.../file/fileuploadoptions/fileuploadoptions.md | 23 +-
.../file/fileuploadresult/fileuploadresult.md | 14 +-
.../edge/cordova/file/filewriter/filewriter.md | 162 +++++-----
docs/en/edge/cordova/file/flags/flags.md | 8 +-
.../file/localfilesystem/localfilesystem.md | 60 ++--
docs/en/edge/cordova/file/metadata/metadata.md | 20 +-
.../geolocation/Coordinates/coordinates.md | 29 +-
.../cordova/geolocation/Position/position.md | 41 ++-
.../geolocation/PositionError/positionError.md | 19 +-
.../geolocation/geolocation.clearWatch.md | 31 +-
.../geolocation.getCurrentPosition.md | 28 +-
docs/en/edge/cordova/geolocation/geolocation.md | 17 +-
.../geolocation/geolocation.watchPosition.md | 31 +-
.../parameters/geolocation.options.md | 10 +-
.../geolocation/parameters/geolocationError.md | 5 +-
.../parameters/geolocationSuccess.md | 7 +-
.../GlobalizationError/globalizationerror.md | 27 +-
.../globalization/globalization.dateToString.md | 42 +--
.../globalization.getCurrencyPattern.md | 73 +++--
.../globalization/globalization.getDateNames.md | 53 ++--
.../globalization.getDatePattern.md | 59 ++--
.../globalization.getFirstDayOfWeek.md | 31 +-
.../globalization.getLocaleName.md | 26 +-
.../globalization.getNumberPattern.md | 91 +++---
.../globalization.getPreferredLanguage.md | 26 +-
.../globalization.isDayLightSavingsTime.md | 36 ++-
.../edge/cordova/globalization/globalization.md | 6 +-
.../globalization.numberToString.md | 37 ++-
.../globalization/globalization.stringToDate.md | 67 ++--
.../globalization.stringToNumber.md | 43 ++-
.../edge/cordova/inappbrowser/inappbrowser.md | 112 ++++---
.../en/edge/cordova/inappbrowser/window.open.md | 56 ++--
.../edge/cordova/media/MediaError/mediaError.md | 10 +-
.../edge/cordova/media/Parameters/mediaError.md | 5 +-
docs/en/edge/cordova/media/capture/CaptureCB.md | 7 +-
.../edge/cordova/media/capture/CaptureError.md | 12 +-
.../cordova/media/capture/CaptureErrorCB.md | 8 +-
.../cordova/media/capture/ConfigurationData.md | 20 +-
.../media/capture/MediaFile.getFormatData.md | 18 +-
docs/en/edge/cordova/media/capture/MediaFile.md | 12 +-
.../edge/cordova/media/capture/MediaFileData.md | 49 +--
docs/en/edge/cordova/media/capture/capture.md | 19 +-
.../edge/cordova/media/capture/captureAudio.md | 33 +-
.../media/capture/captureAudioOptions.md | 10 +-
.../edge/cordova/media/capture/captureImage.md | 42 ++-
.../media/capture/captureImageOptions.md | 4 +-
.../edge/cordova/media/capture/captureVideo.md | 45 +--
.../media/capture/captureVideoOptions.md | 11 +-
.../cordova/media/media.getCurrentPosition.md | 76 ++---
docs/en/edge/cordova/media/media.getDuration.md | 66 ++--
docs/en/edge/cordova/media/media.md | 46 +--
docs/en/edge/cordova/media/media.pause.md | 45 ++-
docs/en/edge/cordova/media/media.play.md | 83 ++---
docs/en/edge/cordova/media/media.release.md | 52 ++--
docs/en/edge/cordova/media/media.seekTo.md | 96 +++---
docs/en/edge/cordova/media/media.startRecord.md | 25 +-
docs/en/edge/cordova/media/media.stop.md | 36 +--
docs/en/edge/cordova/media/media.stopRecord.md | 20 +-
.../cordova/notification/notification.alert.md | 55 ++--
.../cordova/notification/notification.beep.md | 39 +--
.../notification/notification.confirm.md | 78 ++---
.../edge/cordova/notification/notification.md | 10 +-
.../cordova/notification/notification.prompt.md | 35 +--
.../notification/notification.vibrate.md | 30 +-
.../cordova/splashscreen/splashscreen.hide.md | 17 +-
.../edge/cordova/splashscreen/splashscreen.md | 50 ++-
.../cordova/splashscreen/splashscreen.show.md | 10 +-
.../edge/cordova/storage/database/database.md | 99 +++---
.../storage/localstorage/localstorage.md | 57 ++--
.../cordova/storage/parameters/display_name.md | 2 +-
docs/en/edge/cordova/storage/parameters/name.md | 2 +-
docs/en/edge/cordova/storage/parameters/size.md | 2 +-
.../edge/cordova/storage/sqlerror/sqlerror.md | 5 +-
.../storage/sqlresultset/sqlresultset.md | 30 +-
.../sqlresultsetrowlist/sqlresultsetrowlist.md | 142 ++++-----
.../storage/sqltransaction/sqltransaction.md | 95 +++---
docs/en/edge/cordova/storage/storage.md | 11 +-
.../cordova/storage/storage.opendatabase.md | 17 +-
docs/en/edge/guide/command-line/index.md | 1 +
docs/en/edge/guide/cordova-webview/ios.md | 4 +-
docs/en/edge/guide/getting-started/ios/index.md | 2 +-
.../edge/guide/getting-started/tizen/index.md | 2 +-
.../getting-started/windows-phone-7/index.md | 2 +-
.../getting-started/windows-phone-8/index.md | 1 -
docs/en/edge/guide/overview/support.html | 302 +++++++++++++++++++
.../guide/plugin-development/android/index.md | 2 +-
.../en/edge/guide/upgrading/blackberry/index.md | 2 +-
151 files changed, 3093 insertions(+), 2513 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/459dba09/docs/en/edge/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/file/filewriter/filewriter.md
index eac0a32,75e275b..2269c06
--- a/docs/en/edge/cordova/file/filewriter/filewriter.md
+++ b/docs/en/edge/cordova/file/filewriter/filewriter.md
@@@ -40,20 -42,26 +42,28 @@@ The following property is _not_ support
Methods
-------
- - __abort__: Aborts writing file.
- - __seek__: Moves the file pointer to the byte specified.
- - __truncate__: Shortens the file to the length specified.
+ - __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 with a UTF-8 encoding.
+- __write__: Writes data to the file.
Details
-------
- The `FileWriter` object is a way to write files to the device file system (UTF-8 encoded). Users register their own event listeners to receive the writestart, progress, write, writeend, error and abort events.
+ The `FileWriter` object offers a way to write UTF-8 encoded files to
+ the device file system. Applications respond to `writestart`,
+ `progress`, `write`, `writeend`, `error`, and `abort` events.
- A FileWriter is created for a single file. You can use it to write to a file multiple times. The FileWriter maintains the file's position and length attributes, so you can seek and write anywhere in the file. By default, the FileWriter writes to the beginning of the file (will overwrite existing data). Set the optional append boolean to true in the FileWriter's constructor to begin writing to the end of the file.
+ Each `FileWriter` corresponds to a single file, to which data can be
+ written many times. The `FileWriter` maintains the file's `position`
+ and `length` attributes, which allow the app to `seek` and `write`
+ anywhere in the file. By default, the `FileWriter` writes to the
+ beginning of the file, overwriting existing data. Set the optional
+ `append` boolean to `true` in the `FileWriter`'s constructor to
+ write to the end of the file.
+Text data is supported by all platforms listed below. Text is encoded as UTF-8 before being written to the filesystem. Some platforms also support binary data, which can be passed in as either an ArrayBuffer or a Blob.
+
Supported Platforms
-------------------
@@@ -92,63 -99,38 +106,59 @@@ Truncate Quick Exampl
entry.createWriter(win, fail);
Write Quick Example
- -------------------
+ -------------------
- function win(writer) {
- writer.onwrite = function(evt) {
- console.log("write success");
+ function win(writer) {
+ writer.onwrite = function(evt) {
+ console.log("write success");
};
- writer.write("some sample text");
- };
+ writer.write("some sample text");
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
- var fail = function(evt) {
- console.log(error.code);
- };
-
entry.createWriter(win, fail);
+Binary Write Quick Example
+--------------------------
+
+ function win(writer) {
+ var data = new ArrayBuffer(5),
+ dataView = new Int8Array(data);
+ for (i=0; i < 5; i++) {
+ dataView[i] = i;
+ }
+ writer.onwrite = function(evt) {
+ console.log("write success");
+ };
+ writer.write(data);
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
+
+ entry.createWriter(win, fail);
+
Append Quick Example
- --------------------
+ --------------------
- function win(writer) {
- writer.onwrite = function(evt) {
- console.log("write success");
- };
- writer.seek(writer.length);
- writer.write("appended text");
- };
+ function win(writer) {
+ writer.onwrite = function(evt) {
+ console.log("write success");
+ };
+ writer.seek(writer.length);
+ writer.write("appended text");
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
- var fail = function(evt) {
- console.log(error.code);
- };
-
entry.createWriter(win, fail);
-
+
Abort Quick Example
-------------------
[42/46] docs commit: sanitize code & trim xtra Cordova refs
Posted by mw...@apache.org.
sanitize code & trim xtra Cordova refs
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/f98807e7
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/f98807e7
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/f98807e7
Branch: refs/heads/master
Commit: f98807e77597be662fb95126a04c2d3dd5918874
Parents: 0c0ab55
Author: Mike Sierra <le...@gmail.com>
Authored: Thu May 30 12:06:09 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Thu May 30 12:06:09 2013 -0400
----------------------------------------------------------------------
.../accelerometer/acceleration/acceleration.md | 8 +-
.../accelerometer/accelerometer.clearWatch.md | 26 ++--
.../accelerometer.getCurrentAcceleration.md | 10 +-
.../accelerometer.watchAcceleration.md | 34 ++---
.../en/edge/cordova/camera/camera.getPicture.md | 30 ++--
.../camera/parameter/CameraPopoverOptions.md | 28 ++--
.../edge/cordova/compass/compass.clearWatch.md | 18 +--
.../compass/compass.getCurrentHeading.md | 8 +-
docs/en/edge/cordova/compass/compass.md | 4 +-
.../cordova/compass/compass.watchHeading.md | 22 +--
.../compass/compassError/compassError.md | 4 +-
.../edge/cordova/connection/connection.type.md | 74 +++++-----
.../en/edge/cordova/contacts/Contact/contact.md | 114 +++++++--------
.../contacts/ContactAddress/contactaddress.md | 79 +++++------
.../contacts/ContactField/contactfield.md | 97 ++++++-------
.../ContactFindOptions/contactfindoptions.md | 56 ++++----
.../cordova/contacts/ContactName/contactname.md | 56 ++++----
.../ContactOrganization/contactorganization.md | 62 ++++-----
.../en/edge/cordova/contacts/contacts.create.md | 12 +-
docs/en/edge/cordova/contacts/contacts.find.md | 87 ++++++------
docs/en/edge/cordova/device/device.cordova.md | 6 +-
docs/en/edge/cordova/device/device.model.md | 10 +-
docs/en/edge/cordova/device/device.name.md | 10 +-
docs/en/edge/cordova/device/device.platform.md | 6 +-
docs/en/edge/cordova/device/device.uuid.md | 6 +-
docs/en/edge/cordova/device/device.version.md | 6 +-
.../en/edge/cordova/events/events.backbutton.md | 19 ++-
.../cordova/events/events.batterycritical.md | 28 ++--
.../en/edge/cordova/events/events.batterylow.md | 26 ++--
.../edge/cordova/events/events.batterystatus.md | 26 ++--
.../edge/cordova/events/events.deviceready.md | 25 ++--
.../edge/cordova/events/events.endcallbutton.md | 12 +-
.../en/edge/cordova/events/events.menubutton.md | 12 +-
docs/en/edge/cordova/events/events.offline.md | 14 +-
docs/en/edge/cordova/events/events.online.md | 16 +--
docs/en/edge/cordova/events/events.pause.md | 16 +--
docs/en/edge/cordova/events/events.resume.md | 14 +-
.../edge/cordova/events/events.searchbutton.md | 12 +-
.../cordova/events/events.startcallbutton.md | 12 +-
.../cordova/events/events.volumedownbutton.md | 12 +-
.../cordova/events/events.volumeupbutton.md | 12 +-
.../file/directoryentry/directoryentry.md | 64 ++++-----
.../file/directoryreader/directoryreader.md | 2 +-
.../en/edge/cordova/file/fileentry/fileentry.md | 48 +++----
docs/en/edge/cordova/file/fileobj/fileobj.md | 2 +-
.../edge/cordova/file/filereader/filereader.md | 139 +++++++++----------
.../edge/cordova/file/filesystem/filesystem.md | 38 ++---
.../cordova/file/filetransfer/filetransfer.md | 127 ++++++++---------
.../edge/cordova/file/filewriter/filewriter.md | 120 ++++++++--------
.../file/localfilesystem/localfilesystem.md | 54 +++----
docs/en/edge/cordova/file/metadata/metadata.md | 12 +-
.../geolocation/Coordinates/coordinates.md | 24 ++--
.../cordova/geolocation/Position/position.md | 36 ++---
.../geolocation/geolocation.clearWatch.md | 22 +--
.../geolocation.getCurrentPosition.md | 14 +-
.../geolocation/geolocation.watchPosition.md | 20 +--
.../GlobalizationError/globalizationerror.md | 10 +-
.../globalization/globalization.dateToString.md | 12 +-
.../globalization.getCurrencyPattern.md | 30 ++--
.../globalization/globalization.getDateNames.md | 22 +--
.../globalization.getDatePattern.md | 18 +--
.../globalization.getFirstDayOfWeek.md | 12 +-
.../globalization.getLocaleName.md | 10 +-
.../globalization.getNumberPattern.md | 36 ++---
.../globalization.getPreferredLanguage.md | 10 +-
.../globalization.isDayLightSavingsTime.md | 16 +--
.../globalization.numberToString.md | 16 +--
.../globalization/globalization.stringToDate.md | 18 +--
.../globalization.stringToNumber.md | 16 +--
.../edge/cordova/inappbrowser/inappbrowser.md | 24 ++--
.../en/edge/cordova/inappbrowser/window.open.md | 12 +-
.../edge/cordova/media/capture/captureAudio.md | 8 +-
.../edge/cordova/media/capture/captureImage.md | 10 +-
.../edge/cordova/media/capture/captureVideo.md | 10 +-
.../cordova/media/media.getCurrentPosition.md | 69 ++++-----
docs/en/edge/cordova/media/media.getDuration.md | 64 ++++-----
docs/en/edge/cordova/media/media.pause.md | 44 +++---
docs/en/edge/cordova/media/media.play.md | 50 +++----
docs/en/edge/cordova/media/media.release.md | 44 +++---
docs/en/edge/cordova/media/media.seekTo.md | 88 ++++++------
docs/en/edge/cordova/media/media.startRecord.md | 12 +-
docs/en/edge/cordova/media/media.stop.md | 33 ++---
docs/en/edge/cordova/media/media.stopRecord.md | 15 +-
.../cordova/notification/notification.alert.md | 30 ++--
.../cordova/notification/notification.beep.md | 14 +-
.../notification/notification.confirm.md | 12 +-
.../cordova/notification/notification.prompt.md | 4 +-
.../notification/notification.vibrate.md | 12 +-
.../cordova/splashscreen/splashscreen.hide.md | 8 +-
.../edge/cordova/splashscreen/splashscreen.md | 4 +-
.../cordova/splashscreen/splashscreen.show.md | 8 +-
.../edge/cordova/storage/database/database.md | 90 ++++++------
.../storage/localstorage/localstorage.md | 31 ++---
.../storage/sqlresultset/sqlresultset.md | 4 +-
.../sqlresultsetrowlist/sqlresultsetrowlist.md | 106 +++++++-------
.../storage/sqltransaction/sqltransaction.md | 86 ++++++------
.../cordova/storage/storage.opendatabase.md | 8 +-
docs/en/edge/guide/command-line/index.md | 4 +-
docs/en/edge/guide/cordova-webview/android.md | 10 +-
docs/en/edge/guide/cordova-webview/index.md | 4 +-
docs/en/edge/guide/cordova-webview/ios.md | 8 +-
.../edge/guide/getting-started/android/index.md | 4 +-
.../en/edge/guide/getting-started/bada/index.md | 4 +-
.../guide/getting-started/blackberry/index.md | 4 +-
docs/en/edge/guide/getting-started/index.md | 4 +-
docs/en/edge/guide/getting-started/ios/index.md | 6 +-
.../edge/guide/getting-started/tizen/index.md | 2 +-
.../guide/plugin-development/android/index.md | 2 +-
108 files changed, 1490 insertions(+), 1539 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
index e365106..76cc8d8 100644
--- a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
+++ b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
@@ -33,8 +33,8 @@ Properties
Description
-----------
-This object is created and populated by Cordova, and returned by an
-`Accelerometer` method. Acceleration values include the effect of
+An `Acceleration` object is populated and returned by any of the API's
+`Accelerometer` methods. Acceleration values include the effect of
gravity (9.81 m/s^2), so that when a device lies flat and facing up,
_x_, _y_, and _z_ values returned should be `0`, `0`, and `9.81`.
@@ -77,11 +77,11 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
index 1706433..a32b1c4 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
@@ -41,11 +41,11 @@ Quick Example
-------------
var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
-
+
// ... later on ...
-
+
navigator.accelerometer.clearWatch(watchID);
-
+
Full Example
------------
@@ -59,12 +59,12 @@ Full Example
// The watch id references the current `watchAcceleration`
var watchID = null;
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
startWatch();
@@ -73,13 +73,13 @@ Full Example
// Start watching the acceleration
//
function startWatch() {
-
+
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
-
+
watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
}
-
+
// Stop watching the acceleration
//
function stopWatch() {
@@ -93,9 +93,9 @@ Full Example
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
- 'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
+ element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
+ 'Acceleration Y: ' + acceleration.y + '<br />' +
+ 'Acceleration Z: ' + acceleration.z + '<br />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
@@ -109,6 +109,6 @@ Full Example
</head>
<body>
<div id="accelerometer">Waiting for accelerometer...</div>
- <button onclick="stopWatch();">Stop Watching</button>
+ <button onclick="stopWatch();">Stop Watching</button>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index f65d262..b93a4a3 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -72,16 +72,16 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
}
-
+
// onSuccess: Get a snapshot of the current acceleration
//
function onSuccess(acceleration) {
@@ -90,7 +90,7 @@ Full Example
'Acceleration Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
}
-
+
// onError: Failed to get the acceleration
//
function onError() {
@@ -110,4 +110,4 @@ 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 Cordova `watchAccelerometer` call.
+- Thus, the `getCurrentAcceleration` function yields the last value reported from a `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
index e4cfb48..97510be 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -69,7 +69,7 @@ Quick Example
};
var options = { frequency: 3000 }; // Update every 3 seconds
-
+
var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
Full Example
@@ -85,12 +85,12 @@ Full Example
// The watch id references the current `watchAcceleration`
var watchID = null;
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
startWatch();
@@ -99,13 +99,13 @@ Full Example
// Start watching the acceleration
//
function startWatch() {
-
+
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
-
+
watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
}
-
+
// Stop watching the acceleration
//
function stopWatch() {
@@ -114,14 +114,14 @@ Full Example
watchID = null;
}
}
-
+
// onSuccess: Get a snapshot of the current acceleration
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
- 'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
+ element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
+ 'Acceleration Y: ' + acceleration.y + '<br />' +
+ 'Acceleration Z: ' + acceleration.z + '<br />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
@@ -138,11 +138,11 @@ Full Example
</body>
</html>
- iOS Quirks
+iOS Quirks
-------------
-- Cordova calls the success callback function at the interval
- requested, but restricts the range of requests to the device between
- 40ms and 1000ms. For example, if you request an interval of 3
- seconds, (3000ms), Cordova requests data from the device every 1
- second, but only executes the success callback every 3 seconds.
+The API calls the success callback function at the interval requested,
+but restricts the range of requests to the device between 40ms and
+1000ms. For example, if you request an interval of 3 seconds,
+(3000ms), the API requests data from the device every 1 second, but
+only executes the success callback every 3 seconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.getPicture.md b/docs/en/edge/cordova/camera/camera.getPicture.md
index 3fc21d6..53ff7a7 100644
--- a/docs/en/edge/cordova/camera/camera.getPicture.md
+++ b/docs/en/edge/cordova/camera/camera.getPicture.md
@@ -32,9 +32,9 @@ Description
-----------
The `camera.getPicture` function opens the device's default camera
-application that allows the user to take a picture. This behavior
-occurs by default, when `Camera.sourceType` equals
-`Camera.PictureSourceType.CAMERA`. Once the photo is taken, the
+application that allows users to snap pictures. This behavior occurs
+by default, when `Camera.sourceType` equals
+`Camera.PictureSourceType.CAMERA`. Once the user snaps the photo, the
camera application closes and the application is restored.
If `Camera.sourceType` is `Camera.PictureSourceType.PHOTOLIBRARY` or
@@ -55,7 +55,7 @@ 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)
+- 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
@@ -146,12 +146,12 @@ Full Example
var pictureSource; // picture source
var destinationType; // sets the format of returned value
-
- // Wait for Cordova to connect with the device
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready",onDeviceReady,false);
-
- // Cordova is ready to be used!
+
+ // device APIs are available
//
function onDeviceReady() {
pictureSource=navigator.camera.PictureSourceType;
@@ -163,15 +163,15 @@ Full Example
function onPhotoDataSuccess(imageData) {
// Uncomment to view the base64-encoded image data
// console.log(imageData);
-
+
// Get image handle
//
var smallImage = document.getElementById('smallImage');
-
+
// Unhide image elements
//
smallImage.style.display = 'block';
-
+
// Show the captured photo
// The inline CSS rules are used to resize the image
//
@@ -183,15 +183,15 @@ Full Example
function onPhotoURISuccess(imageURI) {
// Uncomment to view the image file URI
// console.log(imageURI);
-
+
// Get image handle
//
var largeImage = document.getElementById('largeImage');
-
+
// Unhide image elements
//
largeImage.style.display = 'block';
-
+
// Show the captured photo
// The inline CSS rules are used to resize the image
//
@@ -213,7 +213,7 @@ Full Example
navigator.camera.getPicture(onPhotoDataSuccess, onFail, { quality: 20, allowEdit: true,
destinationType: destinationType.DATA_URL });
}
-
+
// A button will call this function
//
function getPhoto(source) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
index c88c544..baff3d1 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
@@ -60,17 +60,21 @@ location.
Quick Example
-------------
- var popover = new CameraPopoverOptions(300,300,100,100,Camera.PopoverArrowDirection.ARROW_ANY);
- var options = { quality: 50, destinationType: Camera.DestinationType.DATA_URL,sourceType: Camera.PictureSource.SAVEDPHOTOALBUM, popoverOptions : popover };
-
+ var popover = new CameraPopoverOptions(300, 300, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY);
+ var options = {
+ quality : 50,
+ destinationType : Camera.DestinationType.DATA_URL,
+ sourceType : Camera.PictureSource.SAVEDPHOTOALBUM,
+ popoverOptions : popover
+ };
+
navigator.camera.getPicture(onSuccess, onFail, options);
-
+
function onSuccess(imageData) {
- var image = document.getElementById('myImage');
- image.src = "data:image/jpeg;base64," + imageData;
- }
-
- function onFail(message) {
- alert('Failed because: ' + message);
- }
-
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+ }
+
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.clearWatch.md b/docs/en/edge/cordova/compass/compass.clearWatch.md
index ee29909..991bd95 100755
--- a/docs/en/edge/cordova/compass/compass.clearWatch.md
+++ b/docs/en/edge/cordova/compass/compass.clearWatch.md
@@ -41,9 +41,9 @@ Quick Example
-------------
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-
+
// ... later on ...
-
+
navigator.compass.clearWatch(watchID);
Full Example
@@ -59,12 +59,12 @@ Full Example
// The watch id references the current `watchHeading`
var watchID = null;
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
startWatch();
@@ -73,13 +73,13 @@ Full Example
// Start watching the compass
//
function startWatch() {
-
+
// Update compass every 3 seconds
var options = { frequency: 3000 };
-
+
watchID = navigator.compass.watchHeading(onSuccess, onError, options);
}
-
+
// Stop watching the compass
//
function stopWatch() {
@@ -88,7 +88,7 @@ Full Example
watchID = null;
}
}
-
+
// onSuccess: Get the current heading
//
function onSuccess(heading) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
index 89fd4b7..a5aef61 100755
--- a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
+++ b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
@@ -69,22 +69,22 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
navigator.compass.getCurrentHeading(onSuccess, onError);
}
-
+
// onSuccess: Get the current heading
//
function onSuccess(heading) {
alert('Heading: ' + heading.magneticHeading);
}
-
+
// onError: Failed to get the heading
//
function onError(compassError) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.md b/docs/en/edge/cordova/compass/compass.md
index d85be8c..4edd5b9 100755
--- a/docs/en/edge/cordova/compass/compass.md
+++ b/docs/en/edge/cordova/compass/compass.md
@@ -28,8 +28,8 @@ Methods
- compass.getCurrentHeading
- compass.watchHeading
- compass.clearWatch
-- compass.watchHeadingFilter (obsolete)
-- compass.clearWatchFilter (obsolete)
+- compass.watchHeadingFilter (obsolete)
+- compass.clearWatchFilter (obsolete)
Arguments
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeading.md b/docs/en/edge/cordova/compass/compass.watchHeading.md
index ae59f8f..323616e 100755
--- a/docs/en/edge/cordova/compass/compass.watchHeading.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeading.md
@@ -60,11 +60,13 @@ Quick Example
};
function onError(compassError) {
- alert('Compass error: ' + compassError.code);
+ alert('Compass error: ' + compassError.code);
};
- var options = { frequency: 3000 }; // Update every 3 seconds
-
+ var options = {
+ frequency: 3000
+ }; // Update every 3 seconds
+
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
Full Example
@@ -80,12 +82,12 @@ Full Example
// The watch id references the current `watchHeading`
var watchID = null;
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
startWatch();
@@ -94,13 +96,13 @@ Full Example
// Start watching the compass
//
function startWatch() {
-
+
// Update compass every 3 seconds
var options = { frequency: 3000 };
-
+
watchID = navigator.compass.watchHeading(onSuccess, onError, options);
}
-
+
// Stop watching the compass
//
function stopWatch() {
@@ -109,7 +111,7 @@ Full Example
watchID = null;
}
}
-
+
// onSuccess: Get the current heading
//
function onSuccess(heading) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compassError/compassError.md b/docs/en/edge/cordova/compass/compassError/compassError.md
index 8862490..0c1769a 100644
--- a/docs/en/edge/cordova/compass/compassError/compassError.md
+++ b/docs/en/edge/cordova/compass/compassError/compassError.md
@@ -35,5 +35,5 @@ Constants
Description
-----------
-The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
-
+When an error occurs, the `CompassError` object is passed as a
+parameter to a `compassError` callback function.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.type.md b/docs/en/edge/cordova/connection/connection.type.md
index 341cf68..ead1586 100644
--- a/docs/en/edge/cordova/connection/connection.type.md
+++ b/docs/en/edge/cordova/connection/connection.type.md
@@ -45,20 +45,20 @@ Quick Example
function checkConnection() {
var networkState = navigator.connection.type;
-
+
var states = {};
- states[Connection.UNKNOWN] = 'Unknown connection';
- states[Connection.ETHERNET] = 'Ethernet connection';
- states[Connection.WIFI] = 'WiFi connection';
- states[Connection.CELL_2G] = 'Cell 2G connection';
- states[Connection.CELL_3G] = 'Cell 3G connection';
- states[Connection.CELL_4G] = 'Cell 4G connection';
- states[Connection.CELL] = 'Cell generic connection';
- states[Connection.NONE] = 'No network connection';
-
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.CELL] = 'Cell generic connection';
+ states[Connection.NONE] = 'No network connection';
+
alert('Connection type: ' + states[networkState]);
}
-
+
checkConnection();
Full Example
@@ -68,36 +68,36 @@ Full Example
<html>
<head>
<title>navigator.connection.type Example</title>
-
+
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is loaded and it is now safe to make calls Cordova methods
+
+ // device APIs are available
//
function onDeviceReady() {
checkConnection();
}
-
- function checkConnection() {
- var networkState = navigator.connection.type;
-
- var states = {};
- states[Connection.UNKNOWN] = 'Unknown connection';
- states[Connection.ETHERNET] = 'Ethernet connection';
- states[Connection.WIFI] = 'WiFi connection';
- states[Connection.CELL_2G] = 'Cell 2G connection';
- states[Connection.CELL_3G] = 'Cell 3G connection';
- states[Connection.CELL_4G] = 'Cell 4G connection';
- states[Connection.CELL] = 'Cell generic connection';
- states[Connection.NONE] = 'No network connection';
-
- alert('Connection type: ' + states[networkState]);
- }
-
+
+ function checkConnection() {
+ var networkState = navigator.connection.type;
+
+ var states = {};
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.CELL] = 'Cell generic connection';
+ states[Connection.NONE] = 'No network connection';
+
+ alert('Connection type: ' + states[networkState]);
+ }
+
</script>
</head>
<body>
@@ -108,10 +108,10 @@ Full Example
API Change
----------
-Prior to Cordova 2.3.0, the `Connection` object was accessed via
-`navigator.network.connection`. It was changed to
-`navigator.connection` in 2.3.0 to match the W3C specification. It's
-still available at its original location, but is deprecated and will
+Until Cordova 2.3.0, the `Connection` object was accessed via
+`navigator.network.connection`, after which it was changed to
+`navigator.connection` to match the W3C specification. It's still
+available at its original location, but is deprecated and will
eventually be removed.
iOS Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/Contact/contact.md b/docs/en/edge/cordova/contacts/Contact/contact.md
index 00d958a..1b49d1f 100644
--- a/docs/en/edge/cordova/contacts/Contact/contact.md
+++ b/docs/en/edge/cordova/contacts/Contact/contact.md
@@ -37,7 +37,7 @@ Properties
- __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 contact's user-defined categories. _(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
@@ -50,7 +50,7 @@ Methods
Details
-------
-The `Contact` object represents a user contact. Contacts can be
+The `Contact` object represents a user's contact. Contacts can be
created, stored, or removed from the device contacts database.
Contacts can also be retrieved (individually or in bulk) from the
database by invoking the `contacts.find` method.
@@ -72,36 +72,36 @@ Supported Platforms
Save Quick Example
------------------
- function onSuccess(contact) {
- alert("Save Success");
- };
+ function onSuccess(contact) {
+ alert("Save Success");
+ };
- function onError(contactError) {
- alert("Error = " + contactError.code);
- };
+ function onError(contactError) {
+ alert("Error = " + contactError.code);
+ };
- // create a new contact object
+ // create a new contact object
var contact = navigator.contacts.create();
- contact.displayName = "Plumber";
- contact.nickname = "Plumber"; //specify both to support all devices
-
- // populate some fields
- var name = new ContactName();
- name.givenName = "Jane";
- name.familyName = "Doe";
- contact.name = name;
-
- // save to device
- contact.save(onSuccess,onError);
+ contact.displayName = "Plumber";
+ contact.nickname = "Plumber"; // specify both to support all devices
+
+ // populate some fields
+ var name = new ContactName();
+ name.givenName = "Jane";
+ name.familyName = "Doe";
+ contact.name = name;
+
+ // save to device
+ contact.save(onSuccess,onError);
Clone Quick Example
-------------------
- // clone the contact object
- var clone = contact.clone();
- clone.name.givenName = "John";
- console.log("Original contact name = " + contact.name.givenName);
- console.log("Cloned contact name = " + clone.name.givenName);
+ // clone the contact object
+ var clone = contact.clone();
+ clone.name.givenName = "John";
+ console.log("Original contact name = " + contact.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
Remove Quick Example
--------------------
@@ -114,8 +114,8 @@ Remove Quick Example
alert("Error = " + contactError.code);
};
- // remove the contact from the device
- contact.remove(onSuccess,onError);
+ // remove the contact from the device
+ contact.remove(onSuccess,onError);
Full Example
------------
@@ -128,57 +128,57 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- // create
- var contact = navigator.contacts.create();
- contact.displayName = "Plumber";
- contact.nickname = "Plumber"; //specify both to support all devices
- var name = new ContactName();
- name.givenName = "Jane";
- name.familyName = "Doe";
- contact.name = name;
-
- // save
- contact.save(onSaveSuccess,onSaveError);
-
- // clone
- var clone = contact.clone();
- clone.name.givenName = "John";
- console.log("Original contact name = " + contact.name.givenName);
- console.log("Cloned contact name = " + clone.name.givenName);
-
- // remove
- contact.remove(onRemoveSuccess,onRemoveError);
+ // create
+ var contact = navigator.contacts.create();
+ contact.displayName = "Plumber";
+ contact.nickname = "Plumber"; // specify both to support all devices
+ var name = new ContactName();
+ name.givenName = "Jane";
+ name.familyName = "Doe";
+ contact.name = name;
+
+ // save
+ contact.save(onSaveSuccess,onSaveError);
+
+ // clone
+ var clone = contact.clone();
+ clone.name.givenName = "John";
+ console.log("Original contact name = " + contact.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
+
+ // remove
+ contact.remove(onRemoveSuccess,onRemoveError);
}
-
+
// onSaveSuccess: Get a snapshot of the current contacts
//
function onSaveSuccess(contact) {
- alert("Save Success");
+ alert("Save Success");
}
-
+
// onSaveError: Failed to get the contacts
//
function onSaveError(contactError) {
- alert("Error = " + contactError.code);
+ alert("Error = " + contactError.code);
}
-
+
// onRemoveSuccess: Get a snapshot of the current contacts
//
function onRemoveSuccess(contacts) {
- alert("Removal Success");
+ alert("Removal Success");
}
-
+
// onRemoveError: Failed to get the contacts
//
function onRemoveError(contactError) {
- alert("Error = " + contactError.code);
+ alert("Error = " + contactError.code);
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
index 124e141..22983e8 100644
--- a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
+++ b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
@@ -53,20 +53,21 @@ Supported Platforms
Quick Example
-------------
- // display the address information for all contacts
+ // display the address information for all contacts
+
function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- for (var j=0; j<contacts[i].addresses.length; j++) {
- alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
- "Type: " + contacts[i].addresses[j].type + "\n" +
- "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
- "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
- "Locality: " + contacts[i].addresses[j].locality + "\n" +
- "Region: " + contacts[i].addresses[j].region + "\n" +
- "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
- "Country: " + contacts[i].addresses[j].country);
- }
- }
+ for (var i = 0; i < contacts.length; i++) {
+ for (var j = 0; j < contacts[i].addresses.length; j++) {
+ alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
+ "Type: " + contacts[i].addresses[j].type + "\n" +
+ "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
+ "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
+ "Locality: " + contacts[i].addresses[j].locality + "\n" +
+ "Region: " + contacts[i].addresses[j].region + "\n" +
+ "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
+ "Country: " + contacts[i].addresses[j].country);
+ }
+ }
};
function onError(contactError) {
@@ -75,8 +76,8 @@ Quick Example
// find all contacts
var options = new ContactFindOptions();
- options.filter="";
- var filter = ["displayName","addresses"];
+ options.filter = "";
+ var filter = ["displayName", "addresses"];
navigator.contacts.find(filter, onSuccess, onError, options);
Full Example
@@ -90,38 +91,38 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- // find all contacts
- var options = new ContactFindOptions();
- options.filter="";
- var filter = ["displayName","addresses"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ // find all contacts
+ var options = new ContactFindOptions();
+ options.filter = "";
+ var filter = ["displayName", "addresses"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
}
-
+
// onSuccess: Get a snapshot of the current contacts
//
- function onSuccess(contacts) {
- // display the address information for all contacts
- for (var i=0; i<contacts.length; i++) {
- for (var j=0; j<contacts[i].addresses.length; j++) {
- alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
- "Type: " + contacts[i].addresses[j].type + "\n" +
- "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
- "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
- "Locality: " + contacts[i].addresses[j].locality + "\n" +
- "Region: " + contacts[i].addresses[j].region + "\n" +
- "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
- "Country: " + contacts[i].addresses[j].country);
- }
- }
- };
-
+ function onSuccess(contacts) {
+ // display the address information for all contacts
+ for (var i = 0; i < contacts.length; i++) {
+ for (var j = 0; j < contacts[i].addresses.length; j++) {
+ alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
+ "Type: " + contacts[i].addresses[j].type + "\n" +
+ "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
+ "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
+ "Locality: " + contacts[i].addresses[j].locality + "\n" +
+ "Region: " + contacts[i].addresses[j].region + "\n" +
+ "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
+ "Country: " + contacts[i].addresses[j].country);
+ }
+ }
+ };
+
// onError: Failed to get the contacts
//
function onError(contactError) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactField/contactfield.md b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
index f14e735..eaf988f 100644
--- a/docs/en/edge/cordova/contacts/ContactField/contactfield.md
+++ b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
@@ -45,10 +45,10 @@ In most instances, there are no pre-determined values for a
number can specify __type__ values of _home_, _work_, _mobile_,
_iPhone_, or any other value that is supported by a particular device
platform's contact database. However, for the `Contact` __photos__
-field, Cordova uses the __type__ field to indicate the format of the
-returned image. Cordova returns a __type__ of __url__ when the
-__value__ attribute contains a URL to the photo image, or _base64_
-when the __value__ contains a base64-encoded image string.
+field, the __type__ field indicates the format of the returned image:
+__url__ when the __value__ attribute contains a URL to the photo
+image, or _base64_ when the __value__ contains a base64-encoded image
+string.
Supported Platforms
-------------------
@@ -63,18 +63,18 @@ Supported Platforms
Quick Example
-------------
- // create a new contact
- var contact = navigator.contacts.create();
-
- // store contact phone numbers in ContactField[]
- var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
- contact.phoneNumbers = phoneNumbers;
-
- // save the contact
- contact.save();
+ // create a new contact
+ var contact = navigator.contacts.create();
+
+ // store contact phone numbers in ContactField[]
+ var phoneNumbers = [];
+ phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
+ phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
+ contact.phoneNumbers = phoneNumbers;
+
+ // save the contact
+ contact.save();
Full Example
------------
@@ -87,46 +87,47 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
+
function onDeviceReady() {
- // create a new contact
- var contact = navigator.contacts.create();
-
- // store contact phone numbers in ContactField[]
- var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
- contact.phoneNumbers = phoneNumbers;
-
- // save the contact
- contact.save();
-
- // search contacts, returning display name and phone numbers
- var options = new ContactFindOptions();
- options.filter="";
- filter = ["displayName","phoneNumbers"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ // create a new contact
+ var contact = navigator.contacts.create();
+
+ // store contact phone numbers in ContactField[]
+ var phoneNumbers = [];
+ phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
+ phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
+ contact.phoneNumbers = phoneNumbers;
+
+ // save the contact
+ contact.save();
+
+ // search contacts, returning display name and phone numbers
+ var options = new ContactFindOptions();
+ options.filter = "";
+ filter = ["displayName", "phoneNumbers"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
}
-
+
// onSuccess: Get a snapshot of the current contacts
//
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- // display phone numbers
- for (var j=0; j<contacts[i].phoneNumbers.length; j++) {
- alert("Type: " + contacts[i].phoneNumbers[j].type + "\n" +
- "Value: " + contacts[i].phoneNumbers[j].value + "\n" +
- "Preferred: " + contacts[i].phoneNumbers[j].pref);
- }
- }
- };
-
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ // display phone numbers
+ for (var j = 0; j < contacts[i].phoneNumbers.length; j++) {
+ alert("Type: " + contacts[i].phoneNumbers[j].type + "\n" +
+ "Value: " + contacts[i].phoneNumbers[j].value + "\n" +
+ "Preferred: " + contacts[i].phoneNumbers[j].pref);
+ }
+ }
+ };
+
// onError: Failed to get the contacts
//
function onError(contactError) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
index 522111a..abdf600 100644
--- a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -41,25 +41,25 @@ Supported Platforms
Quick Example
-------------
- // success callback
+ // success callback
function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- alert(contacts[i].displayName);
- }
+ for (var i=0; i<contacts.length; i++) {
+ alert(contacts[i].displayName);
+ }
};
- // error callback
+ // error callback
function onError(contactError) {
alert('onError!');
};
- // specify contact search criteria
+ // specify contact search criteria
var options = new ContactFindOptions();
- options.filter=""; // empty search string returns all contacts
- options.multiple=true; // return multiple results
- filter = ["displayName"]; // return contact.displayName field
-
- // find contacts
+ options.filter=""; // empty search string returns all contacts
+ options.multiple=true; // return multiple results
+ filter = ["displayName"]; // return contact.displayName field
+
+ // find contacts
navigator.contacts.find(filter, onSuccess, onError, options);
Full Example
@@ -73,31 +73,31 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- // specify contact search criteria
- var options = new ContactFindOptions();
- options.filter=""; // empty search string returns all contacts
- options.multiple=true; // return multiple results
- filter = ["displayName"]; // return contact.displayName field
-
- // find contacts
- navigator.contacts.find(filter, onSuccess, onError, options);
+ // specify contact search criteria
+ var options = new ContactFindOptions();
+ options.filter = ""; // empty search string returns all contacts
+ options.multiple = true; // return multiple results
+ filter = ["displayName"]; // return contact.displayName field
+
+ // find contacts
+ navigator.contacts.find(filter, onSuccess, onError, options);
}
-
+
// onSuccess: Get a snapshot of the current contacts
//
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- alert(contacts[i].displayName);
- }
- };
-
+ function onSuccess(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ alert(contacts[i].displayName);
+ }
+ };
+
// onError: Failed to get the contacts
//
function onError(contactError) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactName/contactname.md b/docs/en/edge/cordova/contacts/ContactName/contactname.md
index 3702ab7..6bae487 100644
--- a/docs/en/edge/cordova/contacts/ContactName/contactname.md
+++ b/docs/en/edge/cordova/contacts/ContactName/contactname.md
@@ -51,14 +51,14 @@ Quick Example
-------------
function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- alert("Formatted: " + contacts[i].name.formatted + "\n" +
- "Family Name: " + contacts[i].name.familyName + "\n" +
- "Given Name: " + contacts[i].name.givenName + "\n" +
- "Middle Name: " + contacts[i].name.middleName + "\n" +
- "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
- "Prefix: " + contacts[i].name.honorificSuffix);
- }
+ for (var i = 0; i < contacts.length; i++) {
+ alert("Formatted: " + contacts[i].name.formatted + "\n" +
+ "Family Name: " + contacts[i].name.familyName + "\n" +
+ "Given Name: " + contacts[i].name.givenName + "\n" +
+ "Middle Name: " + contacts[i].name.middleName + "\n" +
+ "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
+ "Prefix: " + contacts[i].name.honorificSuffix);
+ }
};
function onError(contactError) {
@@ -66,8 +66,8 @@ Quick Example
};
var options = new ContactFindOptions();
- options.filter="";
- filter = ["displayName","name"];
+ options.filter = "";
+ filter = ["displayName", "name"];
navigator.contacts.find(filter, onSuccess, onError, options);
Full Example
@@ -81,32 +81,32 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- var options = new ContactFindOptions();
- options.filter="";
- filter = ["displayName","name"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ var options = new ContactFindOptions();
+ options.filter="";
+ filter = ["displayName","name"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
}
-
+
// onSuccess: Get a snapshot of the current contacts
//
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- alert("Formatted: " + contacts[i].name.formatted + "\n" +
- "Family Name: " + contacts[i].name.familyName + "\n" +
- "Given Name: " + contacts[i].name.givenName + "\n" +
- "Middle Name: " + contacts[i].name.middleName + "\n" +
- "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
- "Prefix: " + contacts[i].name.honorificPrefix);
- }
- };
-
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i ++) {
+ alert("Formatted: " + contacts[i].name.formatted + "\n" +
+ "Family Name: " + contacts[i].name.familyName + "\n" +
+ "Given Name: " + contacts[i].name.givenName + "\n" +
+ "Middle Name: " + contacts[i].name.middleName + "\n" +
+ "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
+ "Prefix: " + contacts[i].name.honorificPrefix);
+ }
+ };
+
// onError: Failed to get the contacts
//
function onError(contactError) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
index 475a2fd..8975667 100644
--- a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
@@ -51,15 +51,15 @@ Quick Example
-------------
function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- for (var j=0; j<contacts[i].organizations.length; j++) {
- alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
- "Type: " + contacts[i].organizations[j].type + "\n" +
- "Name: " + contacts[i].organizations[j].name + "\n" +
- "Department: " + contacts[i].organizations[j].department + "\n" +
- "Title: " + contacts[i].organizations[j].title);
- }
- }
+ for (var i = 0; i < contacts.length; i++) {
+ for (var j = 0; j < contacts[i].organizations.length; j++) {
+ alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
+ "Type: " + contacts[i].organizations[j].type + "\n" +
+ "Name: " + contacts[i].organizations[j].name + "\n" +
+ "Department: " + contacts[i].organizations[j].department + "\n" +
+ "Title: " + contacts[i].organizations[j].title);
+ }
+ }
};
function onError(contactError) {
@@ -67,8 +67,8 @@ Quick Example
};
var options = new ContactFindOptions();
- options.filter="";
- filter = ["displayName","organizations"];
+ options.filter = "";
+ filter = ["displayName", "organizations"];
navigator.contacts.find(filter, onSuccess, onError, options);
Full Example
@@ -82,33 +82,33 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- var options = new ContactFindOptions();
- options.filter="";
- filter = ["displayName","organizations"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ var options = new ContactFindOptions();
+ options.filter="";
+ filter = ["displayName","organizations"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
}
-
+
// onSuccess: Get a snapshot of the current contacts
//
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- for (var j=0; j<contacts[i].organizations.length; j++) {
- alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
- "Type: " + contacts[i].organizations[j].type + "\n" +
- "Name: " + contacts[i].organizations[j].name + "\n" +
- "Department: " + contacts[i].organizations[j].department + "\n" +
- "Title: " + contacts[i].organizations[j].title);
- }
- }
- };
-
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ for (var j = 0; j < contacts[i].organizations.length; j++) {
+ alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
+ "Type: " + contacts[i].organizations[j].type + "\n" +
+ "Name: " + contacts[i].organizations[j].name + "\n" +
+ "Department: " + contacts[i].organizations[j].department + "\n" +
+ "Title: " + contacts[i].organizations[j].title);
+ }
+ }
+ };
+
// onError: Failed to get the contacts
//
function onError(contactError) {
@@ -122,7 +122,7 @@ Full Example
<p>Find Contacts</p>
</body>
</html>
-
+
Android 2.X Quirks
------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.create.md b/docs/en/edge/cordova/contacts/contacts.create.md
index 6552884..54f0558 100644
--- a/docs/en/edge/cordova/contacts/contacts.create.md
+++ b/docs/en/edge/cordova/contacts/contacts.create.md
@@ -57,18 +57,18 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- var myContact = navigator.contacts.create({"displayName": "Test User"});
- myContact.note = "This contact has a note.";
- console.log("The contact, " + myContact.displayName + ", note: " + myContact.note);
+ var myContact = navigator.contacts.create({"displayName": "Test User"});
+ myContact.note = "This contact has a note.";
+ console.log("The contact, " + myContact.displayName + ", note: " + myContact.note);
}
-
+
</script>
</head>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.find.md b/docs/en/edge/cordova/contacts/contacts.find.md
index c6cb70f..fd8ec3e 100644
--- a/docs/en/edge/cordova/contacts/contacts.find.md
+++ b/docs/en/edge/cordova/contacts/contacts.find.md
@@ -76,10 +76,10 @@ Quick Example
};
// find all contacts with 'Bob' in any name field
- var options = new ContactFindOptions();
- options.filter="Bob";
- options.multiple=true;
- var fields = ["displayName", "name"];
+ var options = new ContactFindOptions();
+ options.filter = "Bob";
+ options.multiple = true;
+ var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
Full Example
@@ -87,45 +87,42 @@ Full Example
<!DOCTYPE html>
<html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- // find all contacts with 'Bob' in any name field
- var options = new ContactFindOptions();
- options.filter="Bob";
- var fields = ["displayName", "name"];
- navigator.contacts.find(fields, onSuccess, onError, options);
- }
-
- // onSuccess: Get a snapshot of the current contacts
- //
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- console.log("Display Name = " + contacts[i].displayName);
- }
- }
-
- // onError: Failed to get the contacts
- //
- function onError(contactError) {
- alert('onError!');
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
+ <head>
+ <title>Contact Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+
+ function onDeviceReady() {
+ // find all contacts with 'Bob' in any name field
+ var options = new ContactFindOptions();
+ options.filter = "Bob";
+ var fields = ["displayName", "name"];
+ navigator.contacts.find(fields, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ console.log("Display Name = " + contacts[i].displayName);
+ }
+ }
+
+ // onError: Failed to get the contacts
+
+ function onError(contactError) {
+ alert('onError!');
+ }
+ </script>
+ </head>
+
+ <body>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
+ </body>
</html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.cordova.md b/docs/en/edge/cordova/device/device.cordova.md
index 7156fba..b848ad4 100644
--- a/docs/en/edge/cordova/device/device.cordova.md
+++ b/docs/en/edge/cordova/device/device.cordova.md
@@ -56,15 +56,15 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
+
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/device/device.model.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.model.md b/docs/en/edge/cordova/device/device.model.md
index d1b76c5..abea756 100644
--- a/docs/en/edge/cordova/device/device.model.md
+++ b/docs/en/edge/cordova/device/device.model.md
@@ -64,20 +64,20 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
+
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
'Device UUID: ' + device.uuid + '<br />' +
- 'Device Model: ' + device.model + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
'Device Version: ' + device.version + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.name.md b/docs/en/edge/cordova/device/device.name.md
index f671e8c..00cec23 100644
--- a/docs/en/edge/cordova/device/device.name.md
+++ b/docs/en/edge/cordova/device/device.name.md
@@ -66,20 +66,20 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
+
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
'Device UUID: ' + device.uuid + '<br />' +
- 'Device Model: ' + device.model + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
'Device Version: ' + device.version + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.platform.md b/docs/en/edge/cordova/device/device.platform.md
index 893b02f..5f2baab 100644
--- a/docs/en/edge/cordova/device/device.platform.md
+++ b/docs/en/edge/cordova/device/device.platform.md
@@ -59,15 +59,15 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
+
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.uuid.md b/docs/en/edge/cordova/device/device.uuid.md
index 0f9c073..9eaa7c9 100644
--- a/docs/en/edge/cordova/device/device.uuid.md
+++ b/docs/en/edge/cordova/device/device.uuid.md
@@ -74,15 +74,15 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
+
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.version.md b/docs/en/edge/cordova/device/device.version.md
index 4823491..09aa71c 100644
--- a/docs/en/edge/cordova/device/device.version.md
+++ b/docs/en/edge/cordova/device/device.version.md
@@ -63,15 +63,15 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
+
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.backbutton.md b/docs/en/edge/cordova/events/events.backbutton.md
index 4208187..015472a 100644
--- a/docs/en/edge/cordova/events/events.backbutton.md
+++ b/docs/en/edge/cordova/events/events.backbutton.md
@@ -29,9 +29,9 @@ Details
To override the default back-button behavior, register an event
listener for the `backbutton` event, typically by calling
-`document.addEventListener` once you receive the Cordova `deviceready`
-event. It is no longer necessary to call any other method to override
-the back-button behavior.
+`document.addEventListener` once you receive the `deviceready` event.
+It is no longer necessary to call any other method to override the
+back-button behavior.
Supported Platforms
-------------------
@@ -55,28 +55,25 @@ Full Example
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Back Button Example</title>
+ <title>Back Button Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to call Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
// Register the event listener
document.addEventListener("backbutton", onBackKeyDown, false);
}
-
+
// Handle the back button
//
function onBackKeyDown() {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterycritical.md b/docs/en/edge/cordova/events/events.batterycritical.md
index 5ebea4b..aedf22f 100644
--- a/docs/en/edge/cordova/events/events.batterycritical.md
+++ b/docs/en/edge/cordova/events/events.batterycritical.md
@@ -37,8 +37,8 @@ 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 an event listener once the Cordova `deviceready` event fires.
+Applications typically should use `window.addEventListener` to attach
+an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -55,7 +55,7 @@ Quick Example
function onBatteryCritical(info) {
// Handle the battery critical event
- alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
+ alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
}
Full Example
@@ -64,33 +64,29 @@ Full Example
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Battery Critical Example</title>
+ <title>Battery Critical Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Wait for device API libraries to load
//
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
- window.addEventListener("batterycritical", onBatteryCritical, false);
+ window.addEventListener("batterycritical", onBatteryCritical, false);
}
// Handle the batterycritical event
//
function onBatteryCritical(info) {
- alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
+ alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
}
-
+
</script>
</head>
<body onload="onLoad()">
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterylow.md b/docs/en/edge/cordova/events/events.batterylow.md
index b156454..b65716c 100644
--- a/docs/en/edge/cordova/events/events.batterylow.md
+++ b/docs/en/edge/cordova/events/events.batterylow.md
@@ -37,7 +37,7 @@ properties:
- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
Applications typically should use `document.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -54,7 +54,7 @@ Quick Example
function onBatteryLow(info) {
// Handle the battery low event
- alert("Battery Level Low " + info.level + "%");
+ alert("Battery Level Low " + info.level + "%");
}
Full Example
@@ -63,33 +63,29 @@ Full Example
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Device Ready Example</title>
+ <title>Device Ready Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Wait for device API libraries to load
//
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
- window.addEventListener("batterylow", onBatteryLow, false);
+ window.addEventListener("batterylow", onBatteryLow, false);
}
// Handle the batterylow event
//
function onBatteryLow(info) {
- alert("Battery Level Low " + info.level + "%");
+ alert("Battery Level Low " + info.level + "%");
}
-
+
</script>
</head>
<body onload="onLoad()">
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterystatus.md b/docs/en/edge/cordova/events/events.batterystatus.md
index 728aca2..9619c85 100644
--- a/docs/en/edge/cordova/events/events.batterystatus.md
+++ b/docs/en/edge/cordova/events/events.batterystatus.md
@@ -37,7 +37,7 @@ properties:
- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
Applications typically should use `window.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -62,7 +62,7 @@ Quick Example
function onBatteryStatus(info) {
// Handle the online event
- console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
+ console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
}
Full Example
@@ -71,33 +71,29 @@ Full Example
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Device Ready Example</title>
+ <title>Device Ready Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
+ // Wait for device API libraries to load
//
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
- window.addEventListener("batterystatus", onBatteryStatus, false);
+ window.addEventListener("batterystatus", onBatteryStatus, false);
}
// Handle the batterystatus event
//
function onBatteryStatus(info) {
- console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
+ console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
}
-
+
</script>
</head>
<body onload="onLoad()">
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.deviceready.md b/docs/en/edge/cordova/events/events.deviceready.md
index 663f598..6440d95 100644
--- a/docs/en/edge/cordova/events/events.deviceready.md
+++ b/docs/en/edge/cordova/events/events.deviceready.md
@@ -27,7 +27,8 @@ The event fires when Cordova is fully loaded.
Details
-------
-This is a very important event that every Cordova application should use.
+This event is essential to any application. It signals that Cordova's
+device APIs have loaded and are ready to access.
Cordova consists of two code bases: native and JavaScript. While the
native code loads, a custom loading image displays. However,
@@ -35,10 +36,10 @@ JavaScript only loads once the DOM loads. This means your web
application may potentially call a Cordova JavaScript function before
the corresponding native code is available.
-The Cordova `deviceready` event fires once Cordova has fully loaded.
-After the device has fired, you can safely make calls to Cordova APIs.
-Applications typically attach an event listener with
-`document.addEventListener` once the HTML document's DOM has loaded.
+The `deviceready` event fires once Cordova has fully loaded. Once the
+event fires, you can safely make calls to Cordova APIs. Applications
+typically attach an event listener with `document.addEventListener`
+once the HTML document's DOM has loaded.
The `deviceready` event behaves somewhat differently from others. Any
event handler registered after the `deviceready` event fires has its
@@ -61,7 +62,7 @@ Quick Example
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
- // Now safe to use the Cordova API
+ // Now safe to use device APIs
}
Full Example
@@ -70,25 +71,21 @@ Full Example
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Device Ready Example</title>
+ <title>Device Ready Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
- // Now safe to use the Cordova API
+ // Now safe to use device APIs
}
</script>
[35/46] docs commit: storage
Posted by mw...@apache.org.
storage
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/efd1aa0b
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/efd1aa0b
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/efd1aa0b
Branch: refs/heads/master
Commit: efd1aa0b5c0909c3d2eab4ab5ddccaef7b71fab8
Parents: 44d1cb2
Author: Mike Sierra <le...@gmail.com>
Authored: Sun May 19 16:27:26 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Sun May 19 16:27:26 2013 -0400
----------------------------------------------------------------------
.../edge/cordova/storage/database/database.md | 9 +++--
.../storage/localstorage/localstorage.md | 26 ++++++++------
.../cordova/storage/parameters/display_name.md | 2 +-
docs/en/edge/cordova/storage/parameters/name.md | 2 +-
docs/en/edge/cordova/storage/parameters/size.md | 2 +-
.../edge/cordova/storage/parameters/version.md | 2 +-
.../edge/cordova/storage/sqlerror/sqlerror.md | 5 ++-
.../storage/sqlresultset/sqlresultset.md | 27 ++++++++++----
.../sqlresultsetrowlist/sqlresultsetrowlist.md | 38 +++++++++++---------
.../storage/sqltransaction/sqltransaction.md | 9 ++---
docs/en/edge/cordova/storage/storage.md | 11 ++++--
.../cordova/storage/storage.opendatabase.md | 9 +++--
12 files changed, 84 insertions(+), 58 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/database/database.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/database/database.md b/docs/en/edge/cordova/storage/database/database.md
index 1d56823..7c78481 100644
--- a/docs/en/edge/cordova/storage/database/database.md
+++ b/docs/en/edge/cordova/storage/database/database.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,18 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Database
=======
-Contains methods that allow the user to manipulate the Database
+Provides access to an SQL database.
Methods
-------
- __transaction__: Runs a database transaction.
-- __changeVersion__: method allows scripts to atomically verify the version number and change it at the same time as doing a schema update.
+- __changeVersion__: Allows scripts to automatically verify the version number and change it when updating a schema.
Details
-------
-A Database object is returned from a call to `window.openDatabase()`.
+The `window.openDatabase()` method returns a `Database` object.
Supported Platforms
-------------------
@@ -118,4 +118,3 @@ Full Example
<p>Database</p>
</body>
</html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/localstorage/localstorage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/localstorage/localstorage.md b/docs/en/edge/cordova/storage/localstorage/localstorage.md
index 21ca8ff..3f4fcd6 100644
--- a/docs/en/edge/cordova/storage/localstorage/localstorage.md
+++ b/docs/en/edge/cordova/storage/localstorage/localstorage.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,25 +20,26 @@ 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 a [W3C Storage interface](http://dev.w3.org/html5/webstorage/#the-localstorage-attribute)
var storage = window.localStorage;
Methods
-------
-- __key__: Returns the name of the key at the position specified.
-- __getItem__: Returns the item identified by it's key.
-- __setItem__: Saves and item at the key provided.
-- __removeItem__: Removes the item identified by it's key.
-- __clear__: Removes all of the key value pairs.
+- __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
-----------
-localStorage provides an interface to a W3C Storage interface. It allows one to save data as key-value pairs.
-
-Note: window.sessionStorage provides the same interface, but is cleared between app launches.
+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.
Supported Platforms
-------------------
@@ -117,4 +118,7 @@ Full Example
Windows Phone 7 Quirks
-------------
-- dot notation is _not_ available on Windows Phone 7. Be sure to use : window.localStorage.setItem/getItem, and not the w3 spec defined calls to window.localStorage.someKey = 'someValue';
+Dot notation is _not_ available on Windows Phone 7. Be sure to use
+`setItem` or `getItem`, rather than accessing keys directly from the
+storage object, such as `window.localStorage.someKey`.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/parameters/display_name.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/parameters/display_name.md b/docs/en/edge/cordova/storage/parameters/display_name.md
index 910a980..226a0c6 100644
--- a/docs/en/edge/cordova/storage/parameters/display_name.md
+++ b/docs/en/edge/cordova/storage/parameters/display_name.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/parameters/name.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/parameters/name.md b/docs/en/edge/cordova/storage/parameters/name.md
index f77f967..b1c6a85 100644
--- a/docs/en/edge/cordova/storage/parameters/name.md
+++ b/docs/en/edge/cordova/storage/parameters/name.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/parameters/size.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/parameters/size.md b/docs/en/edge/cordova/storage/parameters/size.md
index fd77dcd..7d9585e 100644
--- a/docs/en/edge/cordova/storage/parameters/size.md
+++ b/docs/en/edge/cordova/storage/parameters/size.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/parameters/version.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/parameters/version.md b/docs/en/edge/cordova/storage/parameters/version.md
index 199cb3b..2e72923 100644
--- a/docs/en/edge/cordova/storage/parameters/version.md
+++ b/docs/en/edge/cordova/storage/parameters/version.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlerror/sqlerror.md b/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
index ee06596..c6bce00 100644
--- a/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
+++ b/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
SQLError
========
-A `SQLError` object is thrown when an error occurs.
+An `SQLError` object is thrown when an error occurs.
Properties
----------
@@ -44,4 +44,3 @@ Description
-----------
The `SQLError` object is thrown when an error occurs when manipulating a database.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
index 6f1d86c..7e9a4ed 100644
--- a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
+++ b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,20 +20,33 @@ license: Licensed to the Apache Software Foundation (ASF) under one
SQLResultSet
=======
-When the `executeSql` method of a `SQLTransaction` is called it
-invokes its callback with a `SQLResultSet`.
+When a `SQLTransaction` object's `executeSql` method is called, the
+specified callback executes with a `SQLResultSet` parameter.
Properties
-------
-- __insertId__: the row ID of the row that the SQLResultSet object's SQL statement inserted into the database
-- __rowsAffected__: the number of rows that were changed by the SQL statement. If the statement did not affect any rows then it is set to 0.
-- __rows__: a SQLResultSetRowList representing the rows returned. If no rows are returned the object will be empty.
+- __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
-------
-When you call the SQLTransaction executeSql method its callback methods is passed a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowsAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.
+When a `SQLTransaction` object's `executeSql` method is called, the
+specified callback executes with a `SQLResultSet` parameter containing
+three properties:
+
+* The `insertId` returns the row number of a successly SQL insertion
+ statement. If the SQL does not insert any rows, the `insertId` is
+ not set.
+
+* The `rowsAffected` is always `0` for a SQL `select` statement. For
+ `insert` or `update` statements it returns the number of modified
+ rows.
+
+* The final `SQLResultSetList` contains the data returned from a SQL
+ select statement.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
index 37587f2..f9ae524 100644
--- a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
+++ b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,12 +20,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
SQLResultSetRowList
=======
-One of the properties of the SQLResultSet containing the rows returned from a SQL query.
+One of the properties of the `SQLResultSet` containing the rows
+returned from a SQL query.
Properties
-------
-- __length__: the number of rows returned by the SQL query
+- __length__: the number of rows returned by the SQL query.
Methods
-------
@@ -35,7 +36,12 @@ Methods
Details
-------
-The SQLResultSetRowList contains the data returned from a SQL select statement. The object contains a length property letting you know how many rows the select statement has been returned. To get a row of data you would call the `item` method specifying an index. The item method returns a JavaScript Object who's properties are the columns of the database the select statement was executed against.
+The `SQLResultSetRowList` contains the data returned from a SQL
+`select` statement. The object contains a `length` property
+indicating how many rows the `select` statement returns. To get a row
+of data, call the `item` method to specify an index. It returns a
+JavaScript `Object` whose properties are the database columns the
+`select` statement was executed against.
Supported Platforms
-------------------
@@ -49,18 +55,18 @@ Supported Platforms
Execute SQL Quick Example
------------------
- function queryDB(tx) {
- tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
- }
-
- function querySuccess(tx, results) {
- var len = results.rows.length;
- console.log("DEMO table: " + len + " rows found.");
- for (var i=0; i<len; i++){
- console.log("Row = " + i + " ID = " + results.rows.item(i).id + " Data = " + results.rows.item(i).data);
- }
- }
-
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ function querySuccess(tx, results) {
+ var len = results.rows.length;
+ console.log("DEMO table: " + len + " rows found.");
+ for (var i=0; i<len; i++){
+ console.log("Row = " + i + " ID = " + results.rows.item(i).id + " Data = " + results.rows.item(i).data);
+ }
+ }
+
function errorCB(err) {
alert("Error processing SQL: "+err.code);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
index ea61b30..9ba2836 100644
--- a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
+++ b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,17 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
SQLTransaction
=======
-Contains methods that allow the user to execute SQL statements against the Database.
+Allows execution of SQL statements against the Database.
Methods
-------
-- __executeSql__: executes a SQL statement
+- __executeSql__: executes a SQL statement.
Details
-------
-When you call a Database objects transaction method, its callback method is passed a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
+Calling a `Database` object's transaction method, passes a
+`SQLTransaction` object to the specified callback method.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/storage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/storage.md b/docs/en/edge/cordova/storage/storage.md
index cd679b2..c4d7a47 100644
--- a/docs/en/edge/cordova/storage/storage.md
+++ b/docs/en/edge/cordova/storage/storage.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,9 +20,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Storage
==========
-> Provides access to the devices storage options.
+> 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 this spec. For those devices, the built-in support is used instead of replacing it with Cordova's implementation. For devices that don't have storage support, Cordova's implementation should be compatible with the W3C specification.
+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.
Methods
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/efd1aa0b/docs/en/edge/cordova/storage/storage.opendatabase.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/storage.opendatabase.md b/docs/en/edge/cordova/storage/storage.opendatabase.md
index 9d3d19a..399a79a 100644
--- a/docs/en/edge/cordova/storage/storage.opendatabase.md
+++ b/docs/en/edge/cordova/storage/storage.opendatabase.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,16 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
openDatabase
===============
-Returns a new Database object.
+Returns a new `Database` object.
var dbShell = window.openDatabase(database_name, database_version, database_displayname, database_size);
Description
-----------
-window.openDatabase returns a new Database object.
-
-This method will create a new SQL Lite Database and return a Database object. Use the Database Object to manipulate the data.
+The method creates a new SQL Lite Database and returns a `Database`
+object that allows manipulation of the data.
Supported Platforms
-------------------
[20/46] docs commit: edits up to pause event
Posted by mw...@apache.org.
edits up to pause event
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/909bb286
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/909bb286
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/909bb286
Branch: refs/heads/master
Commit: 909bb286019838a559de6489e99f4a56e5cc7698
Parents: 6899777
Author: Mike Sierra <le...@gmail.com>
Authored: Wed May 15 12:58:05 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Wed May 15 12:58:05 2013 -0400
----------------------------------------------------------------------
docs/en/edge/cordova/events/events.backbutton.md | 2 +-
docs/en/edge/cordova/events/events.menubutton.md | 5 ++---
docs/en/edge/cordova/events/events.offline.md | 13 +++++++------
docs/en/edge/cordova/events/events.online.md | 14 ++++++++------
docs/en/edge/cordova/events/events.pause.md | 4 +++-
docs/en/edge/cordova/events/events.searchbutton.md | 2 +-
docs/en/edge/cordova/events/events.startcallbutton.md | 2 +-
.../en/edge/cordova/events/events.volumedownbutton.md | 2 +-
docs/en/edge/cordova/events/events.volumeupbutton.md | 3 ++-
.../cordova/file/directoryentry/directoryentry.md | 2 +-
docs/en/edge/cordova/file/fileentry/fileentry.md | 2 +-
docs/en/edge/cordova/file/filereader/filereader.md | 2 +-
docs/en/edge/cordova/file/filewriter/filewriter.md | 2 +-
.../edge/cordova/storage/localstorage/localstorage.md | 2 +-
14 files changed, 31 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.backbutton.md b/docs/en/edge/cordova/events/events.backbutton.md
index 2041c96..46e6d84 100644
--- a/docs/en/edge/cordova/events/events.backbutton.md
+++ b/docs/en/edge/cordova/events/events.backbutton.md
@@ -31,7 +31,7 @@ To override the default back-button behavior, register an event
listener for the `backbutton` event, typically by calling
`document.addEventListener` once you receive the Cordova `deviceready`
event. It is no longer necessary to call any other method to override
-the back-button behaviour.
+the back-button behavior.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.menubutton.md b/docs/en/edge/cordova/events/events.menubutton.md
index 3f47e4f..661502f 100644
--- a/docs/en/edge/cordova/events/events.menubutton.md
+++ b/docs/en/edge/cordova/events/events.menubutton.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -27,8 +27,7 @@ The event fires when the user presses the menu button.
Details
-------
-If you need to override the default menu button behaviour you can
-register an event listener for the 'menubutton' event.
+Applying an event handler overrides the default menu button behavior.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.offline.md b/docs/en/edge/cordova/events/events.offline.md
index 19f47e5..62d41cb 100644
--- a/docs/en/edge/cordova/events/events.offline.md
+++ b/docs/en/edge/cordova/events/events.offline.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,14 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
offline
===========
-This event fires when a Cordova application is offline (not connected to the Internet).
+The event fires when an application goes offline, and the device is
+not connected to the Internet.
document.addEventListener("offline", yourCallbackFunction, false);
Details
-------
-When the application's network connection changes to being offline, the offline event is fired.
+The event fires when the network connection is lost.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
@@ -91,12 +92,12 @@ Full Example
iOS Quirks
--------------------------
-During initial startup, the first offline event (if applicable) will take at least a second to fire.
+During initial startup, the first offline event (if applicable) takes at least a second to fire.
Windows Phone 7 Quirks
--------------------------
-When running in the Emulator, the connection.status of the device is always unknown, and this event will NOT fire.
+When running in the Emulator, the `connection.status` is always unknown, so this event does _not_ fire.
Windows Phone 8 Quirks
--------------------------
-Emulator reports connection type as Cellular, and it will not change, so events will NOT fire.
+The Emulator reports the connection type as `Cellular`, which does not change, so the event does _not_ fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.online.md b/docs/en/edge/cordova/events/events.online.md
index 20c4b52..7c49990 100644
--- a/docs/en/edge/cordova/events/events.online.md
+++ b/docs/en/edge/cordova/events/events.online.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,14 +20,16 @@ license: Licensed to the Apache Software Foundation (ASF) under one
online
===========
-This event fires when a Cordova application is online (connected to the Internet).
+This event fires when a Cordova application goes online, and the
+device becomes connected to the Internet.
document.addEventListener("online", yourCallbackFunction, false);
Details
-------
-When the application's network connection changes to being online, the online event is fired.
+When the application's network connection changes to being online, the
+online event is fired.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
@@ -91,12 +93,12 @@ Full Example
iOS Quirks
--------------------------
-During initial startup, the first online event (if applicable) will take at least a second to fire.
+During initial startup, the first `online` event (if applicable) takes at least a second to fire.
Windows Phone 7 Quirks
--------------------------
-When running in the Emulator, the connection.status of the device is always unknown, and this event will NOT fire.
+When running in the Emulator, the `connection.status` is always unknown, so this event will _not_ fire.
Windows Phone 8 Quirks
--------------------------
-Emulator reports connection type as Cellular, and it will not change, so events will NOT fire.
+The Emulator reports the connection type as `Cellular`, which does not change, so events will _not_ fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.pause.md b/docs/en/edge/cordova/events/events.pause.md
index c30f847..3a5604d 100644
--- a/docs/en/edge/cordova/events/events.pause.md
+++ b/docs/en/edge/cordova/events/events.pause.md
@@ -27,7 +27,9 @@ This event fires when a Cordova application is put into the background.
Details
-------
-Cordova consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired.
+Cordova consists of two code bases: native and JavaScript. When the
+native code puts the application into the background, the pause event
+fires.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.searchbutton.md b/docs/en/edge/cordova/events/events.searchbutton.md
index ba6cfe6..12b09b8 100644
--- a/docs/en/edge/cordova/events/events.searchbutton.md
+++ b/docs/en/edge/cordova/events/events.searchbutton.md
@@ -27,7 +27,7 @@ This event fires when the user presses the search button on Android.
Details
-------
-If you need to override the default search button behaviour on Android you can register an event listener for the 'searchbutton' event.
+If you need to override the default search button behavior on Android you can register an event listener for the 'searchbutton' event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.startcallbutton.md b/docs/en/edge/cordova/events/events.startcallbutton.md
index 8369aeb..ca6ac46 100644
--- a/docs/en/edge/cordova/events/events.startcallbutton.md
+++ b/docs/en/edge/cordova/events/events.startcallbutton.md
@@ -27,7 +27,7 @@ This event fires when the user presses the start call button.
Details
-------
-If you need to override the default start call behaviour you can register an event listener for the 'startcallbutton' event.
+If you need to override the default start call behavior you can register an event listener for the 'startcallbutton' event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumedownbutton.md b/docs/en/edge/cordova/events/events.volumedownbutton.md
index 46a151d..09c9d64 100644
--- a/docs/en/edge/cordova/events/events.volumedownbutton.md
+++ b/docs/en/edge/cordova/events/events.volumedownbutton.md
@@ -27,7 +27,7 @@ This event fires when the user presses the volume down button.
Details
-------
-If you need to override the default volume down behaviour you can register an event listener for the 'volumedownbutton' event.
+If you need to override the default volume down behavior you can register an event listener for the 'volumedownbutton' event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumeupbutton.md b/docs/en/edge/cordova/events/events.volumeupbutton.md
index afac44e..1016303 100644
--- a/docs/en/edge/cordova/events/events.volumeupbutton.md
+++ b/docs/en/edge/cordova/events/events.volumeupbutton.md
@@ -27,7 +27,8 @@ This event fires when the user presses the volume up button.
Details
-------
-If you need to override the default volume up behaviour you can register an event listener for the 'volumeupbutton' event.
+If you need to override the default volume up behavior you can
+register an event listener for the 'volumeupbutton' event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index 24d2967..b7d4da8 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -109,7 +109,7 @@ __Quick Example__
entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
__iOS Quirk__
-- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to NOT enable the directory to be backed up by iCloud. Set the value to **0** to re-enable the directory to be backed up by iCloud.
+- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to _not_ enable the directory to be backed up by iCloud. Set the value to **0** to re-enable the directory to be backed up by iCloud.
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileentry/fileentry.md b/docs/en/edge/cordova/file/fileentry/fileentry.md
index b329d0c..b67bee2 100644
--- a/docs/en/edge/cordova/file/fileentry/fileentry.md
+++ b/docs/en/edge/cordova/file/fileentry/fileentry.md
@@ -105,7 +105,7 @@ __Quick Example__
entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
__iOS Quirk__
-- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to NOT enable the file to be backed up by iCloud. Set the value to **0** to re-enable the file to be backed up by iCloud.
+- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to _not_ enable the file to be backed up by iCloud. Set the value to **0** to re-enable the file to be backed up by iCloud.
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filereader/filereader.md b/docs/en/edge/cordova/file/filereader/filereader.md
index b06976c..3d44f20 100644
--- a/docs/en/edge/cordova/file/filereader/filereader.md
+++ b/docs/en/edge/cordova/file/filereader/filereader.md
@@ -29,7 +29,7 @@ Properties
- __result:__ The contents of the file that has been read. _(DOMString)_
- __error:__ An object containing errors. _(FileError)_
- __onloadstart:__ Called when the read starts. . _(Function)_
-- __onprogress:__ Called while reading the file, reports progress (progess.loaded/progress.total). _(Function)_ -NOT SUPPORTED
+- __onprogress:__ Called while reading the file, reports progress (progess.loaded/progress.total). _(Function)_ -_not_ SUPPORTED
- __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)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filewriter/filewriter.md b/docs/en/edge/cordova/file/filewriter/filewriter.md
index 704347b..fd62f5f 100644
--- a/docs/en/edge/cordova/file/filewriter/filewriter.md
+++ b/docs/en/edge/cordova/file/filewriter/filewriter.md
@@ -31,7 +31,7 @@ Properties
- __position:__ The current position of the file pointer. _(long)_
- __error:__ An object containing errors. _(FileError)_
- __onwritestart:__ Called when the write starts. . _(Function)_
-- __onprogress:__ Called while writing the file, reports progress (progress.loaded/progress.total). _(Function)_ -NOT SUPPORTED
+- __onprogress:__ Called while writing the file, reports progress (progress.loaded/progress.total). _(Function)_ -_not_ SUPPORTED
- __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)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/storage/localstorage/localstorage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/localstorage/localstorage.md b/docs/en/edge/cordova/storage/localstorage/localstorage.md
index 837302b..df95ad2 100644
--- a/docs/en/edge/cordova/storage/localstorage/localstorage.md
+++ b/docs/en/edge/cordova/storage/localstorage/localstorage.md
@@ -117,4 +117,4 @@ Full Example
Windows Phone 7 Quirks
-------------
-- dot notation is NOT available on Windows Phone 7. Be sure to use : window.localStorage.setItem/getItem, and not the w3 spec defined calls to window.localStorage.someKey = 'someValue';
+- dot notation is _not_ available on Windows Phone 7. Be sure to use : window.localStorage.setItem/getItem, and not the w3 spec defined calls to window.localStorage.someKey = 'someValue';
[28/46] docs commit: amidst globalization api
Posted by mw...@apache.org.
amidst globalization api
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/9dcee9b2
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/9dcee9b2
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/9dcee9b2
Branch: refs/heads/master
Commit: 9dcee9b22c1033dd3ff41cba1eacc960ac30ffbe
Parents: e2d7868
Author: Mike Sierra <le...@gmail.com>
Authored: Fri May 17 09:34:07 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Fri May 17 09:34:07 2013 -0400
----------------------------------------------------------------------
.../file/filetransfererror/filetransfererror.md | 8 ++--
.../file/fileuploadoptions/fileuploadoptions.md | 2 +-
.../globalization.getCurrencyPattern.md | 44 +++++++++++---------
.../globalization/globalization.getDateNames.md | 4 +-
.../globalization.getDatePattern.md | 14 +++----
.../globalization.getFirstDayOfWeek.md | 4 +-
.../globalization.getLocaleName.md | 4 +-
.../globalization.getNumberPattern.md | 22 +++++-----
.../globalization.getPreferredLanguage.md | 4 +-
.../globalization.isDayLightSavingsTime.md | 2 +-
.../globalization.numberToString.md | 4 +-
.../globalization/globalization.stringToDate.md | 18 ++++----
.../globalization.stringToNumber.md | 4 +-
13 files changed, 70 insertions(+), 64 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md b/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
index 6f23f8d..abb135f 100644
--- a/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
+++ b/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
@@ -25,10 +25,10 @@ A `FileTransferError` object is passed to an error callback when an error occurs
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)
+- __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/9dcee9b2/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
index b9e8c83..e0e6fe2 100644
--- a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -44,4 +44,4 @@ upload script.
WP7 Quirk
---------
-- __chunkedMode:__ Ignored on WP7.
+- __chunkedMode:__: Ignored on WP7.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
index 968a940..724c43c 100644
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@ -29,18 +29,22 @@ Description
-----------
Returns the pattern to the `successCallback` with a `properties` object
-as a parameter. That object should have the following properties:
+as a parameter. That object should contain the following properties:
-- __pattern__ {String}: The currency pattern for formatting and parsing currency values. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
-- __code__ {String}: The ISO 4217 currency code for the pattern.
-- __fraction__ {Number}: The number of fractional digits to use when parsing and formatting currency.
-- __rounding__ {Number}: The rounding increment to use when parsing and formatting.
-- __decimal__: {String}: The decimal symbol to use for parsing and formatting.
-- __grouping__: {String}: The grouping symbol to use for parsing and formatting.
+- __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 the ISO 4217 currency codes, for example 'USD'.
+The inbound `currencyCode` parameter should be a `String` of one of
+the ISO 4217 currency codes, for example 'USD'.
-If there is an error obtaining the pattern, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+If there is an error obtaining the pattern, then the `errorCallback`
+is invoked with a `GlobalizationError` object as a parameter. The
+expected code for this error is
+`GlobalizationError.FORMATTING\_ERROR`.
Supported Platforms
-------------------
@@ -52,16 +56,9 @@ Supported Platforms
Quick Example
-------------
-In the case when the browser is set to the en\_US locale and the selected currency is United States Dollars, this should display a popup dialog with text similar to:
-
- pattern: $#,##0.##;($#,##0.##)
- code: USD
- fraction: 2
- rounding: 0
- decimal: .
- grouping: ,
-
-.
+When the browser is set to the `en\_US` locale and the selected currency
+is United States Dollars, this example should display a popup dialog with text
+similar to the results that follow:
navigator.globalization.getCurrencyPattern(
'USD',
@@ -74,6 +71,15 @@ In the case when the browser is set to the en\_US locale and the selected curren
function () {alert('Error getting pattern\n');}
);
+Expected result:
+
+ pattern: $#,##0.##;($#,##0.##)
+ code: USD
+ fraction: 2
+ rounding: 0
+ decimal: .
+ grouping: ,
+
Full Example
------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDateNames.md b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
index fceaf64..70b7552 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -29,7 +29,7 @@ Description
It returns the array of names to the `successCallback` with a properties object as a parameter. That object should have a `value` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
-If there is an error obtaining the names, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error obtaining the names, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
`options.type` can be 'narrow', or 'wide'.
`options.item` can be 'months', or 'days'.
@@ -48,7 +48,7 @@ Supported Platforms
Quick Example
-------------
-In the case when the browser is set to the en\_US locale, this should display a series of 12 popup dialogs, one per month, with text similar to "month: January"
+When the browser is set to the en\_US locale, this should display a series of 12 popup dialogs, one per month, with text similar to "month: January"
navigator.globalization.getDateNames(
function (names) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
index 03ae3c7..2662634 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.getDatePattern
===========
-Returns a pattern string for formatting and parsing dates according to the client's user preferences.
+Returns a pattern string to format and parse dates according to the client's user preferences.
navigator.globalization.getDatePattern(successCallback, errorCallback, options);
@@ -29,12 +29,12 @@ Description
It returns the pattern to the `successCallback` with a properties object as a parameter. That object should have the following properties:
-- pattern {String}: The date and time pattern for formatting and parsing dates. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
-- timezone {String}: The abbreviated name of the time zone on the client
-- utc\_offset {Number}: The current difference in seconds between the client's time zone and coordinated universal time.
-- dst\_offset {Number}: 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.
+- __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, then the `errorCallback` is invokedwith a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR.
+If there is an error obtaining the pattern, then the `errorCallback` is invokedwith a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PATTERN\_ERROR`.
`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
`options.selector` can be 'date', 'time' or 'date and time'.
@@ -53,7 +53,7 @@ Supported Platforms
Quick Example
-------------
-In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "pattern: M/d/yyyy h:mm a".
+When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "pattern: M/d/yyyy h:mm a".
function checkDatePattern() {
navigator.globalization.getDatePattern(
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
index 84b23eb..ff8856a 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -29,7 +29,7 @@ Description
The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a Number value.
-If there is an error obtaining the pattern, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error obtaining the pattern, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
@@ -42,7 +42,7 @@ Supported Platforms
Quick Example
-------------
-In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "day: 1".
+When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "day: 1".
navigator.globalization.getFirstDayOfWeek(
function (day) {alert('day: ' + day.value + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
index 6f23bc6..952b153 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -31,7 +31,7 @@ Description
It returns the locale identifier string to the `successCallback` with a
properties object as a parameter. That object should have a `value` property with a String value.
-If there is an error getting the locale, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error getting the locale, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
Quick Example
-------------
-In the case when the browser is set to the en\_US locale, this should display a popup dialog with the text "locale: en\_US".
+When the browser is set to the en\_US locale, this should display a popup dialog with the text "locale: en\_US".
navigator.globalization.getLocaleName(
function (locale) {alert('locale: ' + locale.value + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
index 0af8331..56bcc6f 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.getNumberPattern
===========
-Returns a pattern string for formatting and parsing numbers according to the client's user preferences.
+Returns a pattern string to format and parse numbers according to the client's user preferences.
navigator.globalization.getNumberPattern(successCallback, errorCallback, options);
@@ -29,16 +29,16 @@ Description
It returns the pattern to the `successCallback` with a properties object as a parameter. That object should have the following properties:
-- pattern {String}: The number pattern for formatting and parsing numbers. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
-- symbol {String}: The symbol to be used when formatting and parsing e.g., percent or currency symbol.
-- fraction {Number}: The number of fractional digits to use when parsing and formatting numbers.
-- rounding {Number}: The rounding increment to use when parsing and formatting.
-- positive {String}: The symbol to use for positive numbers when parsing and formatting.
-- negative: {String}: The symbol to use for negative numbers when parsing and formatting.
-- decimal: {String}: The decimal symbol to use for parsing and formatting.
-- grouping: {String}: The grouping symbol to use for parsing and formatting.
+- __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 be used when formatting and parsing e.g., 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` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR.
+If there is an error obtaining the pattern, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PATTERN\_ERROR`.
`options.type` can be 'decimal', 'percent', or 'currency'.
The default options are `{type:'decimal'}`. The `options` parameter is optional.
@@ -54,7 +54,7 @@ Supported Platforms
Quick Example
-------------
-In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to:
+When the browser is set to the en\_US locale, this should display a popup dialog with text similar to:
pattern: #,##0.###
symbol: .
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
index a92a9b3..a436f9f 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -31,7 +31,7 @@ Description
It returns the language identifier string to the `successCallback` with a
properties object as a parameter. That object should have a `value` property with a String value.
-If there is an error getting the language, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error getting the language, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
Quick Example
-------------
-In the case when the browser is set to the en\_US locale, this should display a popup dialog with the text "language: English".
+When the browser is set to the en\_US locale, this should display a popup dialog with the text "language: English".
navigator.globalization.getPreferredLanguage(
function (language) {alert('language: ' + language.value + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
index 5d2b701..e01b226 100644
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -31,7 +31,7 @@ It returns whether or not daylight savings time is in effect to the `successCall
The inbound parameter `date` should be of type `Date`.
-If there is an error reading the date, then the `errorCallback` is invoked. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error reading the date, then the `errorCallback` is invoked. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.numberToString.md b/docs/en/edge/cordova/globalization/globalization.numberToString.md
index 74e6ce9..ed61012 100644
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.numberToString.md
@@ -29,7 +29,7 @@ Description
It returns the formatted number string to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a String value.
-If there is an error formatting the number, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+If there is an error formatting the number, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.FORMATTING\_ERROR`.
`options.type` can be 'decimal', 'percent', or 'currency'. The default options are `{type:'decimal'}`. The `options` parameter is optional.
@@ -44,7 +44,7 @@ Supported Platforms
Quick Example
-------------
-In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 3.142"
+When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 3.142"
navigator.globalization.numberToString(
3.1415926,
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToDate.md b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
index 6849d0a..29d8e39 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
@@ -31,13 +31,13 @@ Description
It returns the date to the success callback with a properties object as a parameter. That object should have the following properties:
-- year {Number}: The four digit year
-- month {Number}: The month from (0 - 11)
-- day {Number}: The day from (1 - 31)
-- hour {Number}: The hour from (0 - 23)
-- minute {Number}: The minute from (0 - 59)
-- second {Number}: The second from (0 - 59)
-- millisecond {Number}: The milliseconds (from 0 - 999), not available on all platforms
+- __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)_
The inbound `dateString` parameter should be of type `String`.
@@ -47,7 +47,7 @@ The inbound `dateString` parameter should be of type `String`.
The default options are `{formatLength:'short', selector:'date and time'}`.
The options parameter is optional.
-If there is an error parsing the date string, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
+If there is an error parsing the date string, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PARSING\_ERROR`.
Supported Platforms
-------------------
@@ -60,7 +60,7 @@ Supported Platforms
Quick Example
-------------
-In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "month:8 day:25 year:2012". Note that the month integer is one less than the string, as the month integer represents an index.
+When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "month:8 day:25 year:2012". Note that the month integer is one less than the string, as the month integer represents an index.
navigator.globalization.stringToDate(
'9/25/2012',
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9dcee9b2/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
index 7928e6c..d6ecb19 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
@@ -29,7 +29,7 @@ Description
It returns the number to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a Number value.
-If there is an error parsing the number string, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
+If there is an error parsing the number string, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PARSING\_ERROR`.
`options.type` can be 'decimal', 'percent', or 'currency'.
The default options are `{type:'decimal'}`. The `options` parameter is optional.
@@ -45,7 +45,7 @@ Supported Platforms
Quick Example
-------------
-In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 1234.56".
+When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 1234.56".
navigator.globalization.stringToNumber(
'1234.56',
[15/46] docs commit: removed links to blank upgrading pages
Posted by mw...@apache.org.
removed links to blank upgrading pages
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/bfc9025f
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/bfc9025f
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/bfc9025f
Branch: refs/heads/master
Commit: bfc9025f37913c1add25291a23e92c31a6553fa3
Parents: 918cf22
Author: Mike Sierra <le...@gmail.com>
Authored: Mon May 13 15:15:33 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon May 13 15:15:33 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/upgrading/index.md | 2 --
1 file changed, 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bfc9025f/docs/en/edge/guide/upgrading/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/index.md b/docs/en/edge/guide/upgrading/index.md
index 009d554..1e0ea2f 100644
--- a/docs/en/edge/guide/upgrading/index.md
+++ b/docs/en/edge/guide/upgrading/index.md
@@ -25,8 +25,6 @@ Upgrading Guides
- Upgrading Cordova Android
- Upgrading Cordova BlackBerry
- Upgrading Cordova iOS
-- Upgrading Cordova Symbian
- Upgrading Cordova webOS
- Upgrading Cordova Windows Phone
- Upgrading Cordova Bada
-- Upgrading Cordova Tizen
[43/46] Merge 'mike-sierra/copy_edit' into master
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/guide/getting-started/windows-phone-7/index.md
----------------------------------------------------------------------
diff --cc docs/en/edge/guide/getting-started/windows-phone-7/index.md
index 95c45ea,704c64c..1afde83
--- a/docs/en/edge/guide/getting-started/windows-phone-7/index.md
+++ b/docs/en/edge/guide/getting-started/windows-phone-7/index.md
@@@ -86,7 -86,7 +86,8 @@@ __NOTE:__ Skip this step if the `lib\wi
- Press the green **play** button next to the drop-down menu to start debugging, or else type __F5__.
- 
++
+ 
6. Build your project for the device
------------------------------------
@@@ -104,5 -104,3 +105,4 @@@ Done
You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/48672055/Getting%20Started%20with%20PhoneGap%20Windows%20Phone%207).
+[register-url]: http://msdn.microsoft.com/en-us/library/windowsphone/develop/ff402565(v=vs.105).aspx
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/guide/getting-started/windows-phone-8/index.md
----------------------------------------------------------------------
diff --cc docs/en/edge/guide/getting-started/windows-phone-8/index.md
index d59d113,490fbe1..463c6f0
--- a/docs/en/edge/guide/getting-started/windows-phone-8/index.md
+++ b/docs/en/edge/guide/getting-started/windows-phone-8/index.md
@@@ -131,5 -144,3 +131,4 @@@ Further Readin
For more details on the specific differences between IE10 and WebKit browsers, and how to support both MS has a helpful [guide here](http://blogs.windows.com/windows_phone/b/wpdev/archive/2012/11/15/adapting-your-webkit-optimized-site-for-internet-explorer-10.aspx)
+[register-url]: http://msdn.microsoft.com/en-us/library/windowsphone/develop/ff402565(v=vs.105).aspx
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/guide/upgrading/blackberry/index.md
----------------------------------------------------------------------
diff --cc docs/en/edge/guide/upgrading/blackberry/index.md
index b9e46e2,bc4b31e..a9c68ca
--- a/docs/en/edge/guide/upgrading/blackberry/index.md
+++ b/docs/en/edge/guide/upgrading/blackberry/index.md
@@@ -20,165 -20,7 +20,165 @@@ license: Licensed to the Apache Softwar
Upgrading Cordova BlackBerry
============================
-This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova.
+This document describes the process of upgrading Cordova projects to the latest released version
+
+
+
+
+
+## Upgrading Cordova 2.7.0 projects to 2.8.0 ##
+
+### BlackBerry10 ###
+
+BlackBerry10 uses the new CLI tooling and manages core api's 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 IDE's** 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**](guide_command-line_index.md.html#Command-Line%20Usage_blackberry) from the command-line tools - this will be 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
+
+### 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 IDE's** 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**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project
+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.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
+
+## Upgrading Cordova 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 IDE's** 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**](guide_command-line_index.md.html#Command-Line%20Usage_blackberry) from the command-line tools - you will have to grab 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
+
+## Upgrade to 2.6.0 from 2.5.0 ##
+
+Updating the PhoneGap download folder:
+
+It is recommended that you download a fresh copy of the entire folder.
+
+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 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.
+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.4.0 from 2.3.0 ##
+
+Updating just the www folder:
+
+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 BlackBerry10, then update the .js file in the `qnx/` folder.
+5. Update your HTML to use the new `cordova-2.4.0.js` file.
+
+
+Updating the sample folder (ie, updating using the ant tools):
+
+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
+
+## Upgrade to 2.3.0 from 2.2.0 ##
+
- Updating just the www folder:
++Updating just the `www` folder:
+
+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 BlackBerry10, then update the .js file in the `qnx/` folder.
+5. Update your HTML to use the new `cordova-2.3.0.js` file.
+
+
+Updating the sample folder (ie, updating using the ant tools):
+
+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
+
+## Upgrade to 2.2.0 from 2.1.0 ##
+
+Updating just the www folder:
+
+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 BlackBerry10, then update the .js file in the `qnx/` folder.
+5. Update your HTML to use the new `cordova-2.2.0.js` file.
+
+
+Updating the sample folder (ie, 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.
+
+## Upgrade to 2.1.0 from 2.0.0 ##
+
+Updating just the www folder:
+
+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.
+5. Update your HTML to use the new `cordova-2.1.0.js` file.
+
+
+Updating the sample folder (ie, updating using the ant tools):
+
+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.
## Upgrade to 2.0.0 from 1.9.0 ##
[24/46] to end of geoloc
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfer/filetransfer.md b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
index 91e881d..d1cfc08 100644
--- a/docs/en/edge/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,12 +20,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
FileTransfer
==========
-FileTransfer is an object that allows you to upload files to a server or download files from a server.
+The `FileTransfer` object allows you to upload or download files to
+and from a server.
Properties
----------
-- __onprogress:__ Called with a ProgressEvent whenever a new chunk of data is transferred. _(Function)_
+- __onprogress__: Called with a `ProgressEvent` whenever a new chunk of data is transferred. _(Function)_
Methods
-------
@@ -37,8 +38,15 @@ Methods
Details
-------
-The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback is called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object.
-It is also possible to download a file from remote and save it on the device (only iOS and Android).
+The `FileTransfer` object provides a way to upload files to a remote
+server using an HTTP multi-part POST request. Both HTTP and HTTPS
+protocols are supported. Optional parameters can be specified by
+passing a `FileUploadOptions` object to the `upload()` method. On
+successful upload, a `FileUploadResult` object is passed to the
+success callback. If an error occurs, a `FileTransferError` object is
+passed to the error callback. It is also possible (only on iOS and
+Android) to download a file from a remote server and save it on the
+device.
Supported Platforms
-------------------
@@ -54,12 +62,12 @@ upload
__Parameters:__
-- __filePath__ - Full path of the file on the device
-- __server__ - URL of the server to receive the file (must already be encoded using encodeURI())
-- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
-- __errorCallback__ - A callback that is called 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 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)_
+- __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 called with a `Metadata` object. _(Function)_
+- __errorCallback__: A callback that is called 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__
@@ -187,19 +195,20 @@ Supported on Android and iOS
__Android Quirks__
-If you experience problems uploading to a Nginx server then make sure you have the chunkedMode option set to false.
+Set the `chunkedMode` option to `false` to prevent problems uploading
+to a Nginx server.
download
--------------
-__Parameters:__
+__Parameters:__
-- __source__ - URL of the server to download the file (must already be encoded using encodeURI())
-- __target__ - Full path of the file on the device
-- __successCallback__ - A callback that is called with a FileEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs 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).
+- __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__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md b/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
index 7c7d634..6f23f8d 100644
--- a/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
+++ b/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,14 +20,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
FileTransferError
========
-A `FileTransferError` object is returned via the error callback when an error occurs.
+A `FileTransferError` object is passed to an error callback when an error occurs.
Properties
----------
- __code__ One of the predefined error codes listed below. (Number)
-- __source__ URI to the source (String)
-- __target__ URI to the target (String)
+- __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
@@ -41,4 +41,5 @@ Constants
Description
-----------
-The `FileTransferError` object is returned via the error callback when an error occurs when uploading or downloading a file.
+The `FileTransferError` object is passed to the error callback when an
+error occurs when uploading or downloading a file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
index d0c1c3c..b9e8c83 100644
--- a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,25 +20,28 @@ license: Licensed to the Apache Software Foundation (ASF) under one
FileUploadOptions
========
-A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
+A `FileUploadOptions` object can be passed to the `FileTransfer`
+object's `upload()` method to specify additional parameters to the
+upload script.
Properties
----------
-- __fileKey:__ The name of the form element. If not set defaults to "file". (DOMString)
-- __fileName:__ The file name you want the file to be saved as on the server. If not set defaults to "image.jpg". (DOMString)
-- __mimeType:__ The mime type of the data you are uploading. If not set defaults to "image/jpeg". (DOMString)
-- __params:__ A set of optional key/value pairs to be passed along in the HTTP request. (Object)
-- __chunkedMode:__ Should the data be uploaded in chunked streaming mode. If not set defaults to "true". (Boolean)
-- __headers:__ A map of header name => header value. To specify multiple values for a header, use an array of values. (Object)
+- __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
-----------
-A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
+A `FileUploadOptions` object can be passed to the `FileTransfer`
+object's `upload()` method to specify additional parameters to the
+upload script.
WP7 Quirk
---------
-- __chunkedMode:__
- This parameter is ignored on WP7.
+- __chunkedMode:__ Ignored on WP7.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md b/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
index df3e040..4d9305a 100644
--- a/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,21 +20,23 @@ license: Licensed to the Apache Software Foundation (ASF) under one
FileUploadResult
========
-A `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
+A `FileUploadResult` object is passed to the success callback of the
+`FileTransfer` object's `upload()` method.
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)
+- __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
-----------
-The `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
+The `FileUploadResult` object is returned via the success callback of
+the `FileTransfer` object's `upload()` method.
iOS Quirks
----------
-- iOS does not include values for responseCode nor bytesSent in the success callback FileUploadResult object.
+- Does not support `responseCode` or `bytesSent`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filewriter/filewriter.md b/docs/en/edge/cordova/file/filewriter/filewriter.md
index 8477192..d86ce86 100644
--- a/docs/en/edge/cordova/file/filewriter/filewriter.md
+++ b/docs/en/edge/cordova/file/filewriter/filewriter.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,37 +20,47 @@ license: Licensed to the Apache Software Foundation (ASF) under one
FileWriter
==========
-FileWriter is an object that allows one to write a file.
+As object that allows you to create and write data to a file.
Properties
----------
-- __readyState:__ One of the three states the reader can be in 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)_
-- __onprogress:__ Called while writing the file, reports progress (progress.loaded/progress.total). _(Function)_ -_not_ SUPPORTED
-- __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)_
+- __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:
+- __onprogress__: Called while writing the file, reporting progress in terms of `progress.loaded`/`progress.total`. _(Function)_
Methods
-------
-- __abort__: Aborts writing file.
-- __seek__: Moves the file pointer to the byte specified.
-- __truncate__: Shortens the file to the length specified.
+- __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 with a UTF-8 encoding.
Details
-------
-The `FileWriter` object is a way to write files to the device file system (UTF-8 encoded). Users register their own event listeners to receive the writestart, progress, write, writeend, error and abort events.
-
-A FileWriter is created for a single file. You can use it to write to a file multiple times. The FileWriter maintains the file's position and length attributes, so you can seek and write anywhere in the file. By default, the FileWriter writes to the beginning of the file (will overwrite existing data). Set the optional append boolean to true in the FileWriter's constructor to begin writing to the end of the file.
+The `FileWriter` object offers a way to write UTF-8 encoded files to
+the device file system. Applications respond to `writestart`,
+`progress`, `write`, `writeend`, `error`, and `abort` events.
+
+Each `FileWriter` corresponds to a single file, to which data can be
+written many times. The `FileWriter` maintains the file's `position`
+and `length` attributes, which allow the app to `seek` and `write`
+anywhere in the file. By default, the `FileWriter` writes to the
+beginning of the file, overwriting existing data. Set the optional
+`append` boolean to `true` in the `FileWriter`'s constructor to
+write to the end of the file.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/flags/flags.md b/docs/en/edge/cordova/file/flags/flags.md
index 5380de7..504f323 100644
--- a/docs/en/edge/cordova/file/flags/flags.md
+++ b/docs/en/edge/cordova/file/flags/flags.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,13 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Flags
=====
-This object is used to supply arguments to the `DirectoryEntry` __getFile__ and __getDirectory__ methods, which look up or create files and directories, respectively.
+Supplies arguments to the `DirectoryEntry` object's `getFile()` and
+`getDirectory()` methods, which look up or create files and
+directories, respectively.
Properties
----------
-- __create:__ Used to indicate that the file or directory should be created, if it does not exist. _(boolean)_
-- __exclusive:__ By itself, exclusive has no effect. Used with create, it causes the file or directory creation to fail if the target path already exists. _(boolean)_
+- __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/80d6aeab/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
index 324d33c..3578bb1 100644
--- a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
+++ b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -25,8 +25,8 @@ This object provides a way to obtain root file systems.
Methods
----------
-- __requestFileSystem:__ Requests a filesystem. _(Function)_
-- __resolveLocalFileSystemURI:__ Retrieve a DirectoryEntry or FileEntry using local URI. _(Function)_
+- __requestFileSystem__: Requests a filesystem. _(Function)_
+- __resolveLocalFileSystemURI__: Retrieve a `DirectoryEntry` or `FileEntry` using local URI. _(Function)_
Constants
---------
@@ -37,7 +37,7 @@ Constants
Details
-------
-The `LocalFileSystem` object methods are defined on the __window__ object.
+The `LocalFileSystem` object methods are defined on the `window` object.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/metadata/metadata.md b/docs/en/edge/cordova/file/metadata/metadata.md
index 4871069..3c6ebdc 100644
--- a/docs/en/edge/cordova/file/metadata/metadata.md
+++ b/docs/en/edge/cordova/file/metadata/metadata.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,17 +20,19 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Metadata
==========
-This interface supplies information about the state of a file or directory.
+An interface that supplies information about the state of a file or directory.
Properties
----------
-- __modificationTime:__ This is the time at which the file or directory was last modified. _(Date)_
+- __modificationTime__: The time when the file or directory was last modified. _(Date)_
Details
-------
-The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `DirectoryEntry` or `FileEntry` object.
+The `Metadata` object represents information about the state of a file
+or directory. Calling a `DirectoryEntry` or `FileEntry` object's
+`getMetadata()` method results in a `Metadata` instance.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
index eba7792..201076a 100644
--- a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
+++ b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -36,7 +36,8 @@ Properties
Description
-----------
-The `Coordinates` object is created and populated by Cordova, and attached to the `Position` object. The `Position` object is then returned to the user through a callback function.
+The `Coordinates` object is attached to the `Position` object that is
+available to callback functions in requests for the current position.
Supported Platforms
-------------------
@@ -124,4 +125,4 @@ Full Example
Android Quirks
-------------
-__altitudeAccuracy:__ Not supported by Android devices, returning `null`.
+__altitudeAccuracy__: Not supported by Android devices, returning `null`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Position/position.md b/docs/en/edge/cordova/geolocation/Position/position.md
index 94113b3..e1db6ff 100644
--- a/docs/en/edge/cordova/geolocation/Position/position.md
+++ b/docs/en/edge/cordova/geolocation/Position/position.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -25,8 +25,8 @@ Contains `Position` coordinates and timestamp, created by the geolocation API.
Properties
----------
-- __coords:__ A set of geographic coordinates. _(Coordinates)_
-- __timestamp:__ Creation timestamp for `coords`. _(Date)_
+- __coords__: A set of geographic coordinates. _(Coordinates)_
+- __timestamp__: Creation timestamp for `coords`. _(Date)_
Description
-----------
@@ -102,8 +102,7 @@ Full Example
'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
'Heading: ' + position.coords.heading + '<br />' +
'Speed: ' + position.coords.speed + '<br />' +
- 'Timestamp: ' +
- position.timestamp + '<br />';
+ 'Timestamp: ' + position.timestamp + '<br />';
}
// onError Callback receives a PositionError object
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/PositionError/positionError.md b/docs/en/edge/cordova/geolocation/PositionError/positionError.md
index 1290af1..07200d5 100755
--- a/docs/en/edge/cordova/geolocation/PositionError/positionError.md
+++ b/docs/en/edge/cordova/geolocation/PositionError/positionError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,13 +20,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
PositionError
========
-A `PositionError` object is returned to the `geolocationError` callback when an error occurs.
+A `PositionError` object is passed to the `geolocationError` callback when an error occurs.
Properties
----------
-- __code:__ One of the predefined error codes listed below.
-- __message:__ Error message describing the details of the error encountered.
+- __code__: One of the predefined error codes listed below.
+- __message__: Error message describing the details of the error encountered.
Constants
---------
@@ -38,7 +38,8 @@ Constants
Description
-----------
-The `PositionError` object is returned to the user through the `geolocationError` callback function when an error occurs with geolocation.
+The `PositionError` object is passed to the `geolocationError`
+callback function when an error occurs with geolocation.
### `PositionError.PERMISSION_DENIED`
@@ -47,13 +48,13 @@ position information. This is dependent on the platform.
### `PositionError.POSITION_UNAVAILABLE`
-Returned when the device was unable to retrieve a position. In general
+Returned when the device is unable to retrieve a position. In general
this means the device has no network connectivity and/or cannot get a
satellite fix.
### `PositionError.TIMEOUT`
-Returned when the device was unable to retrieve a position within the
-time specified in the `geolocationOptions`' `timeout` property. When using
-in conjunction with `geolocation.watchPosition`, this error could be
-called into the `geolocationError` callback every `timeout` milliseconds.
+Returned when the device is unable to retrieve a position within the
+time specified in the `geolocationOptions`' `timeout` property. When
+used with `geolocation.watchPosition`, this error could be passed to
+the `geolocationError` callback every `timeout` milliseconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md b/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
index ff747d0..a92da7c 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,19 +20,22 @@ license: Licensed to the Apache Software Foundation (ASF) under one
geolocation.clearWatch
======================
-Stop watching for changes to the device's location referenced by the `watchID` parameter.
+Stop watching for changes to the device's location referenced by the
+`watchID` parameter.
navigator.geolocation.clearWatch(watchID);
Parameters
----------
-- __watchID:__ The id of the `watchPosition` interval to clear. (String)
+- __watchID__: The id of the `watchPosition` interval to clear. (String)
Description
-----------
-`geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`.
+The `geolocation.clearWatch` stops watching changes to the device's
+location by clearing the `geolocation.watchPosition` referenced by
+`watchID`.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
index 5e505e9..cc10464 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -30,13 +30,17 @@ Parameters
----------
- __geolocationSuccess__: The callback that is called with the current position.
-- __geolocationError__: (Optional) The callback that is called if there was an error.
-- __geolocationOptions__: (Optional) The geolocation options.
+- __geolocationError__: _(Optional)_ The callback that is called if there was an error.
+- __geolocationOptions__: _(Optional)_ The geolocation options.
Description
-----------
-`geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `geolocationSuccess` callback with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
+`geolocation.getCurrentPosition` is an asynchronous function. It
+returns the device's current position to the `geolocationSuccess`
+callback with a `Position` object as the parameter. If there is an
+error, the `geolocationError` callback is invoked with a
+`PositionError` object.
Supported Platforms
-------------------
@@ -109,7 +113,7 @@ Full Example
'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
'Heading: ' + position.coords.heading + '<br />' +
'Speed: ' + position.coords.speed + '<br />' +
- 'Timestamp: ' + position.timestamp + '<br />';
+ 'Timestamp: ' + position.timestamp + '<br />';
}
// onError Callback receives a PositionError object
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.md b/docs/en/edge/cordova/geolocation/geolocation.md
index 55ea2c8..d2613ce 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,11 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Geolocation
===========
-> The `geolocation` object provides access to the device's GPS sensor.
+> The `geolocation` object provides access to location data based on the device's GPS sensor or inferred from network signals.
-Geolocation provides location information for the device, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. No guarantee is given that the API returns the device's actual location.
+`Geolocation` provides information about the device's location, such as
+latitude and longitude. Common sources of location information include
+Global Positioning System (GPS) and location inferred from network
+signals such as IP address, RFID, WiFi and Bluetooth MAC addresses,
+and GSM/CDMA cell IDs. There is no guarantee that the API returns the
+device's actual location.
-This API is based on the [W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html). Some devices (Android, BlackBerry, Bada, Windows Phone 7, webOS and Tizen, to be specific) already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with Cordova's implementation. For devices that don't have geolocation support, the Cordova implementation adheres to the W3C specification.
+This API is based on the
+[W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html),
+and only executes on devices that don't already provide an implementation.
Methods
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
index 10beaa8..72693e4 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -29,8 +29,8 @@ Watches for changes to the device's current position.
Parameters
----------
-- __geolocationSuccess__: The callback that is called with the current position.
-- __geolocationError__: (Optional) The callback that is called if there was an error.
+- __geolocationSuccess__: The callback that is passed the current position.
+- __geolocationError__: (Optional) The callback that executes if there was an error.
- __geolocationOptions__: (Optional) The geolocation options.
Returns
@@ -41,7 +41,12 @@ Returns
Description
-----------
-`geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `geolocationSuccess` callback is invoked with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
+`geolocation.watchPosition` is an asynchronous function. It returns
+the device's current position when a change in position is detected.
+When the device retrieves a new location, the `geolocationSuccess`
+callback executes with a `Position` object as the parameter. If
+there is an error, the `geolocationError` callback executes with a
+`PositionError` object as the parameter.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
index 2d5112d..d4754e5 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -28,14 +28,12 @@ Optional parameters to customize the retrieval of the geolocation
Options
-------
-- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt 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 is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback will be invoked with a `PositionError.TIMEOUT` error code. NOTE: 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)_
+- __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 is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback is invoked with 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
--------------
-The Android 2.x simulators will not return a geolocation result unless the enableHighAccuracy option is set to true.
-
- { enableHighAccuracy: true }
+Android 2.x simulators do not return a geolocation result unless the `enableHighAccuracy` option is set to `true`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocationError.md b/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
index 4f35e6b..66cdefd 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,8 @@ license: Licensed to the Apache Software Foundation (ASF) under one
geolocationError
================
-The user's callback function that is called when there is an error for geolocation functions.
+The user's callback function that executes when there is an error for
+geolocation functions.
function(error) {
// Handle the error
@@ -29,4 +30,4 @@ The user's callback function that is called when there is an error for geolocati
Parameters
----------
-- __error:__ The error returned by the device. (`PositionError`)
+- __error__: The error returned by the device. (`PositionError`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md b/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
index 1e7416f..da61fc0 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,10 @@ license: Licensed to the Apache Software Foundation (ASF) under one
geolocationSuccess
==================
-The user's callback function that is called when a geolocation position becomes available (when using with `geolocation.getCurrentPosition`), or when the position changes (when using with `geolocation.watchPosition`).
+The user's callback function that executes when a geolocation position
+becomes available (when called from `geolocation.getCurrentPosition`),
+or when the position changes (when called from
+`geolocation.watchPosition`).
function(position) {
// Do something
@@ -29,7 +32,7 @@ The user's callback function that is called when a geolocation position becomes
Parameters
----------
-- __position:__ The geolocation position returned by the device. (`Position`)
+- __position__: The geolocation position returned by the device. (`Position`)
Example
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
index 870903f..d5d3942 100644
--- a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
+++ b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -25,12 +25,12 @@ An object representing a error from the Globalization API.
Properties
----------
-- __code:__ One of the following codes representing the error type (`Number`)
+- __code__: One of the following codes representing the error type (`Number`)
- GlobalizationError.UNKNOWN\_ERROR: 0
- GlobalizationError.FORMATTING\_ERROR: 1
- GlobalizationError.PARSING\_ERROR: 2
- GlobalizationError.PATTERN\_ERROR: 3
-- __message:__ A text message that includes the error explanation and/or details (`String`)
+- __message__: A text message that includes the error explanation and/or details (`String`)
Description
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/inappbrowser/inappbrowser.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/inappbrowser.md b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
index a1ef051..fc63a43 100644
--- a/docs/en/edge/cordova/inappbrowser/inappbrowser.md
+++ b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
@@ -64,15 +64,15 @@ addEventListener
ref.addEventListener(eventname, callback);
-- __ref:__ reference to the InAppBrowser window (`InAppBrowser`)
-- __eventname:__ the event to listen for (`String`)
+- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
+- __eventname__: the event to listen for (`String`)
loadstart - event fired when the InAppBrowser starts to load a URL
loadstop - event fired when the InAppBrowser finished loading a URL
loaderror - event fired when the InAppBrowser encounters an error loading a URL
exit - event fired when the InAppBrowser window is closed
-- __callback:__ the function that is called when the event is fired.
+- __callback__: the function that is called when the event is fired.
The function is passed an `InAppBrowserEvent` object.
Supported Platforms
@@ -126,15 +126,15 @@ removeEventListener
ref.removeEventListener(eventname, callback);
-- __ref:__ reference to the InAppBrowser window (`InAppBrowser`)
-- __eventname:__ the event to stop listening for (`String`)
+- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
+- __eventname__: the event to stop listening for (`String`)
loadstart - event fired when the InAppBrowser starts to load a URL
loadstop - event fired when the InAppBrowser finished loading a URL
loaderror - event fired when the InAppBrowser encounters an error loading a URL
exit - event fired when the InAppBrowser window is closed
-- __callback:__ the function that was to be called when the event is fired.
+- __callback__: the function that was to be called when the event is fired.
The function is passed an `InAppBrowserEvent` object.
Supported Platforms
@@ -213,7 +213,7 @@ close
ref.close();
-- __ref:__ reference to the InAppBrowser window (`InAppBrowser`)
+- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
Supported Platforms
-------------------
@@ -267,14 +267,14 @@ executeScript
ref.executeScript(details, callback);
-- __ref:__ reference to the InAppBrowser window (`InAppBrowser`)
-- __injectDetails:__ details of the script ot run (`Object`)
+- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
+- __injectDetails__: details of the script ot run (`Object`)
- Supported keys: (exactly one of "file" or "code" should be present)
"file" - URL of the script to inject
"code" - Text of the script to inject
-- __callback:__ the function that is to be called in the Cordova application after the JavaScript code is injected.
+- __callback__: the function that is to be called in the Cordova application after the JavaScript code is injected.
- If the injected script is of type "code", then the callback is called with a single argument, which is
the return value of the script, wrapped in an Array. (For multi-line scripts, this is the return value of the
last statement, or the last expression evaluated.)
@@ -347,14 +347,14 @@ insertCSS
ref.insertCSS(details, callback);
-- __ref:__ reference to the InAppBrowser window (`InAppBrowser`)
-- __injectDetails:__ details of the script ot run (`Object`)
+- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
+- __injectDetails__: details of the script ot run (`Object`)
- Supported keys: (exactly one of "file" or "code" should be present)
"file" - URL of the stylesheet to inject
"code" - Text of the stylesheet to inject
-- __callback:__ the function that is to be called in the Cordova application after the CSS is injected.
+- __callback__: the function that is to be called in the Cordova application after the CSS is injected.
Supported Platforms
-------------------
@@ -425,7 +425,7 @@ The object that is passed to the callback function from an addEventListener call
Properties
----------
-- __type:__ the eventname (`String`) - one of loadstart, loadstop, loaderror or exit
-- __url:__ the URL that was loaded (`String`)
-- __code:__ the error code (`Number`) - only in the case of loaderror
-- __message:__ the error message (`String`) - only in the case of loaderror
+- __type__: the eventname (`String`) - one of loadstart, loadstop, loaderror or exit
+- __url__: the URL that was loaded (`String`)
+- __code__: the error code (`Number`) - only in the case of loaderror
+- __message__: the error message (`String`) - only in the case of loaderror
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/inappbrowser/window.open.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/window.open.md b/docs/en/edge/cordova/inappbrowser/window.open.md
index 95fb1d2..802d90f 100644
--- a/docs/en/edge/cordova/inappbrowser/window.open.md
+++ b/docs/en/edge/cordova/inappbrowser/window.open.md
@@ -24,30 +24,30 @@ Opens a URL in a new InAppBrowser instance, the current browser instance, or the
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 you have Unicode characters in your URL.
-- __target:__ the target to load the URL in (`String`) (Optional, Default: "_self")
+- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
+- __url__: the URL to load (`String`). Call encodeURI() on this if you have Unicode characters in your URL.
+- __target__: the target to load the URL in (`String`) (Optional, Default: "_self")
_self - opens in the Cordova WebView if URL is in the white-list, else it opens in the InAppBrowser
_blank - always open in the InAppBrowser
_system - always open in the system web browser
-- __options:__ options for the InAppBrowser (`String`) (Optional, Default: "location=yes")
+- __options__: options for the InAppBrowser (`String`) (Optional, Default: "location=yes")
The options string must not contain any blank space, each feature name and value must be separated by a comma. Feature names are case insensitive. Only the value below is supported on all platforms:
- - __location__ - set to 'yes' or 'no' to turn the location bar on or off for the InAppBrowser
+ - __location__: set to 'yes' or 'no' to turn the location bar on or off for the InAppBrowser
iOS only
--------
- - __enableViewportScale__ - set to 'yes' or 'no' to prevent viewport scaling through a meta tag (defaults to 'no')
- - __mediaPlaybackRequiresUserAction__ - set to 'yes' or 'no' to not allow autoplayed HTML5 video (defaults to 'no')
- - __allowInlineMediaPlayback__ - set to 'yes' or 'no' to allow inline HTML5 media playback, also, the video element in the HTML document must also include the webkit-playsinline attribute (defaults to 'no')
- - __keyboardDisplayRequiresUserAction__ - set to 'yes' or 'no' to open the keyboard when form elements get focus via the JavaScript focus() call (defaults to 'yes')
- - __suppressesIncrementalRendering__ - set to 'yes' or 'no' to wait until all new view content has been received before it is rendered (defaults to 'no')
- - __presentationstyle__ - set to 'pagesheet', 'formsheet' or 'fullscreen' to set the [presentation style](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle) (defaults to 'fullscreen')
- - __transitionstyle__ - set to 'fliphorizontal', 'crossdissolve' or 'coververtical' to set the [transition style](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle) (defaults to 'coververtical')
+ - __enableViewportScale__: set to 'yes' or 'no' to prevent viewport scaling through a meta tag (defaults to 'no')
+ - __mediaPlaybackRequiresUserAction__: set to 'yes' or 'no' to not allow autoplayed HTML5 video (defaults to 'no')
+ - __allowInlineMediaPlayback__: set to 'yes' or 'no' to allow inline HTML5 media playback, also, the video element in the HTML document must also include the webkit-playsinline attribute (defaults to 'no')
+ - __keyboardDisplayRequiresUserAction__: set to 'yes' or 'no' to open the keyboard when form elements get focus via the JavaScript focus() call (defaults to 'yes')
+ - __suppressesIncrementalRendering__: set to 'yes' or 'no' to wait until all new view content has been received before it is rendered (defaults to 'no')
+ - __presentationstyle__: set to 'pagesheet', 'formsheet' or 'fullscreen' to set the [presentation style](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle) (defaults to 'fullscreen')
+ - __transitionstyle__: set to 'fliphorizontal', 'crossdissolve' or 'coververtical' to set the [transition style](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle) (defaults to 'coververtical')
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/MediaError/mediaError.md b/docs/en/edge/cordova/media/MediaError/mediaError.md
index c466a05..e65d471 100644
--- a/docs/en/edge/cordova/media/MediaError/mediaError.md
+++ b/docs/en/edge/cordova/media/MediaError/mediaError.md
@@ -25,8 +25,8 @@ A `MediaError` object is returned to the `mediaError` callback function when an
Properties
----------
-- __code:__ One of the predefined error codes listed below.
-- __message:__ Error message describing the details of the error.
+- __code__: One of the predefined error codes listed below.
+- __message__: Error message describing the details of the error.
Constants
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/Parameters/mediaError.md b/docs/en/edge/cordova/media/Parameters/mediaError.md
index 4eab2de..9236c86 100644
--- a/docs/en/edge/cordova/media/Parameters/mediaError.md
+++ b/docs/en/edge/cordova/media/Parameters/mediaError.md
@@ -29,4 +29,4 @@ A user specified callback function that is invoked when there is an error in med
Parameters
----------
-- __error:__ The error returned by the device. (`MediaError`)
+- __error__: The error returned by the device. (`MediaError`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureError.md b/docs/en/edge/cordova/media/capture/CaptureError.md
index a7dc6e2..310f3e9 100644
--- a/docs/en/edge/cordova/media/capture/CaptureError.md
+++ b/docs/en/edge/cordova/media/capture/CaptureError.md
@@ -25,7 +25,7 @@ CaptureError
Properties
----------
-- __code:__ One of the pre-defined error codes listed below.
+- __code__: One of the pre-defined error codes listed below.
Constants
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/ConfigurationData.md b/docs/en/edge/cordova/media/capture/ConfigurationData.md
index 863ffe2..c86eafb 100644
--- a/docs/en/edge/cordova/media/capture/ConfigurationData.md
+++ b/docs/en/edge/cordova/media/capture/ConfigurationData.md
@@ -38,9 +38,9 @@ The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt).
Properties
----------
-- __type:__ The ASCII-encoded string in lower case representing the media type. (DOMString)
-- __height:__ The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-- __width:__ The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
+- __type__: The ASCII-encoded string in lower case representing the media type. (DOMString)
+- __height__: The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
+- __width__: The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFile.md b/docs/en/edge/cordova/media/capture/MediaFile.md
index b0cd33e..eae4810 100644
--- a/docs/en/edge/cordova/media/capture/MediaFile.md
+++ b/docs/en/edge/cordova/media/capture/MediaFile.md
@@ -25,13 +25,13 @@ MediaFile
Properties
----------
-- __name:__ The name of the file, without path information. (DOMString)
-- __fullPath:__ The full path of the file, including the name. (DOMString)
-- __type:__ The mime type (DOMString)
-- __lastModifiedDate:__ The date and time that the file was last modified. (Date)
-- __size:__ The size of the file, in bytes. (Number)
+- __name__: The name of the file, without path information. (DOMString)
+- __fullPath__: The full path of the file, including the name. (DOMString)
+- __type__: The mime type (DOMString)
+- __lastModifiedDate__: The date and time that the file was last modified. (Date)
+- __size__: The size of the file, in bytes. (Number)
Methods
-------
-- __MediaFile.getFormatData:__ Retrieves the format information of the media file.
+- __MediaFile.getFormatData__: Retrieves the format information of the media file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFileData.md b/docs/en/edge/cordova/media/capture/MediaFileData.md
index dcb3cdc..4ff8939 100644
--- a/docs/en/edge/cordova/media/capture/MediaFileData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFileData.md
@@ -25,38 +25,38 @@ MediaFileData
Properties
----------
-- __codecs:__ The actual format of the audio and video content. (DOMString)
-- __bitrate:__ The average bitrate of the content. In case of an image, this attribute has value 0. (Number)
-- __height:__ The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-- __width:__ The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-- __duration:__ The length of the video or sound clip in seconds. In the case of an image, this attribute has value 0. (Number)
+- __codecs__: The actual format of the audio and video content. (DOMString)
+- __bitrate__: The average bitrate of the content. In case of an image, this attribute has value 0. (Number)
+- __height__: The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
+- __width__: The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
+- __duration__: The length of the video or sound clip in seconds. In the case of an image, this attribute has value 0. (Number)
BlackBerry WebWorks Quirks
--------------------------
There is no API that provides format information of media files. So the MediaFileData object returned by the MediaFile.getFormatData function will have the following default values:
-- __codecs:__ Not supported. The attribute will always be null.
-- __bitrate:__ Not supported. The attribute will always be 0.
-- __height:__ Not supported. The attribute will always be 0.
-- __width:__ Not supported. The attribute will always be 0.
-- __duration:__ Not supported. The attribute will always be 0.
+- __codecs__: Not supported. The attribute will always be null.
+- __bitrate__: Not supported. The attribute will always be 0.
+- __height__: Not supported. The attribute will always be 0.
+- __width__: Not supported. The attribute will always be 0.
+- __duration__: Not supported. The attribute will always be 0.
Android Quirks
--------------
Support for the MediaFileData properties is as follows:
-- __codecs:__ Not supported. The attribute will always be null.
-- __bitrate:__ Not supported. The attribute will always be 0.
-- __height:__ Supported. (Image and video files only).
-- __width:__ Supported. (Image and video files only).
-- __duration:__ Supported. (Audio and video files only).
+- __codecs__: Not supported. The attribute will always be null.
+- __bitrate__: Not supported. The attribute will always be 0.
+- __height__: Supported. (Image and video files only).
+- __width__: Supported. (Image and video files only).
+- __duration__: Supported. (Audio and video files only).
iOS Quirks
----------
Support for the MediaFileData properties is as follows:
-- __codecs:__ Not supported. The attribute will always be null.
-- __bitrate:__ Supported on iOS4 devices for audio only. The attribute will always be 0 for image and video.
-- __height:__ Supported. (Image and video files only).
-- __width:__ Supported. (Image and video files only).
-- __duration:__ Supported. (Audio and video files only).
+- __codecs__: Not supported. The attribute will always be null.
+- __bitrate__: Supported on iOS4 devices for audio only. The attribute will always be 0 for image and video.
+- __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/80d6aeab/docs/en/edge/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/capture.md b/docs/en/edge/cordova/media/capture/capture.md
index 3fdefd5..7f669df 100644
--- a/docs/en/edge/cordova/media/capture/capture.md
+++ b/docs/en/edge/cordova/media/capture/capture.md
@@ -54,9 +54,9 @@ The __capture__ object is assigned to the __navigator.device__ object, and there
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[])
+- __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
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudioOptions.md b/docs/en/edge/cordova/media/capture/captureAudioOptions.md
index a510d17..583a7f5 100644
--- a/docs/en/edge/cordova/media/capture/captureAudioOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureAudioOptions.md
@@ -25,8 +25,8 @@ CaptureAudioOptions
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.
+- __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/80d6aeab/docs/en/edge/cordova/media/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureImageOptions.md b/docs/en/edge/cordova/media/capture/captureImageOptions.md
index f999766..4dcda3b 100644
--- a/docs/en/edge/cordova/media/capture/captureImageOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureImageOptions.md
@@ -25,7 +25,7 @@ CaptureImageOptions
Properties
----------
-- __limit:__ The maximum number of images the device user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+- __limit__: The maximum number of images the device user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureVideoOptions.md b/docs/en/edge/cordova/media/capture/captureVideoOptions.md
index 627e7eb..f3072fa 100644
--- a/docs/en/edge/cordova/media/capture/captureVideoOptions.md
+++ b/docs/en/edge/cordova/media/capture/captureVideoOptions.md
@@ -25,8 +25,8 @@ CaptureVideoOptions
Properties
----------
-- __limit:__ The maximum number of video clips the device 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.
+- __limit__: The maximum number of video clips the device 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/80d6aeab/docs/en/edge/cordova/notification/notification.alert.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.alert.md b/docs/en/edge/cordova/notification/notification.alert.md
index c7a38c8..11a0724 100644
--- a/docs/en/edge/cordova/notification/notification.alert.md
+++ b/docs/en/edge/cordova/notification/notification.alert.md
@@ -24,10 +24,10 @@ 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, Default: "Alert")
-- __buttonName:__ Button name (`String`) (Optional, Default: "OK")
+- __message__: Dialog message (`String`)
+- __alertCallback__: Callback to invoke when alert dialog is dismissed. (`Function`)
+- __title__: Dialog title (`String`) (Optional, Default: "Alert")
+- __buttonName__: Button name (`String`) (Optional, Default: "OK")
Description
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.beep.md b/docs/en/edge/cordova/notification/notification.beep.md
index e59e625..56f8df2 100644
--- a/docs/en/edge/cordova/notification/notification.beep.md
+++ b/docs/en/edge/cordova/notification/notification.beep.md
@@ -24,7 +24,7 @@ The device will play a beep sound.
navigator.notification.beep(times);
-- __times:__ The number of times to repeat the beep (`Number`)
+- __times__: The number of times to repeat the beep (`Number`)
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.confirm.md b/docs/en/edge/cordova/notification/notification.confirm.md
index cd99bb2..9b977ae 100755
--- a/docs/en/edge/cordova/notification/notification.confirm.md
+++ b/docs/en/edge/cordova/notification/notification.confirm.md
@@ -24,10 +24,10 @@ Shows 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, Default: "Confirm")
-- __buttonLabels:__ Comma separated string with button labels (`String`) (Optional, Default: "OK,Cancel")
+- __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, Default: "Confirm")
+- __buttonLabels__: Comma separated string with button labels (`String`) (Optional, Default: "OK,Cancel")
Description
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.prompt.md b/docs/en/edge/cordova/notification/notification.prompt.md
index 78f3db7..56e07e6 100644
--- a/docs/en/edge/cordova/notification/notification.prompt.md
+++ b/docs/en/edge/cordova/notification/notification.prompt.md
@@ -24,10 +24,10 @@ Shows a customizable prompt dialog box.
navigator.notification.prompt(message, promptCallback, [title], [buttonLabels])
-- __message:__ Dialog message (`String`)
-- __promptCallback:__ - Callback to invoke when a button is pressed (`Function`)
-- __title:__ Dialog title (`String`) (Optional, Default: "Prompt")
-- __buttonLabels:__ Array of strings for the button labels (`Array`) (Optional, Default: ["OK","Cancel"])
+- __message__: Dialog message (`String`)
+- __promptCallback__: Callback to invoke when a button is pressed (`Function`)
+- __title__: Dialog title (`String`) (Optional, Default: "Prompt")
+- __buttonLabels__: Array of strings for the button labels (`Array`) (Optional, Default: ["OK","Cancel"])
Description
-----------
@@ -41,8 +41,8 @@ The `promptCallback` is called when the user has pressed one of the buttons on t
The callback takes the argument `results` which contains the following properties:
-- __buttonIndex:__ (`Number`), which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc.
-- __input1:__ (`String`), which is the text entered in the prompt dialog box.
+- __buttonIndex__: (`Number`), which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc.
+- __input1__: (`String`), which is the text entered in the prompt dialog box.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/notification/notification.vibrate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.vibrate.md b/docs/en/edge/cordova/notification/notification.vibrate.md
index 20f7815..54ed5fe 100644
--- a/docs/en/edge/cordova/notification/notification.vibrate.md
+++ b/docs/en/edge/cordova/notification/notification.vibrate.md
@@ -24,7 +24,7 @@ Vibrates the device for the specified amount of time.
navigator.notification.vibrate(milliseconds)
-- __time:__ Milliseconds to vibrate the device. 1000 milliseconds equals 1 second (`Number`)
+- __time__: Milliseconds to vibrate the device. 1000 milliseconds equals 1 second (`Number`)
Supported Platforms
-------------------
@@ -97,7 +97,7 @@ Full Example
iPhone Quirks
-------------
-- __time:__ Ignores the time and vibrates for a pre-set amount of time.
+- __time__: Ignores the time and vibrates for a pre-set amount of time.
navigator.notification.vibrate();
navigator.notification.vibrate(2500); // 2500 is ignored
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/80d6aeab/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlerror/sqlerror.md b/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
index c56c16a..ee06596 100644
--- a/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
+++ b/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
@@ -25,8 +25,8 @@ A `SQLError` object is thrown when an error occurs.
Properties
----------
-- __code:__ One of the predefined error codes listed below.
-- __message:__ A description of the error.
+- __code__: One of the predefined error codes listed below.
+- __message__: A description of the error.
Constants
---------
[23/46] docs commit: up to directoryentry
Posted by mw...@apache.org.
up to directoryentry
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/f43710de
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/f43710de
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/f43710de
Branch: refs/heads/master
Commit: f43710de265998b442f1a2a8ae5a2d56a8225809
Parents: 0a03c5a
Author: Mike Sierra <le...@gmail.com>
Authored: Thu May 16 12:34:13 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Thu May 16 12:34:13 2013 -0400
----------------------------------------------------------------------
.../file/directoryentry/directoryentry.md | 25 +++++++++++---------
1 file changed, 14 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f43710de/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index 05121d7..cc5990d 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -20,33 +20,36 @@ license: Licensed to the Apache Software Foundation (ASF) under one
DirectoryEntry
==============
-This object represents a directory on a file system. It is defined in the [W3C Directories and Systems](http://www.w3.org/TR/file-system-api/) specification.
+This object represents a directory on a file system, as defined by the
+[W3C Directories and Systems](http://www.w3.org/TR/file-system-api/)
+specification.
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)_
+- __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 attributes are defined by the W3C specification, but are __not supported__ by Cordova:
+__NOTE:__ The following attributes are defined by the W3C
+specification, but are _not_ supported by Cordova:
-- __filesystem:__ The file system on which the DirectoryEntry resides. _(FileSystem)_
+- __filesystem:__ The file system on which the `DirectoryEntry` resides. _(FileSystem)_
Methods
-------
-The following methods can be invoked on a DirectoryEntry object:
+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 that can be used to locate a directory.
-- __remove__: Delete a directory. The directory must be empty.
+- __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.
+- __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.
@@ -67,8 +70,8 @@ Look up metadata about a directory.
__Parameters:__
-- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback function to be called with a `Metadata` object. _(Function)_
+- __errorCallback__ - A callback function that executes if an error occurs when retrieving the `Metadata`, invoked with a `FileError` object. _(Function)_
__Quick Example__
[18/46] edits up to menu button event
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.uuid.md b/docs/en/edge/cordova/device/device.uuid.md
index 24c0964..565ffae 100644
--- a/docs/en/edge/cordova/device/device.uuid.md
+++ b/docs/en/edge/cordova/device/device.uuid.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -23,11 +23,11 @@ device.uuid
Get the device's Universally Unique Identifier ([UUID](http://en.wikipedia.org/wiki/Universally_Unique_Identifier)).
var string = device.uuid;
-
+
Description
-----------
-The details of how a UUID is generated are determined by the device manufacturer and specific to the device's platform or model.
+The details of how a UUID is generated are determined by the device manufacturer and are specific to the device's platform or model.
Supported Platforms
-------------------
@@ -54,9 +54,9 @@ Quick Example
// Returns a string of hash values created from multiple hardware identifies.
// It is guaranteed to be unique for every device and cannot be tied
// to the user account.
- // Windows Phone 7 : Returns a hash of device+current user,
+ // Windows Phone 7 : Returns a hash of device+current user,
// if the user is not defined, a guid is generated and will persist until the app is uninstalled
- //
+ //
// webOS: returns the device NDUID
//
// Tizen: returns the device IMEI (International Mobile Equipment Identity or IMEI is a number
@@ -83,10 +83,10 @@ Full Example
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device Cordova: ' + device.cordova + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
'Device Version: ' + device.version + '<br />';
}
@@ -100,9 +100,17 @@ Full Example
iOS Quirk
-------------
-The uuid for iOS is not unique for a device, but is unique per application per install. This will change if you delete the app and re-install, and possibly also when you upgrade your iOS version, or even upgrade your app per version (as we've seen in iOS 5.1). Not a reliable value.
+The `uuid` on iOS is not unique to a device, but varies for each
+application, for each installation. It changes if you delete and
+re-install the app, and possibly also when you upgrade iOS, or even
+upgrade your app per version (apparent in iOS 5.1). The `uuid` is not
+a reliable value.
Windows Phone 7 and 8 Quirks
-------------
-The uuid for Windows Phone 7 requires the permission ID_CAP_IDENTITY_DEVICE. Microsoft will likely be deprecating this property in the near future. If the capability is not available, the application generates a persistent guid, that will be maintained for the install-lifetime of the application on the device.
+The `uuid` for Windows Phone 7 requires the permission
+`ID_CAP_IDENTITY_DEVICE`. Microsoft will likely deprecate this
+property soon. If the capability is not available, the application
+generates a persistent guid that is maintained for the duration of the
+application's installation on the device.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.version.md b/docs/en/edge/cordova/device/device.version.md
index b88de98..9e1db70 100644
--- a/docs/en/edge/cordova/device/device.version.md
+++ b/docs/en/edge/cordova/device/device.version.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -41,7 +41,7 @@ Quick Example
// Android: Froyo OS would return "2.2"
// Eclair OS would return "2.1", "2.0.1", or "2.0"
- // Version can also return update level "2.1-update1"
+ // Version can also return update level "2.1-update1"
//
// BlackBerry: Torch 9800 using OS 6.0 would return "6.0.0.600"
//
@@ -72,10 +72,10 @@ Full Example
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device Cordova: ' + device.cordova + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
'Device Version: ' + device.version + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.backbutton.md b/docs/en/edge/cordova/events/events.backbutton.md
index 0f668b9..2041c96 100644
--- a/docs/en/edge/cordova/events/events.backbutton.md
+++ b/docs/en/edge/cordova/events/events.backbutton.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,16 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
backbutton
===========
-This is an event that fires when the user presses the back button.
+The event fires when the user presses the back button.
document.addEventListener("backbutton", yourCallbackFunction, false);
Details
-------
-If you need to override the default back button behaviour you can register an event listener for the 'backbutton' event. It is no longer necessary to call any other method to over ride the back button behaviour. Now, you only need to register an event listener for 'backbutton'.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+To override the default back-button behavior, register an event
+listener for the `backbutton` event, typically by calling
+`document.addEventListener` once you receive the Cordova `deviceready`
+event. It is no longer necessary to call any other method to override
+the back-button behaviour.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterycritical.md b/docs/en/edge/cordova/events/events.batterycritical.md
index b11294a..0fa68f9 100644
--- a/docs/en/edge/cordova/events/events.batterycritical.md
+++ b/docs/en/edge/cordova/events/events.batterycritical.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,21 +20,25 @@ license: Licensed to the Apache Software Foundation (ASF) under one
batterycritical
===========
-This is an event that fires when a Cordova application detects the battery has reached the critical level threshold.
+The event fires when the battery has reached the critical level
+threshold.
window.addEventListener("batterycritical", yourCallbackFunction, false);
Details
-------
-This event that fires when a Cordova application detects the percentage of battery has reached the critical battery threshold. This value is device specific.
+The event fires when the percentage of battery charge has reached the
+critical battery threshold. The value is device-specific.
-The batterycritical handler will be called with an object that contains two properties:
+The `batterycritical` handler is called with an object that contains
+two properties:
-- __level:__ The percentage of battery (0-100). _(Number)_
-- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
+- __level:__ The percentage of battery charge (0-100). _(Number)_
+- __isPlugged:__ A boolean that indicates whether the device is plugged in. _(Boolean)_
-Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `window.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
@@ -51,7 +55,7 @@ Quick Example
function onBatteryCritical(info) {
// Handle the battery critical event
- alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
+ alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
}
Full Example
@@ -70,7 +74,7 @@ Full Example
// At this point, the document has loaded but cordova-x.x.x.js has not.
// When Cordova is loaded and talking with the native device,
// it will call the event `deviceready`.
- //
+ //
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
@@ -84,7 +88,7 @@ Full Example
// Handle the batterycritical event
//
function onBatteryCritical(info) {
- alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
+ alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterylow.md b/docs/en/edge/cordova/events/events.batterylow.md
index 804a7a5..d40ddf6 100644
--- a/docs/en/edge/cordova/events/events.batterylow.md
+++ b/docs/en/edge/cordova/events/events.batterylow.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,21 +20,24 @@ license: Licensed to the Apache Software Foundation (ASF) under one
batterylow
===========
-This is an event that fires when a Cordova application detects the battery has reached the low level threshold.
+The event fires when the battery has reached the low level threshold.
window.addEventListener("batterylow", yourCallbackFunction, false);
Details
-------
-This event that fires when a Cordova application detects the percentage of battery has reached the low battery threshold. This value is device specific.
+The event fires when the percentage of battery charge has reached the
+low battery threshold, device-specific value.
-The batterylow handler will be called with an object that contains two properties:
+The `batterylow` handler is called with an object that contains two
+properties:
-- __level:__ The percentage of battery (0-100). _(Number)_
-- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
+- __level:__ The percentage of battery charge (0-100). _(Number)_
+- __isPlugged:__ A boolean that indicates whether the device is plugged in. _(Boolean)_
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
@@ -51,7 +54,7 @@ Quick Example
function onBatteryLow(info) {
// Handle the battery low event
- alert("Battery Level Low " + info.level + "%");
+ alert("Battery Level Low " + info.level + "%");
}
Full Example
@@ -70,7 +73,7 @@ Full Example
// At this point, the document has loaded but cordova-x.x.x.js has not.
// When Cordova is loaded and talking with the native device,
// it will call the event `deviceready`.
- //
+ //
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
@@ -84,7 +87,7 @@ Full Example
// Handle the batterylow event
//
function onBatteryLow(info) {
- alert("Battery Level Low " + info.level + "%");
+ alert("Battery Level Low " + info.level + "%");
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterystatus.md b/docs/en/edge/cordova/events/events.batterystatus.md
index 6ef4a25..9040074 100644
--- a/docs/en/edge/cordova/events/events.batterystatus.md
+++ b/docs/en/edge/cordova/events/events.batterystatus.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,21 +20,24 @@ license: Licensed to the Apache Software Foundation (ASF) under one
batterystatus
===========
-This is an event that fires when a Cordova application detects a change in the battery status.
+The event fires when there is a change in the battery status.
window.addEventListener("batterystatus", yourCallbackFunction, false);
Details
-------
-This event that fires when a Cordova application detects the percentage of battery has changed by at least 1 percent. It is also fired if the device has been plugged in or un-plugged.
+This event fires when the percentage of battery charge changes by at
+least 1 percent, or if the device is plugged in or unplugged.
-The battery status handler will be called with an object that contains two properties:
+The battery status handler is called with an object that contains two
+properties:
-- __level:__ The percentage of battery (0-100). _(Number)_
-- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
+- __level:__ The percentage of battery charge (0-100). _(Number)_
+- __isPlugged:__ A boolean that indicates whether the device is plugged in. _(Boolean)_
-Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `window.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
@@ -48,9 +51,9 @@ Supported Platforms
Windows Phone 7 and 8 Quirks
----------------------
-The `level` property is unavailable as Windows Phone 7 does not provide
-native APIs for determining battery level. The `isPlugged` parameter
-_is_ supported.
+Windows Phone 7 does not provide native APIs to determine battery
+level, so the `level` property is unavailable. The `isPlugged`
+parameter _is_ supported.
Quick Example
-------------
@@ -59,7 +62,7 @@ Quick Example
function onBatteryStatus(info) {
// Handle the online event
- console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
+ console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
}
Full Example
@@ -78,7 +81,7 @@ Full Example
// At this point, the document has loaded but cordova-x.x.x.js has not.
// When Cordova is loaded and talking with the native device,
// it will call the event `deviceready`.
- //
+ //
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
@@ -92,7 +95,7 @@ Full Example
// Handle the batterystatus event
//
function onBatteryStatus(info) {
- console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
+ console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.deviceready.md b/docs/en/edge/cordova/events/events.deviceready.md
index b44c9f0..30786ae 100644
--- a/docs/en/edge/cordova/events/events.deviceready.md
+++ b/docs/en/edge/cordova/events/events.deviceready.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
deviceready
===========
-This is an event that fires when Cordova is fully loaded.
+The event fires when Cordova is fully loaded.
document.addEventListener("deviceready", yourCallbackFunction, false);
@@ -29,13 +29,20 @@ Details
This is a very important event that every Cordova application should use.
-Cordova consists of two code bases: native and JavaScript. While the native code is loading, a custom loading image is displayed. However, JavaScript is only loaded once the DOM loads. This means your web application could, potentially, call a Cordova JavaScript function before it is loaded.
+Cordova consists of two code bases: native and JavaScript. While the
+native code loads, a custom loading image displays. However,
+JavaScript only loads once the DOM loads. This means your web
+application may potentially call a Cordova JavaScript function before
+the corresponding native code is available.
-The Cordova `deviceready` event fires once Cordova has fully loaded. After the device has fired, you can safely make calls to Cordova function.
+The Cordova `deviceready` event fires once Cordova has fully loaded.
+After the device has fired, you can safely make calls to Cordova APIs.
+Applications typically attach an event listener with
+`document.addEventListener` once the HTML document's DOM has loaded.
-Typically, you will want to attach an event listener with `document.addEventListener` once the HTML document's DOM has loaded.
-
-This event behaves differently from others in that any event handler registered after the event has been fired will have its callback function called immediately.
+The `deviceready` event behaves somewhat differently from others. Any
+event handler registered after the `deviceready` event fires has its
+callback function called immediately.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.endcallbutton.md b/docs/en/edge/cordova/events/events.endcallbutton.md
index 7fab690..a9abb30 100644
--- a/docs/en/edge/cordova/events/events.endcallbutton.md
+++ b/docs/en/edge/cordova/events/events.endcallbutton.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,16 +20,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
endcallbutton
===========
-This is an event that fires when the user presses the end call button.
+This event fires when the user presses the end call button.
document.addEventListener("endcallbutton", yourCallbackFunction, false);
Details
-------
-If you need to override the default end call behaviour you can register an event listener for the 'endcallbutton' event.
+The event overrides the default end call behavior.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.md b/docs/en/edge/cordova/events/events.md
index 1581844..4ae67aa 100644
--- a/docs/en/edge/cordova/events/events.md
+++ b/docs/en/edge/cordova/events/events.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.menubutton.md b/docs/en/edge/cordova/events/events.menubutton.md
index f97ebc9..3f47e4f 100644
--- a/docs/en/edge/cordova/events/events.menubutton.md
+++ b/docs/en/edge/cordova/events/events.menubutton.md
@@ -20,16 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
menubutton
===========
-This is an event that fires when the user presses the menu button.
+The event fires when the user presses the menu button.
document.addEventListener("menubutton", yourCallbackFunction, false);
Details
-------
-If you need to override the default menu button behaviour you can register an event listener for the 'menubutton' event.
+If you need to override the default menu button behaviour you can
+register an event listener for the 'menubutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.offline.md b/docs/en/edge/cordova/events/events.offline.md
index fa4cf58..19f47e5 100644
--- a/docs/en/edge/cordova/events/events.offline.md
+++ b/docs/en/edge/cordova/events/events.offline.md
@@ -20,16 +20,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
offline
===========
-This is an event that fires when a Cordova application is offline (not connected to the Internet).
+This event fires when a Cordova application is offline (not connected to the Internet).
document.addEventListener("offline", yourCallbackFunction, false);
Details
-------
-When the application's network connection changes to being offline, the offline event is fired.
+When the application's network connection changes to being offline, the offline event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.online.md b/docs/en/edge/cordova/events/events.online.md
index de7e404..20c4b52 100644
--- a/docs/en/edge/cordova/events/events.online.md
+++ b/docs/en/edge/cordova/events/events.online.md
@@ -20,16 +20,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
online
===========
-This is an event that fires when a Cordova application is online (connected to the Internet).
+This event fires when a Cordova application is online (connected to the Internet).
document.addEventListener("online", yourCallbackFunction, false);
Details
-------
-When the application's network connection changes to being online, the online event is fired.
+When the application's network connection changes to being online, the online event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.pause.md b/docs/en/edge/cordova/events/events.pause.md
index 678cdf4..c30f847 100644
--- a/docs/en/edge/cordova/events/events.pause.md
+++ b/docs/en/edge/cordova/events/events.pause.md
@@ -20,16 +20,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
pause
===========
-This is an event that fires when a Cordova application is put into the background.
+This event fires when a Cordova application is put into the background.
document.addEventListener("pause", yourCallbackFunction, false);
Details
-------
-Cordova consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired.
+Cordova consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
@@ -91,8 +92,8 @@ iOS Quirks
--------------------------
In the pause handler, any calls that go through Objective-C will not work, nor will any calls that are interactive, like alerts. This means that you cannot call console.log (and its variants), or any calls from Plugins or the Cordova API. These will only be processed when the app resumes (processed on the next run-loop).
-- __resign__ event
+- __resign__ event
+
+ This iOS specific event is available as a variant of the **pause** event, and is often used to detect when the "Lock" button has been pressed to lock the device when your app is the foreground app. If your app (and device) is enabled for multi-tasking, this will be paired with a subsequent **pause** event, but only under iOS 5 (effectively all "locked" apps in iOS 5 that have multi-tasking enabled are put to the background).
- This iOS specific event is available as a variant of the **pause** event, and is often used to detect when the "Lock" button has been pressed to lock the device when your app is the foreground app. If your app (and device) is enabled for multi-tasking, this will be paired with a subsequent **pause** event, but only under iOS 5 (effectively all "locked" apps in iOS 5 that have multi-tasking enabled are put to the background).
-
Under iOS 5, if you want your app to still run when the device is locked, you will have to disable multi-tasking (UIApplicationExitsOnSuspend - YES) for your app. This is different when you are on iOS 4 - to have your app run when the device is locked, the multi-tasking setting for your app does not matter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.resume.md b/docs/en/edge/cordova/events/events.resume.md
index eb3b9e1..0e0057f 100644
--- a/docs/en/edge/cordova/events/events.resume.md
+++ b/docs/en/edge/cordova/events/events.resume.md
@@ -20,16 +20,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
resume
===========
-This is an event that fires when a Cordova application is retrieved from the background.
+This event fires when a Cordova application is retrieved from the background.
document.addEventListener("resume", yourCallbackFunction, false);
Details
-------
-Cordova consists of two code bases: native and JavaScript. While the native code pulls the application from the background the resume event is fired.
+Cordova consists of two code bases: native and JavaScript. While the native code pulls the application from the background the resume event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
@@ -89,15 +90,15 @@ Full Example
iOS Quirks
--------------------------
-Any calls to console.log during your **pause** event handler will be run now when the app resumes, see the iOS Quirks section for the **pause** event for an explanation.
+Any calls to console.log during your **pause** event handler will be run now when the app resumes, see the iOS Quirks section for the **pause** event for an explanation.
-- __active__ event
+- __active__ event
+
+ This iOS specific event is available as a variant of the **resume** event, and is often used to detect when the "Lock" button has been pressed to unlock the device when your app is the foreground app. If your app (and device) is enabled for multi-tasking, this will be paired with a subsequent **resume** event, but only under iOS 5 (effectively all "locked" apps in iOS 5 that have multi-tasking enabled are put to the background).
- This iOS specific event is available as a variant of the **resume** event, and is often used to detect when the "Lock" button has been pressed to unlock the device when your app is the foreground app. If your app (and device) is enabled for multi-tasking, this will be paired with a subsequent **resume** event, but only under iOS 5 (effectively all "locked" apps in iOS 5 that have multi-tasking enabled are put to the background).
-
Under iOS 5, if you want your app to still run when the device is locked, you will have to disable multi-tasking (UIApplicationExitsOnSuspend - YES) for your app. This is different when you are on iOS 4 - to have your app run when the device is locked, the multi-tasking setting for your app does not matter.
-- __resume__ event
+- __resume__ event
Interactive functions like alert() when the resume event fires will need to be wrapped in a setTimeout call with a timeout value of zero, or else the app will hang. e.g.
@@ -106,4 +107,4 @@ Any calls to console.log during your **pause** event handler will be run now whe
setTimeout(function() {
// TODO: do your thing!
}, 0);
- }
\ No newline at end of file
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.searchbutton.md b/docs/en/edge/cordova/events/events.searchbutton.md
index f571a4d..ba6cfe6 100644
--- a/docs/en/edge/cordova/events/events.searchbutton.md
+++ b/docs/en/edge/cordova/events/events.searchbutton.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
searchbutton
===========
-This is an event that fires when the user presses the search button on Android.
+This event fires when the user presses the search button on Android.
document.addEventListener("searchbutton", yourCallbackFunction, false);
@@ -29,7 +29,8 @@ Details
If you need to override the default search button behaviour on Android you can register an event listener for the 'searchbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.startcallbutton.md b/docs/en/edge/cordova/events/events.startcallbutton.md
index 5f2c112..8369aeb 100644
--- a/docs/en/edge/cordova/events/events.startcallbutton.md
+++ b/docs/en/edge/cordova/events/events.startcallbutton.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
startcallbutton
===========
-This is an event that fires when the user presses the start call button.
+This event fires when the user presses the start call button.
document.addEventListener("startcallbutton", yourCallbackFunction, false);
@@ -29,7 +29,8 @@ Details
If you need to override the default start call behaviour you can register an event listener for the 'startcallbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumedownbutton.md b/docs/en/edge/cordova/events/events.volumedownbutton.md
index 8f27ce2..46a151d 100644
--- a/docs/en/edge/cordova/events/events.volumedownbutton.md
+++ b/docs/en/edge/cordova/events/events.volumedownbutton.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
volumedownbutton
===========
-This is an event that fires when the user presses the volume down button.
+This event fires when the user presses the volume down button.
document.addEventListener("volumedownbutton", yourCallbackFunction, false);
@@ -29,7 +29,8 @@ Details
If you need to override the default volume down behaviour you can register an event listener for the 'volumedownbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumeupbutton.md b/docs/en/edge/cordova/events/events.volumeupbutton.md
index 9fb38b1..afac44e 100644
--- a/docs/en/edge/cordova/events/events.volumeupbutton.md
+++ b/docs/en/edge/cordova/events/events.volumeupbutton.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
volumeupbutton
===========
-This is an event that fires when the user presses the volume up button.
+This event fires when the user presses the volume up button.
document.addEventListener("volumeupbutton", yourCallbackFunction, false);
@@ -29,7 +29,8 @@ Details
If you need to override the default volume up behaviour you can register an event listener for the 'volumeupbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Applications typically should use `document.addEventListener` to
+attach an event listener once the Cordova `deviceready` event fires.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index 8b11012..24d2967 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -51,7 +51,6 @@ The following methods can be invoked on a DirectoryEntry object:
- __getFile__: Create or look up a file.
- __removeRecursively__: Delete a directory and all of its contents.
-
Supported Platforms
-------------------
@@ -71,7 +70,6 @@ __Parameters:__
- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_
-
__Quick Example__
function success(metadata) {
@@ -97,7 +95,6 @@ __Parameters:__
- __errorCallback__ - A callback that is called when the metadata was not successfully set. _(Function)_
- __metadataObject__ - An object that contains the metadata keys and values. _(Object)_
-
__Quick Example__
function success() {
@@ -116,7 +113,7 @@ __iOS Quirk__
__Quick Example__
- function setFolderMetadata(localFileSystem, subFolder, metadataKey, metadataValue)
+ function setFolderMetadata(localFileSystem, subFolder, metadataKey, metadataValue)
{
var onSetMetadataWin = function() {
console.log("success setting metadata")
@@ -166,7 +163,6 @@ __Parameters:__
- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_
- __errorCallback__ - A callback that is called if an error occurs when attempting to move the directory. Invoked with a FileError object. _(Function)_
-
__Quick Example__
function success(entry) {
@@ -204,7 +200,6 @@ __Parameters:__
- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_
- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the underlying directory. Invoked with a FileError object. _(Function)_
-
__Quick Example__
function win(entry) {
@@ -225,7 +220,6 @@ __Quick Example__
entry.copyTo(parentEntry, newName, success, fail);
}
-
toURL
-----
@@ -237,7 +231,6 @@ __Quick Example__
var dirURL = entry.toURL();
console.log(dirURL);
-
remove
------
@@ -264,7 +257,6 @@ __Quick Example__
// remove this directory
entry.remove(success, fail);
-
getParent
---------
@@ -288,7 +280,6 @@ __Quick Example__
// Get the parent DirectoryEntry
entry.getParent(success, fail);
-
createReader
------------
@@ -299,7 +290,6 @@ __Quick Example__
// create a directory reader
var directoryReader = entry.createReader();
-
getDirectory
------------
@@ -327,7 +317,6 @@ __Quick Example__
// Retrieve an existing directory, or create it if it does not already exist
entry.getDirectory("newDir", {create: true, exclusive: false}, success, fail);
-
getFile
-------
@@ -355,7 +344,6 @@ __Quick Example__
// Retrieve an existing file, or create it if it does not exist
entry.getFile("newFile.txt", {create: true, exclusive: false}, success, fail);
-
removeRecursively
-----------------
@@ -394,4 +382,4 @@ May fail with a ControlledAccessException in the following cases:
- if device is connected by usb
-> solution: disconnect usb cable from device and run again
+> solution: disconnect usb cable from device and run again
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryreader/directoryreader.md b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
index ad69669..2e88be1 100644
--- a/docs/en/edge/cordova/file/directoryreader/directoryreader.md
+++ b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
@@ -25,8 +25,7 @@ An object that lists files and directories in a directory. Defined in the [Dire
Methods
-------
-- __readEntries__: Read the entries in a directory.
-
+- __readEntries__: Read the entries in a directory.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileentry/fileentry.md b/docs/en/edge/cordova/file/fileentry/fileentry.md
index 474fd68..b329d0c 100644
--- a/docs/en/edge/cordova/file/fileentry/fileentry.md
+++ b/docs/en/edge/cordova/file/fileentry/fileentry.md
@@ -34,7 +34,6 @@ NOTE: The following attributes are defined by the W3C specification, but are __n
- __filesystem:__ The file system on which the FileEntry resides. _(FileSystem)_
-
Methods
-------
@@ -48,7 +47,6 @@ Methods
- __createWriter__: Creates a FileWriter object that can be used to write to a file.
- __file__: Creates a File object containing file properties.
-
Supported Platforms
-------------------
@@ -58,7 +56,6 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-
getMetadata
----------------
@@ -69,7 +66,6 @@ __Parameters:__
- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_
-
__Quick Example__
function success(metadata) {
@@ -83,7 +79,6 @@ __Quick Example__
// Request the metadata object for this entry
entry.getMetadata(success, fail);
-
setMetadata
----------------
@@ -96,7 +91,6 @@ __Parameters:__
- __errorCallback__ - A callback that is called when the metadata was not successfully set. _(Function)_
- __metadataObject__ - An object that contains the metadata keys and values. _(Object)_
-
__Quick Example__
function success() {
@@ -115,7 +109,7 @@ __iOS Quirk__
__Quick Example__
- function setFileMetadata(localFileSystem, filePath, metadataKey, metadataValue)
+ function setFileMetadata(localFileSystem, filePath, metadataKey, metadataValue)
{
var onSetMetadataWin = function() {
console.log("success setting metadata")
@@ -163,7 +157,6 @@ __Parameters:__
- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a FileError object. _(Function)_
-
__Quick Example__
function success(entry) {
@@ -183,7 +176,6 @@ __Quick Example__
entry.moveTo(parentEntry, "newFile.txt", success, fail);
}
-
copyTo
------
@@ -198,7 +190,6 @@ __Parameters:__
- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a FileError object. _(Function)_
-
__Quick Example__
function win(entry) {
@@ -218,7 +209,6 @@ __Quick Example__
entry.copyTo(parentEntry, "file.copy", success, fail);
}
-
toURL
-----
@@ -230,7 +220,6 @@ __Quick Example__
var fileURL = entry.toURL();
console.log(fileURL);
-
remove
------
@@ -254,7 +243,6 @@ __Quick Example__
// remove the file
entry.remove(success, fail);
-
getParent
---------
@@ -278,7 +266,6 @@ __Quick Example__
// Get the parent DirectoryEntry
entry.getParent(success, fail);
-
createWriter
------------
@@ -302,7 +289,6 @@ __Quick Example__
// create a FileWriter to write to the file
entry.createWriter(success, fail);
-
file
----
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileerror/fileerror.md b/docs/en/edge/cordova/file/fileerror/fileerror.md
index 75511c5..78ab485 100644
--- a/docs/en/edge/cordova/file/fileerror/fileerror.md
+++ b/docs/en/edge/cordova/file/fileerror/fileerror.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
FileError
========
-A 'FileError' object is set when an error occurs in any of the File API methods.
+A 'FileError' object is set when an error occurs in any of the File API methods.
Properties
----------
@@ -46,4 +46,4 @@ Constants
Description
-----------
-The `FileError` object is the only parameter of any of the File API's error callbacks. Developers must read the code property to determine the type of error.
\ No newline at end of file
+The `FileError` object is the only parameter of any of the File API's error callbacks. Developers must read the code property to determine the type of error.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileobj/fileobj.md b/docs/en/edge/cordova/file/fileobj/fileobj.md
index a24ff82..7455289 100644
--- a/docs/en/edge/cordova/file/fileobj/fileobj.md
+++ b/docs/en/edge/cordova/file/fileobj/fileobj.md
@@ -50,7 +50,6 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-
slice
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filereader/filereader.md b/docs/en/edge/cordova/file/filereader/filereader.md
index 1cc6cfb..b06976c 100644
--- a/docs/en/edge/cordova/file/filereader/filereader.md
+++ b/docs/en/edge/cordova/file/filereader/filereader.md
@@ -39,7 +39,7 @@ Methods
-------
- __abort__: Aborts reading file.
-- __readAsDataURL__: Read file and return data as a base64 encoded data url.
+- __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.
@@ -58,13 +58,12 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Read As Data URL
+Read As Data URL
----------------
__Parameters:__
- file - the file object to read
-
Quick Example
-------------
@@ -206,7 +205,6 @@ Currently supported on iOS and Android only.
__Parameters:__
- file - the file object to read
-
Quick Example
-------------
@@ -225,7 +223,6 @@ Quick Example
entry.file(win, fail);
-
Read As Array Buffer
--------------------
@@ -234,7 +231,6 @@ Currently supported on iOS and Android only.
__Parameters:__
- file - the file object to read
-
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfer/filetransfer.md b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
index 222072d..6b8e864 100644
--- a/docs/en/edge/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
@@ -30,14 +30,14 @@ Properties
Methods
-------
-- __upload__: sends a file to a server.
+- __upload__: sends a file to a server.
- __download__: downloads a file from server.
- __abort__: Aborts an in-progress transfer.
Details
-------
-The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback will be called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object.
+The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback is called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object.
It is also possible to download a file from remote and save it on the device (only iOS and Android).
Supported Platforms
@@ -90,7 +90,7 @@ __Quick Example__
var ft = new FileTransfer();
ft.upload(fileURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
-
+
__Full Example__
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
@@ -112,7 +112,7 @@ __Full Example__
// Retrieve image file location from specified source
navigator.camera.getPicture(uploadPhoto,
function(message) { alert('get picture failed'); },
- { quality: 50,
+ { quality: 50,
destinationType: navigator.camera.DestinationType.FILE_URI,
sourceType: navigator.camera.PictureSourceType.PHOTOLIBRARY }
);
@@ -154,7 +154,7 @@ __Full Example__
<p>Upload File</p>
</body>
</html>
-
+
__Setting Upload Headers__
Supported on Android and iOS
@@ -183,7 +183,7 @@ Supported on Android and iOS
options.headers = headers;
var ft = new FileTransfer();
- ft.upload(fileURI, uri, win, fail, options);
+ ft.upload(fileURI, uri, win, fail, options);
__Android Quirks__
@@ -230,7 +230,7 @@ __Quick Example__
abort
--------------
-Aborts an in-progress transfer. The onerror callback will be called with a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
+Aborts an in-progress transfer. The onerror callback is called with a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
__Supported Platforms__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
index 5246ce8..feeb2e3 100644
--- a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -32,7 +32,6 @@ Properties
- __chunkedMode:__ Should the data be uploaded in chunked streaming mode. If not set defaults to "true". (Boolean)
- __headers:__ A map of header name => header value. To specify multiple values for a header, use an array of values. (Object)
-
Description
-----------
@@ -42,4 +41,4 @@ WP7 Quirk
---------
- __chunkedMode:__
- This parameter is ignored on WP7.
+ This parameter is ignored on WP7.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md b/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
index f21d036..05abd59 100644
--- a/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
@@ -36,5 +36,5 @@ The `FileUploadResult` object is returned via the success callback of the FileTr
iOS Quirks
----------
-- iOS does not include values for responseCode nor bytesSent in the success callback FileUploadResult object.
+- iOS does not include values for responseCode nor bytesSent in the success callback FileUploadResult object.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filewriter/filewriter.md b/docs/en/edge/cordova/file/filewriter/filewriter.md
index a7c2976..704347b 100644
--- a/docs/en/edge/cordova/file/filewriter/filewriter.md
+++ b/docs/en/edge/cordova/file/filewriter/filewriter.md
@@ -40,7 +40,7 @@ Properties
Methods
-------
-- __abort__: Aborts writing file.
+- __abort__: Aborts writing file.
- __seek__: Moves the file pointer to the byte specified.
- __truncate__: Shortens the file to the length specified.
- __write__: Writes data to the file with a UTF-8 encoding.
@@ -169,7 +169,7 @@ Full Example
function gotFileWriter(writer) {
writer.onwriteend = function(evt) {
console.log("contents of file now 'some sample text'");
- writer.truncate(11);
+ writer.truncate(11);
writer.onwriteend = function(evt) {
console.log("contents of file now 'some sample'");
writer.seek(4);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
index 5d1b7c2..8d8ff37 100644
--- a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
+++ b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
@@ -70,7 +70,6 @@ Resolve Local File System URI Quick Example
Full Example
------------
-
<!DOCTYPE html>
<html>
<head>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
index db0413f..62808be 100644
--- a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
+++ b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
@@ -120,8 +120,8 @@ Full Example
<div id="myDiv"></div>
</body>
</html>
-
+
Android Quirks
-------------
-__altitudeAccuracy:__ This property is not support by Android devices, it will always return null.
+__altitudeAccuracy:__ Not supported by Android devices, returning `null`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Position/position.md b/docs/en/edge/cordova/geolocation/Position/position.md
index 13974d9..abab68d 100644
--- a/docs/en/edge/cordova/geolocation/Position/position.md
+++ b/docs/en/edge/cordova/geolocation/Position/position.md
@@ -102,7 +102,7 @@ Full Example
'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
'Heading: ' + position.coords.heading + '<br />' +
'Speed: ' + position.coords.speed + '<br />' +
- 'Timestamp: ' +
+ 'Timestamp: ' +
position.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md b/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
index fb74c9c..50e5896 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
@@ -58,7 +58,6 @@ Quick Example
navigator.geolocation.clearWatch(watchID);
-
Full Example
------------
@@ -95,7 +94,7 @@ Full Example
}
// clear the watch that was started earlier
- //
+ //
function clearWatch() {
if (watchID != null) {
navigator.geolocation.clearWatch(watchID);
@@ -114,6 +113,6 @@ Full Example
</head>
<body>
<p id="geolocation">Watching geolocation...</p>
- <button onclick="clearWatch();">Clear Watch</button>
+ <button onclick="clearWatch();">Clear Watch</button>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
index 515524f..3831afd 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -22,8 +22,8 @@ geolocation.getCurrentPosition
Returns the device's current position as a `Position` object.
- navigator.geolocation.getCurrentPosition(geolocationSuccess,
- [geolocationError],
+ navigator.geolocation.getCurrentPosition(geolocationSuccess,
+ [geolocationError],
[geolocationOptions]);
Parameters
@@ -38,7 +38,6 @@ Description
`geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `geolocationSuccess` callback with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
-
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.md b/docs/en/edge/cordova/geolocation/geolocation.md
index ae1e8ab..aaa0f93 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.md
@@ -33,7 +33,6 @@ Methods
- geolocation.watchPosition
- geolocation.clearWatch
-
Arguments
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
index af9685b..bba8212 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
@@ -79,7 +79,6 @@ Quick Example
// Options: throw an error if no update is received every 30 seconds.
//
var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
-
Full Example
------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
index 3427f00..646fac7 100644
--- a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
+++ b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -66,7 +66,7 @@ Full Example
function successCB(date) {
alert('month:' + date.month +
- ' day:' + date.day +
+ ' day:' + date.day +
' year:' + date.year + '\n');
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.dateToString.md b/docs/en/edge/cordova/globalization/globalization.dateToString.md
index 11b7fc6..19c6c18 100644
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.md
@@ -23,7 +23,7 @@ globalization.dateToString
Returns a date formatted as a string according to the client's locale and timezone.
navigator.globalization.dateToString(date, successCB, errorCB, options);
-
+
Description
-----------
@@ -39,7 +39,6 @@ If there is an error formatting the date, then the errorCB callback is invoked w
The default options are `{formatLength:'short', selector:'date and time'}`.
The `options` parameter is optional.
-
Supported Platforms
-------------------
@@ -85,7 +84,6 @@ Full Example
</body>
</html>
-
Windows Phone 8 Quirks
--------------
- `formatLength` option supports only short and full values
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
index 4dc36f4..2f591cc 100644
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@ -24,7 +24,7 @@ Returns a pattern string for formatting and parsing currency values according
to the client's user preferences and ISO 4217 currency code.
navigator.globalization.getCurrencyPattern(currencyCode, successCB, errorCB);
-
+
Description
-----------
@@ -73,7 +73,6 @@ In the case when the browser is set to the en\_US locale and the selected curren
function () {alert('Error getting pattern\n');}
);
-
Full Example
------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDateNames.md b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
index a9df19e..92db64a 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -37,7 +37,6 @@ If there is an error obtaining the names, then the errorCB callback is invoked w
The default options are `{type:'wide', item:'months'}`.
The options parameter is optional.
-
Supported Platforms
-------------------
@@ -61,7 +60,6 @@ In the case when the browser is set to the en\_US locale, this should display a
{type:'wide', item:'months'}
);
-
Full Example
------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
index ffc8154..810723d 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -31,7 +31,6 @@ The days of the week are numbered starting from 1 where 1 is considered to be Su
If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
-
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
index efff846..046efa4 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -33,7 +33,6 @@ properties object as a parameter. That object should have a ``value`` property w
If there is an error getting the locale, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
-
Supported Platforms
-------------------
@@ -42,7 +41,6 @@ Supported Platforms
- iPhone
- Windows Phone 8
-
Quick Example
-------------
@@ -78,4 +76,4 @@ Full Example
Windows Phone 8 Quirks
---------------------
-- Returns the two-letter code defined in ISO 3166 for the current country/region.
\ No newline at end of file
+- 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/6899777b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
index 8d9a6c1..5be264f 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -43,7 +43,6 @@ If there is an error obtaining the pattern, then the errorCB callback is invoked
`options.type` can be 'decimal', 'percent', or 'currency'.
The default options are `{type:'decimal'}`. The `options` parameter is optional.
-
Supported Platforms
-------------------
@@ -61,7 +60,7 @@ In the case when the browser is set to the en\_US locale, this should display a
symbol: .
fraction: 0
rounding: 0
- positive:
+ positive:
negative: -
decimal: .
grouping: ,
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
index 1596f1f..51cb84d 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -41,7 +41,6 @@ Supported Platforms
- iPhone
- Windows Phone 8
-
Quick Example
-------------
@@ -75,7 +74,6 @@ Full Example
</body>
</html>
-
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/6899777b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToDate.md b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
index c357a3f..07478ec 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
@@ -49,7 +49,6 @@ The options parameter is optional.
If there is an error parsing the date string, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
-
Supported Platforms
-------------------
@@ -66,13 +65,12 @@ In the case when the browser is set to the en\_US locale, this should display a
navigator.globalization.stringToDate(
'9/25/2012',
function (date) {alert('month:' + date.month +
- ' day:' + date.day +
+ ' day:' + date.day +
' year:' + date.year + '\n');},
function () {alert('Error getting date\n');},
{selector:'date'}
);
-
Full Example
------------
@@ -87,7 +85,7 @@ Full Example
navigator.globalization.stringToDate(
'9/25/2012',
function (date) {alert('month:' + date.month +
- ' day:' + date.day +
+ ' day:' + date.day +
' year:' + date.year + '\n');},
function () {alert('Error getting date\n');},
{selector:'date'}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
index bce3a7c..65a4cca 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
@@ -34,7 +34,6 @@ If there is an error parsing the number string, then the errorCB callback is inv
`options.type` can be 'decimal', 'percent', or 'currency'.
The default options are `{type:'decimal'}`. The `options` parameter is optional.
-
Supported Platforms
-------------------
@@ -55,7 +54,6 @@ In the case when the browser is set to the en\_US locale, this should display a
{type:'decimal'}
);
-
Full Example
------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/inappbrowser.md b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
index abe3b4d..c8df9ac 100644
--- a/docs/en/edge/cordova/inappbrowser/inappbrowser.md
+++ b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
@@ -51,15 +51,12 @@ Permissions
<plugin name="InAppBrowser" value="CDVInAppBrowser" />
-
### Windows Phone 7 + 8
#### config.xml
<plugin name="InAppBrowser" />
-
-
addEventListener
================
@@ -278,7 +275,7 @@ executeScript
"code" - Text of the script to inject
- __callback:__ the function that is to be called in the Cordova application after the JavaScript code is injected.
- - If the injected script is of type "code", then the callback will be called with a single argument, which is
+ - If the injected script is of type "code", then the callback is called with a single argument, which is
the return value of the script, wrapped in an Array. (For multi-line scripts, this is the return value of the
last statement, or the last expression evaluated.)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/inappbrowser/window.open.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/window.open.md b/docs/en/edge/cordova/inappbrowser/window.open.md
index 60fb50e..2652edb 100644
--- a/docs/en/edge/cordova/inappbrowser/window.open.md
+++ b/docs/en/edge/cordova/inappbrowser/window.open.md
@@ -28,9 +28,9 @@ Opens a URL in a new InAppBrowser instance, the current browser instance, or the
- __url:__ the URL to load (`String`). Call encodeURI() on this if you have Unicode characters in your URL.
- __target:__ the target to load the URL in (`String`) (Optional, Default: "_self")
- _self - opens in the Cordova WebView if url is in the white-list, else it opens in the InAppBrowser
- _blank - always open in the InAppBrowser
- _system - always open in the system web browser
+ _self - opens in the Cordova WebView if URL is in the white-list, else it opens in the InAppBrowser
+ _blank - always open in the InAppBrowser
+ _system - always open in the system web browser
- __options:__ options for the InAppBrowser (`String`) (Optional, Default: "location=yes")
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/MediaError/mediaError.md b/docs/en/edge/cordova/media/MediaError/mediaError.md
index ab79258..d0a1d8f 100644
--- a/docs/en/edge/cordova/media/MediaError/mediaError.md
+++ b/docs/en/edge/cordova/media/MediaError/mediaError.md
@@ -36,7 +36,6 @@ Constants
- `MediaError.MEDIA_ERR_DECODE`
- `MediaError.MEDIA_ERR_NONE_SUPPORTED`
-
Description
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureCB.md b/docs/en/edge/cordova/media/capture/CaptureCB.md
index 5f31fd0..8182554 100644
--- a/docs/en/edge/cordova/media/capture/CaptureCB.md
+++ b/docs/en/edge/cordova/media/capture/CaptureCB.md
@@ -29,7 +29,7 @@ Description
This function is invoked after a successful capture operation has completed. This means a media file has been captured, and either the user has exited the media capture application, or the capture limit has been reached.
-Each MediaFile object describes a captured media file.
+Each MediaFile object describes a captured media file.
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureError.md b/docs/en/edge/cordova/media/capture/CaptureError.md
index 5f98d51..d94f885 100644
--- a/docs/en/edge/cordova/media/capture/CaptureError.md
+++ b/docs/en/edge/cordova/media/capture/CaptureError.md
@@ -30,7 +30,7 @@ Properties
Constants
---------
-- CaptureError.`CAPTURE_INTERNAL_ERR`: Camera or microphone failed to capture image or sound.
+- CaptureError.`CAPTURE_INTERNAL_ERR`: Camera or microphone failed to capture image or sound.
- CaptureError.`CAPTURE_APPLICATION_BUSY`: Camera application or audio capture application is currently serving other capture request.
- CaptureError.`CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. limit parameter has value less than one).
- CaptureError.`CAPTURE_NO_MEDIA_FILES`: User exited camera application or audio capture application before capturing anything.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/ConfigurationData.md b/docs/en/edge/cordova/media/capture/ConfigurationData.md
index c166b3e..46fc55a 100644
--- a/docs/en/edge/cordova/media/capture/ConfigurationData.md
+++ b/docs/en/edge/cordova/media/capture/ConfigurationData.md
@@ -25,7 +25,7 @@ ConfigurationData
Description
-----------
-This object is used to describe media capture modes supported by the device. The configuration data includes the MIME type, and capture dimensions (for video or image capture).
+This object is used to describe media capture modes supported by the device. The configuration data includes the MIME type, and capture dimensions (for video or image capture).
The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). Examples:
@@ -33,7 +33,7 @@ The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt).
- video/quicktime
- image/jpeg
- audio/amr
-- audio/wav
+- audio/wav
Properties
----------
@@ -58,5 +58,4 @@ Quick Example
}
}
-
-Not supported by any platform. All configuration data arrays are empty.
\ No newline at end of file
+Not supported by any platform. All configuration data arrays are empty.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md b/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
index 7861fee..a86e3fa 100644
--- a/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
@@ -22,8 +22,8 @@ MediaFile.getFormatData
> Retrieves format information about the media capture file.
- mediaFile.getFormatData(
- MediaFileDataSuccessCB successCallback,
+ mediaFile.getFormatData(
+ MediaFileDataSuccessCB successCallback,
[MediaFileDataErrorCB errorCallback]
);
@@ -51,4 +51,4 @@ The API for retrieving media file format information is limited. Therefore, not
iOS Quirks
----------
-The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
\ No newline at end of file
+The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFileData.md b/docs/en/edge/cordova/media/capture/MediaFileData.md
index 93ed349..b29908c 100644
--- a/docs/en/edge/cordova/media/capture/MediaFileData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFileData.md
@@ -47,8 +47,8 @@ Support for the MediaFileData properties is as follows:
- __codecs:__ Not supported. The attribute will always be null.
- __bitrate:__ Not supported. The attribute will always be 0.
-- __height:__ Supported. (Image and video files only).
-- __width:__ Supported. (Image and video files only).
+- __height:__ Supported. (Image and video files only).
+- __width:__ Supported. (Image and video files only).
- __duration:__ Supported. (Audio and video files only).
iOS Quirks
@@ -57,6 +57,6 @@ Support for the MediaFileData properties is as follows:
- __codecs:__ Not supported. The attribute will always be null.
- __bitrate:__ Supported on iOS4 devices for audio only. The attribute will always be 0 for image and video.
-- __height:__ Supported. (Image and video files only).
-- __width:__ Supported. (Image and video files only).
-- __duration:__ Supported. (Audio and video files only).
\ No newline at end of file
+- __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/6899777b/docs/en/edge/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/capture.md b/docs/en/edge/cordova/media/capture/capture.md
index 088277a..ebef5cc 100644
--- a/docs/en/edge/cordova/media/capture/capture.md
+++ b/docs/en/edge/cordova/media/capture/capture.md
@@ -65,7 +65,6 @@ Methods
- capture.captureImage: Launch the device camera application for taking image(s).
- capture.captureVideo: Launch the device video recorder application for recording video(s).
-
Supported Platforms
-------------------
@@ -87,7 +86,7 @@ Permissions
#### app/AndroidManifest.xml
<uses-permission android:name="android.permission.RECORD_AUDIO" />
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
### Bada
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudio.md b/docs/en/edge/cordova/media/capture/captureAudio.md
index 999f933..ad17b46 100644
--- a/docs/en/edge/cordova/media/capture/captureAudio.md
+++ b/docs/en/edge/cordova/media/capture/captureAudio.md
@@ -22,7 +22,7 @@ capture.captureAudio
> Start the audio recorder application and return information about captured audio clip file(s).
- navigator.device.capture.captureAudio(
+ navigator.device.capture.captureAudio(
CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
);
@@ -82,11 +82,11 @@ Full Example
var i, len;
for (i = 0, len = mediaFiles.length; i < len; i += 1) {
uploadFile(mediaFiles[i]);
- }
+ }
}
// Called if something bad happens.
- //
+ //
function captureError(error) {
var msg = 'An error occurred during capture: ' + error.code;
navigator.notification.alert(msg, null, 'Uh oh!');
@@ -95,7 +95,7 @@ Full Example
// A button will call this function
//
function captureAudio() {
- // Launch device audio recording application,
+ // Launch device audio recording application,
// allowing user to capture up to 2 audio clips
navigator.device.capture.captureAudio(captureSuccess, captureError, {limit: 2});
}
@@ -115,7 +115,7 @@ Full Example
function(error) {
console.log('Error uploading file ' + path + ': ' + error.code);
},
- { fileName: name });
+ { fileName: name });
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureImage.md b/docs/en/edge/cordova/media/capture/captureImage.md
index 15ab602..e88aad0 100644
--- a/docs/en/edge/cordova/media/capture/captureImage.md
+++ b/docs/en/edge/cordova/media/capture/captureImage.md
@@ -22,7 +22,7 @@ capture.captureImage
> Start the camera application and return information about captured image file(s).
- navigator.device.capture.captureImage(
+ navigator.device.capture.captureImage(
CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
);
@@ -89,11 +89,11 @@ Full Example
var i, len;
for (i = 0, len = mediaFiles.length; i < len; i += 1) {
uploadFile(mediaFiles[i]);
- }
+ }
}
// Called if something bad happens.
- //
+ //
function captureError(error) {
var msg = 'An error occurred during capture: ' + error.code;
navigator.notification.alert(msg, null, 'Uh oh!');
@@ -102,7 +102,7 @@ Full Example
// A button will call this function
//
function captureImage() {
- // Launch device camera application,
+ // Launch device camera application,
// allowing user to capture up to 2 images
navigator.device.capture.captureImage(captureSuccess, captureError, {limit: 2});
}
@@ -122,7 +122,7 @@ Full Example
function(error) {
console.log('Error uploading file ' + path + ': ' + error.code);
},
- { fileName: name });
+ { fileName: name });
}
</script>
@@ -132,13 +132,12 @@ Full Example
</body>
</html>
-
Bada Quirks
-----------
Bada supports _captureImage_ just like the other platforms. However there is _another_ mode where you can capture a video or an image straight in the webview without launching any camera app. In order to do that you need to:
-1. create a _<div>_ element somewhere in your document and give it an id (such as "preview").
+1. create a _<div>_ element somewhere in your document and give it an id (such as "preview").
<div id="preview"></div>
[39/46] docs commit: "iPhone" => "iOS" when referenced as platform
Posted by mw...@apache.org.
"iPhone" => "iOS" when referenced as platform
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/0c0ab55f
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/0c0ab55f
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/0c0ab55f
Branch: refs/heads/master
Commit: 0c0ab55f3e2e9d5d763ff3203ba744b315fecd35
Parents: cf1dce9
Author: Mike Sierra <le...@gmail.com>
Authored: Wed May 29 15:05:45 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Wed May 29 15:05:45 2013 -0400
----------------------------------------------------------------------
docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md | 2 +-
.../accelerometer/accelerometer.getCurrentAcceleration.md | 6 +++---
.../cordova/accelerometer/accelerometer.watchAcceleration.md | 4 ++--
docs/en/edge/cordova/compass/compass.clearWatch.md | 2 +-
docs/en/edge/cordova/compass/compass.getCurrentHeading.md | 2 +-
docs/en/edge/cordova/compass/compass.watchHeading.md | 2 +-
docs/en/edge/cordova/contacts/contacts.find.md | 2 +-
docs/en/edge/cordova/device/device.cordova.md | 2 +-
docs/en/edge/cordova/device/device.model.md | 2 +-
docs/en/edge/cordova/device/device.uuid.md | 2 +-
docs/en/edge/cordova/device/device.version.md | 2 +-
.../edge/cordova/globalization/globalization.dateToString.md | 2 +-
.../cordova/globalization/globalization.getCurrencyPattern.md | 2 +-
.../edge/cordova/globalization/globalization.getDateNames.md | 2 +-
.../edge/cordova/globalization/globalization.getDatePattern.md | 2 +-
.../cordova/globalization/globalization.getFirstDayOfWeek.md | 2 +-
.../edge/cordova/globalization/globalization.getLocaleName.md | 2 +-
.../cordova/globalization/globalization.getNumberPattern.md | 2 +-
.../globalization/globalization.getPreferredLanguage.md | 2 +-
.../globalization/globalization.isDayLightSavingsTime.md | 2 +-
.../edge/cordova/globalization/globalization.numberToString.md | 2 +-
.../edge/cordova/globalization/globalization.stringToDate.md | 2 +-
.../edge/cordova/globalization/globalization.stringToNumber.md | 2 +-
docs/en/edge/cordova/notification/notification.alert.md | 4 ++--
docs/en/edge/cordova/notification/notification.beep.md | 4 ++--
docs/en/edge/cordova/notification/notification.confirm.md | 2 +-
docs/en/edge/cordova/notification/notification.prompt.md | 2 +-
docs/en/edge/cordova/notification/notification.vibrate.md | 4 ++--
docs/en/edge/cordova/storage/database/database.md | 2 +-
docs/en/edge/cordova/storage/localstorage/localstorage.md | 2 +-
docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md | 2 +-
.../cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md | 2 +-
docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md | 2 +-
docs/en/edge/cordova/storage/storage.opendatabase.md | 2 +-
34 files changed, 40 insertions(+), 40 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
index 3568cf0..1706433 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
@@ -31,7 +31,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 7 and 8
- Bada 1.2 & 2.x
- Tizen
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index 6b8a936..f65d262 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -39,7 +39,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 7 and 8
- Bada 1.2 & 2.x
- Tizen
@@ -105,9 +105,9 @@ Full Example
</body>
</html>
-iPhone Quirks
+iOS Quirks
-------------
-- iPhone doesn't recognize the concept of getting the current acceleration at any given point.
+- 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 Cordova `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
index 074687d..e4cfb48 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -48,7 +48,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 7 and 8
- Bada 1.2 & 2.x
- Tizen
@@ -138,7 +138,7 @@ Full Example
</body>
</html>
- iPhone Quirks
+ iOS Quirks
-------------
- Cordova calls the success callback function at the interval
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.clearWatch.md b/docs/en/edge/cordova/compass/compass.clearWatch.md
index c270820..ee29909 100755
--- a/docs/en/edge/cordova/compass/compass.clearWatch.md
+++ b/docs/en/edge/cordova/compass/compass.clearWatch.md
@@ -30,7 +30,7 @@ Supported Platforms
-------------------
- Android
-- iPhone
+- iOS
- Windows Phone 7 and 8 ( if available in hardware )
- Bada 1.2 & 2.x
- webOS
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
index 2e98fb2..89fd4b7 100755
--- a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
+++ b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
@@ -38,7 +38,7 @@ Supported Platforms
-------------------
- Android
-- iPhone
+- iOS
- Windows Phone 7 and 8 ( if available in hardware )
- Bada 1.2 & 2.x
- webOS
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeading.md b/docs/en/edge/cordova/compass/compass.watchHeading.md
index c617c60..ae59f8f 100755
--- a/docs/en/edge/cordova/compass/compass.watchHeading.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeading.md
@@ -44,7 +44,7 @@ Supported Platforms
-------------------
- Android
-- iPhone
+- iOS
- Windows Phone 7 and 8 (if available in hardware)
- Bada 1.2 & 2.x
- webOS
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.find.md b/docs/en/edge/cordova/contacts/contacts.find.md
index 1668642..c6cb70f 100644
--- a/docs/en/edge/cordova/contacts/contacts.find.md
+++ b/docs/en/edge/cordova/contacts/contacts.find.md
@@ -49,7 +49,7 @@ _any_ of the specified fields, the contact is returned.
Parameters
----------
-- __contactFields__: Contact fields to use as a search qualifier. Only these fields will have values in the resulting `Contact` objects. _(DOMString[])_ [Required]
+- __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]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.cordova.md b/docs/en/edge/cordova/device/device.cordova.md
index 94d9df0..7156fba 100644
--- a/docs/en/edge/cordova/device/device.cordova.md
+++ b/docs/en/edge/cordova/device/device.cordova.md
@@ -34,7 +34,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 7 and 8
- Bada 1.2 & 2.x
- Tizen
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/device/device.model.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.model.md b/docs/en/edge/cordova/device/device.model.md
index b645772..d1b76c5 100644
--- a/docs/en/edge/cordova/device/device.model.md
+++ b/docs/en/edge/cordova/device/device.model.md
@@ -49,7 +49,7 @@ Quick Example
// Android: Nexus One returns "Passion" (Nexus One code name)
// Motorola Droid returns "voles"
// BlackBerry: Torch 9800 returns "9800"
- // iOS: for the iPad Mini, will return iPad2,5. iPhone 5 is iPhone 5,1. See http://theiphonewiki.com/wiki/index.php?title=Models
+ // iOS: for the iPad Mini, returns iPad2,5; iPhone 5 is iPhone 5,1. See http://theiphonewiki.com/wiki/index.php?title=Models
//
var model = device.model;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.uuid.md b/docs/en/edge/cordova/device/device.uuid.md
index 90d598c..0f9c073 100644
--- a/docs/en/edge/cordova/device/device.uuid.md
+++ b/docs/en/edge/cordova/device/device.uuid.md
@@ -34,7 +34,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 7 and 8
- Bada 1.2 & 2.x
- webOS
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.version.md b/docs/en/edge/cordova/device/device.version.md
index 8304536..4823491 100644
--- a/docs/en/edge/cordova/device/device.version.md
+++ b/docs/en/edge/cordova/device/device.version.md
@@ -29,7 +29,7 @@ Supported Platforms
- Android 2.1+
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 7 and 8
- Bada 1.2 & 2.x
- webOS
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.dateToString.md b/docs/en/edge/cordova/globalization/globalization.dateToString.md
index 9c0c403..2a762c3 100644
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.md
@@ -48,7 +48,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
index 35bb96e..5b0cf93 100644
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@ -50,7 +50,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDateNames.md b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
index 656be1d..95a0abe 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -50,7 +50,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
index 5a07c55..6e8da83 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
@@ -53,7 +53,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
index 49f9156..3e24523 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -42,7 +42,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
index fbe0689..204a634 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -41,7 +41,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
index f2d1031..0b59354 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -54,7 +54,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
index 7370832..64328f8 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -41,7 +41,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
index e6541cf..63156f0 100644
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -44,7 +44,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.numberToString.md b/docs/en/edge/cordova/globalization/globalization.numberToString.md
index a049999..070e42e 100644
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.numberToString.md
@@ -46,7 +46,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToDate.md b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
index 65c0c95..3bdd068 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
@@ -60,7 +60,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
index 90313c1..429a6a5 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
@@ -49,7 +49,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 8
Quick Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/notification/notification.alert.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.alert.md b/docs/en/edge/cordova/notification/notification.alert.md
index 2460ae4..4d972c6 100644
--- a/docs/en/edge/cordova/notification/notification.alert.md
+++ b/docs/en/edge/cordova/notification/notification.alert.md
@@ -41,7 +41,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 7 and 8
- Bada 1.2 & 2.x
- webOS
@@ -51,7 +51,7 @@ Supported Platforms
Quick Example
-------------
- // Android / BlackBerry WebWorks (OS 5.0 and higher) / iPhone / Tizen
+ // Android / BlackBerry WebWorks (OS 5.0 and higher) / iOS / Tizen
//
function alertDismissed() {
// do something
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.beep.md b/docs/en/edge/cordova/notification/notification.beep.md
index 803aa22..b550b2f 100644
--- a/docs/en/edge/cordova/notification/notification.beep.md
+++ b/docs/en/edge/cordova/notification/notification.beep.md
@@ -31,7 +31,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 7 and 8
- Bada 1.2 & 2.x
- Tizen
@@ -99,7 +99,7 @@ Android Quirks
- Android plays the default __Notification ringtone__ specified under the __Settings/Sound & Display__ panel.
-iPhone Quirks
+iOS Quirks
-------------
- Ignores the beep count argument.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.confirm.md b/docs/en/edge/cordova/notification/notification.confirm.md
index 4b87585..f3a6193 100755
--- a/docs/en/edge/cordova/notification/notification.confirm.md
+++ b/docs/en/edge/cordova/notification/notification.confirm.md
@@ -50,7 +50,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 7 and 8
- Bada 1.2 & 2.x
- Tizen
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.prompt.md b/docs/en/edge/cordova/notification/notification.prompt.md
index 6940458..8744b76 100644
--- a/docs/en/edge/cordova/notification/notification.prompt.md
+++ b/docs/en/edge/cordova/notification/notification.prompt.md
@@ -49,7 +49,7 @@ Supported Platforms
-------------------
- Android
-- iPhone
+- iOS
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/notification/notification.vibrate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.vibrate.md b/docs/en/edge/cordova/notification/notification.vibrate.md
index 779436a..581dfd7 100644
--- a/docs/en/edge/cordova/notification/notification.vibrate.md
+++ b/docs/en/edge/cordova/notification/notification.vibrate.md
@@ -31,7 +31,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
+- iOS
- Windows Phone 7 and 8
- Bada 1.2 & 2.x
@@ -94,7 +94,7 @@ Full Example
</body>
</html>
-iPhone Quirks
+iOS Quirks
-------------
- __time__: Ignores the specified time and vibrates for a pre-set amount of time.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/storage/database/database.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/database/database.md b/docs/en/edge/cordova/storage/database/database.md
index 7c78481..9e1a279 100644
--- a/docs/en/edge/cordova/storage/database/database.md
+++ b/docs/en/edge/cordova/storage/database/database.md
@@ -38,7 +38,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 6.0 and higher)
-- iPhone
+- iOS
- webOS
- Tizen
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/storage/localstorage/localstorage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/localstorage/localstorage.md b/docs/en/edge/cordova/storage/localstorage/localstorage.md
index 3f4fcd6..7ca3978 100644
--- a/docs/en/edge/cordova/storage/localstorage/localstorage.md
+++ b/docs/en/edge/cordova/storage/localstorage/localstorage.md
@@ -46,7 +46,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 6.0 and higher)
-- iPhone
+- iOS
- Windows Phone 7 and 8
- webOS
- Tizen
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
index 7e9a4ed..a1854d0 100644
--- a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
+++ b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
@@ -53,7 +53,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 6.0 and higher)
-- iPhone
+- iOS
- webOS
- Tizen
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
index f9ae524..8c35cb0 100644
--- a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
+++ b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
@@ -48,7 +48,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 6.0 and higher)
-- iPhone
+- iOS
- webOS
- Tizen
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
index 9ba2836..653c0ed 100644
--- a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
+++ b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
@@ -38,7 +38,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 6.0 and higher)
-- iPhone
+- iOS
- webOS
- Tizen
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0c0ab55f/docs/en/edge/cordova/storage/storage.opendatabase.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/storage.opendatabase.md b/docs/en/edge/cordova/storage/storage.opendatabase.md
index 399a79a..173bfec 100644
--- a/docs/en/edge/cordova/storage/storage.opendatabase.md
+++ b/docs/en/edge/cordova/storage/storage.opendatabase.md
@@ -35,7 +35,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 6.0 and higher)
-- iPhone
+- iOS
- webOS
- Tizen
[46/46] docs commit: Remove overview/support.html because there is a
markdown version.
Posted by mw...@apache.org.
Remove overview/support.html because there is a markdown version.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/db36946f
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/db36946f
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/db36946f
Branch: refs/heads/master
Commit: db36946f3652255d7bc6d6538f1730b40a4ec6a5
Parents: 459dba0
Author: Michael Brooks <mi...@michaelbrooks.ca>
Authored: Wed Jun 12 10:49:30 2013 -0700
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Wed Jun 12 10:49:30 2013 -0700
----------------------------------------------------------------------
docs/en/edge/guide/overview/support.html | 302 --------------------------
1 file changed, 302 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/db36946f/docs/en/edge/guide/overview/support.html
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/support.html b/docs/en/edge/guide/overview/support.html
deleted file mode 100644
index 3dd6c5c..0000000
--- a/docs/en/edge/guide/overview/support.html
+++ /dev/null
@@ -1,302 +0,0 @@
-<style>
-[data-support=y] { background-color: lightgreen }
-[data-support=p] { background-color: gold }
-[data-support=n] { background-color: pink }
-[data-support=u] { background-color: #ddd }
-</style>
-
-<table width="100%">
- <tr>
- <th></th>
- <th>Android</th>
- <th>Blackberry</th>
- <th>iOS</th>
- <th>Symbian</th>
- <th>WebOS</th>
- <th>Windows<br/>Phone 7</th>
- <th>Windows<br/>Phone 8</th>
- <th>Windows<br/>8</th>
- <th>Bada</th>
- <th>Tizen</th>
- </tr>
-
- <tr>
- <th>Accelerometer</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔ (5.x+)</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>Camera</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔ (5.x+)</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="p">✝</th>
- </tr>
-
- <tr>
- <th>Capture</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>Compass</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="n">✘</th>
- <th class="ios" data-support="y">✔ (3GS+)</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>Connection</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>Contacts</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="n">✘</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>Device</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>Events</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>File</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="n">✘</th>
- <th class="webos" data-support="n">✘</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="n">✘</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>Geolocation</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>Globalization</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>InAppBrowser</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>Media</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="n">✘</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="n">✘</th>
- <th class="webos" data-support="n">✘</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="n">✘</th>
- <th class="tizen" data-support="p">✝</th>
- </tr>
-
- <tr>
- <th>Notification</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>Splashscreen</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th>Storage</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔ (5.x+)</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="y">✔</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="y">✔</th>
- <th class="bada" data-support="n">✘</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-
- <tr>
- <th colspan="20">Other Features</th>
- </tr>
- <tr>
- <th>Command-line<br/>Interface</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="u">✝</th>
- <th class="webos" data-support="u">✝</th>
- <th class="winphone7" data-support="u">✝</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="u">✝</th>
- <th class="bada" data-support="u">✝</th>
- <th class="tizen" data-support="u">✝</th>
- </tr>
- <tr>
- <th>PhoneGap<br/>Build</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="y">✔</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="u">✝</th>
- <th class="winphone8" data-support="y">✔</th>
- <th class="win8" data-support="u">✝</th>
- <th class="bada" data-support="u">✝</th>
- <th class="tizen" data-support="u">✝</th>
- </tr>
- <tr>
- <th>Embedded<br/>WebView</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="u">✝</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="u">✝</th>
- <th class="webos" data-support="u">✝</th>
- <th class="winphone7" data-support="u">✝</th>
- <th class="winphone8" data-support="u">✝</th>
- <th class="win8" data-support="u">✝</th>
- <th class="bada" data-support="u">✝</th>
- <th class="tizen" data-support="u">✝</th>
- </tr>
- <tr>
- <th>Plug-in<br/>Interface</th>
- <th class="android" data-support="y">✔</th>
- <th class="blackberry" data-support="y">✔</th>
- <th class="ios" data-support="y">✔</th>
- <th class="symbian" data-support="u">✝</th>
- <th class="webos" data-support="y">✔</th>
- <th class="winphone7" data-support="u">✝</th>
- <th class="winphone8" data-support="u">✝</th>
- <th class="win8" data-support="u">✝</th>
- <th class="bada" data-support="y">✔</th>
- <th class="tizen" data-support="y">✔</th>
- </tr>
-</table>
[04/46] many copy edits; nonlinear search/destroy edits;
needs a more controlled pass
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/upgrading/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/ios/index.md b/docs/en/edge/guide/upgrading/ios/index.md
index fb5cf09..3a07a61 100644
--- a/docs/en/edge/guide/upgrading/ios/index.md
+++ b/docs/en/edge/guide/upgrading/ios/index.md
@@ -24,18 +24,18 @@ Please note that **Xcode 4.5 is required**. To submit to the Apple App Store, yo
## Upgrading Cordova 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)
+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**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project
-5. **Copy** the **www/cordova-2.6.0.js** file from the new project 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 (and any other files that contain the script reference) to point 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
+4. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools. You need to use 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))
+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.
## Upgrading Cordova 2.4.0 projects to 2.5.0 ##
@@ -63,7 +63,7 @@ Please note that **Xcode 4.5 is required**. To submit to the Apple App Store, yo
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))
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)**
+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.)
@@ -76,17 +76,17 @@ Please note that **Xcode 4.5 is required**. To submit to the Apple App Store, yo
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
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)**
+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>**:
<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.
-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”.
+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).
## Upgrading Cordova 2.1.0 projects to 2.2.0 ##
@@ -99,19 +99,19 @@ You can get this by accessing the **userAgent** property off the main view-contr
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)**
+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:
-
+
`update_cordova_subproject path/to/your/project/xcodeproj`
**Note** that in 2.2.0, the **bin/create** script will copy in the CordovaLib sub-project into your project now. 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 Cordova 2.0.0 projects to 2.1.0 ##
-With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit -> Refactor -> Convert to Objective-C ARC…**, **de-select libCordova.a**, then run the wizard to completion.
+With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit -> Refactor -> Convert to Objective-C ARC…**, **de-select libCordova.a**, then run the wizard to completion.
1. **Download and extract the Cordova 2.1.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.1.0)
2. **Quit Xcode** if it is running.
@@ -124,13 +124,13 @@ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Referenc
- 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)**
+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:
-
+
`update_cordova_subproject path/to/your/project/xcodeproj`
@@ -140,7 +140,7 @@ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Referenc
2. [**Create a new project**](guide_command-line_index.md.html#Command-Line%20Usage_ios) from the command-line tools - you will have to grab the assets from this new project
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)
+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
@@ -152,12 +152,12 @@ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Referenc
14. For the **#import errors**, change any **quote-based** imports in this style:
#import "CDV.h"
-
+
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)
+
+ 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
@@ -178,9 +178,9 @@ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Referenc
32. 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)"
33. Search for **"Other Linker Flags"**. For that setting, add this value below:
@@ -191,7 +191,7 @@ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Referenc
35. **Select your project** from the **Scheme** drop-down, and then select **"iPhone 5.1 Simulator"**
36. Select the **Run** button
-**NOTE:**<br />
+**NOTE:**<br />
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 Cordova 1.8.x projects to 1.9.0 ##
@@ -201,9 +201,11 @@ If your project is **not working** as expected in the Simulator, please **take a
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
-**Note:**
-
-1.9.0 supports the new **"BackupWebStorage"** boolean setting in Cordova.plist. By default, this setting is turned on, set it to "false" to turn it off - especially for 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 setting
+in `Cordova.plist`. By default, this setting is enabled, 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 Cordova 1.7.0 projects to 1.8.x ##
@@ -241,7 +243,7 @@ If you intend on using the **Capture API**, you will need the new **iPad retina-
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).
+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
@@ -274,7 +276,7 @@ If you intend on using the **Capture API**, you will need the new **iPad retina-
#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"**
+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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/upgrading/webos/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/webos/index.md b/docs/en/edge/guide/upgrading/webos/index.md
index 0307833..0fc83c4 100644
--- a/docs/en/edge/guide/upgrading/webos/index.md
+++ b/docs/en/edge/guide/upgrading/webos/index.md
@@ -29,10 +29,10 @@ This document is for people who need to upgrade their Cordova versions from an o
2. update the following line in your index.html:
change this:
- <script type="text/javascript" src="cordova-2.4.0.js"></script>
-
+ <script type="text/javascript" src="cordova-2.4.0.js"></script>
+
to:
- <script type="text/javascript" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" src="cordova-2.5.0.js"></script>
3. run the makefile to generate the newest version of the cordova-2.5.0.js file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/whitelist/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/whitelist/index.md b/docs/en/edge/guide/whitelist/index.md
index 3ce1b09..4a0d942 100644
--- a/docs/en/edge/guide/whitelist/index.md
+++ b/docs/en/edge/guide/whitelist/index.md
@@ -18,19 +18,21 @@ license: Licensed to the Apache Software Foundation (ASF) under one
---
Domain Whitelist Guide
-=====================
+======================
Overview
--------
-Domain whitelisting in Apache Cordova is a security model that controls access to outside domains, such as `http://google.com`.
-
-The default security policy is to allow all network access. Before moving your application to production, it is advised to review your application's whitelist. The application developer is encouraged to declare access to specific network domains and subdomains.
+Domain whitelisting is a security model that controls access to
+outside domains, such as `http://google.com`. Apache Cordova's
+default security policy allows access to any site. Before moving your
+application to production, you should review its whitelist and declare
+access to specific network domains and subdomains.
Specification
-------------
-Domain whitelisting lays the ground work for the [W3C Widget Access][1] specification. In the Widget Access specification, the `<access>` element is used to declare access to specific network domains. In the future, Apache Cordova will abstract the platform whitelisting implementations to the W3C Widget Access specification. However, for now each platform must implement it's own domain whitelisting.
+Domain whitelisting lays the groundwork for the [W3C Widget Access][1] specification. In the Widget Access specification, the `<access>` element is used to declare access to specific network domains. In the future, Apache Cordova will abstract the platform whitelisting implementations to the W3C Widget Access specification. However, for now each platform must implement its own domain whitelisting.
Syntax
------
@@ -60,9 +62,10 @@ Android
### Details
-The whitelisting rules are found in `res/xml/config.xml` and declared with the element `<access origin="..." />`.
+The whitelisting rules are found in `res/xml/config.xml` and declared
+with the element `<access origin="..." />`.
-Android has full support for the whitelisting syntax.
+Android fully supports whitelisting syntax.
### Syntax
@@ -73,7 +76,7 @@ Access to [google.com][2]:
Bada
----
-Domain whitelisting is unsupported on Bada. By default, all domains are accessible.
+Bada does not support domain whitelisting. By default, all domains are accessible.
BlackBerry
----------
@@ -109,9 +112,11 @@ iOS
The whitelisting rules are found in `AppName/config.xml` and declared with the element `<access origin="..." />`.
-iOS has full support for the whitelisting syntax.
+iOS fully supports whitelisting syntax.
-Note: origins specified without a protocol (i.e. `www.apache.org` instead of `http://www.apache.org`) will default to all of http, https, ftp, and ftps.
+__NOTE:__ origins specified without a protocol, such as
+`www.apache.org` rather than `http://www.apache.org`, default to all
+of the `http`, `https`, `ftp`, and `ftps` schemes.
### Syntax
@@ -125,19 +130,19 @@ Access to all subdomains and TLDs (`.com`, `.net`, etc):
Symbian
-------
-Domain whitelisting is unsupported on Symbian. By default, all domains are accessible.
+Symbian does not support domain whitelisting. By default, all domains are accessible.
webOS
-----
-Domain whitelisting is unsupported on webOS. By default, all domains are accessible.
+webOS does not support domain whitelisting. By default, all domains are accessible.
Windows Phone (7 & 8)
---------------------
The whitelisting rules are found in `config.xml` and declared with the element `<access origin="..." />`.
-Android has full support for the whitelisting syntax.
+Android fully supports whitelisting syntax.
### Syntax
@@ -150,8 +155,8 @@ Tizen
### Details
-The domain whitelisting rules are found in `config.xml` located in your application root directory.
-They are declared with the element `<access origin="..." />`.
+The application root directory's `config.xml` file specifies domain
+whitelisting rules, using the `<access origin="..." />` element.
For a complete reference, see the [Tizen Accessing External Network Resources documentation][10].
### Syntax
[11/46] docs commit: more copy edits
Posted by mw...@apache.org.
more copy edits
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/d0b74949
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/d0b74949
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/d0b74949
Branch: refs/heads/master
Commit: d0b749492f46cd4095178ceb5aa89d33458563e3
Parents: 958f8d2
Author: Mike Sierra <le...@gmail.com>
Authored: Mon Apr 29 13:03:51 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon Apr 29 13:03:51 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/cordova-webview/ios.md | 10 +++++-----
docs/en/edge/guide/getting-started/ios/index.md | 2 +-
docs/en/edge/guide/getting-started/tizen/index.md | 10 +++++-----
docs/en/edge/guide/upgrading/ios/index.md | 18 +++++++++---------
4 files changed, 20 insertions(+), 20 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d0b74949/docs/en/edge/guide/cordova-webview/ios.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/ios.md b/docs/en/edge/guide/cordova-webview/ios.md
index 323c82a..cd945ab 100644
--- a/docs/en/edge/guide/cordova-webview/ios.md
+++ b/docs/en/edge/guide/cordova-webview/ios.md
@@ -45,7 +45,7 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
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**
+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**
@@ -122,10 +122,10 @@ Using CDVViewController in your code
Adding your HTML, CSS and JavaScript assets
-------------------------------------------
-1. Create a **new folder** in your project **on disk**, for example, name it `www`
-2. Put your **HTML, CSS and JavaScript assets** into this folder
-3. **Drag and drop** the folder into the Project Navigator of Xcode
-4. **Choose** the **Create folder references for any added folders** radio button
+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`.
/*
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d0b74949/docs/en/edge/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/ios/index.md b/docs/en/edge/guide/getting-started/ios/index.md
index 3967fff..02ac381 100644
--- a/docs/en/edge/guide/getting-started/ios/index.md
+++ b/docs/en/edge/guide/getting-started/ios/index.md
@@ -243,7 +243,7 @@ references the deprecated invokeString API:
2. In the Derived Data section click the Advanced button and select Unique as the Build Location as shown:
- This is the default setting for a new Xcode install but it may have been set differently if you upgraded from an older version of Xcode.
+ This is the default setting for a new Xcode install, but it may be set differently if you upgraded from an older version of Xcode.
## Next Steps
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d0b74949/docs/en/edge/guide/getting-started/tizen/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/tizen/index.md b/docs/en/edge/guide/getting-started/tizen/index.md
index 6ccf740..0f9b268 100644
--- a/docs/en/edge/guide/getting-started/tizen/index.md
+++ b/docs/en/edge/guide/getting-started/tizen/index.md
@@ -55,14 +55,14 @@ This guide describes how to set up your development environment for Cordova and
- - Your project should now have been imported and appear **Project Explorer** view
+ - Your project should now be imported and appear in the **Project Explorer** view
- **Method #2: Use Tizen Eclipse IDE Cordova Tizen project templates**
- Launch Tizen Eclipse IDE
- Select **File → New → Tizen Web Project**
- Select **User Template** and **User defined** items
- Select one of the Tizen Cordova template (e.g: **CordovaBasicTemplate**)
- - Fill-up the **Project name** and its target **Location**
+ - Fill the **Project name** and its target **Location**
@@ -70,7 +70,7 @@ This guide describes how to set up your development environment for Cordova and
- - Your project should now have been created and appear **Project Explorer** view
+ - Your project should now appear in the **Project Explorer** view
4. Hello World
--------------
@@ -80,7 +80,7 @@ This guide describes how to set up your development environment for Cordova and
- - A widget package should have been generated in your project root directory (e.g: `cordova-basic.wgt`)
+ - A widget package should be generated in your project root directory (e.g: `cordova-basic.wgt`)
- __NOTE:__ The provided samples Tizen Cordova projects are not basic hello world applications. They contain a simple example usage of the Battery Cordova API.
@@ -94,7 +94,7 @@ This guide describes how to set up your development environment for Cordova and
5B. Deploy to Device/Emulator
--------------------
-- Make sure that your target device is properly launched/connected/configured. __Date and Time__ settings must have been set correctly.
+- Make sure that your target device is properly launched, connected and configured. Its __Date and Time__ settings must be set correctly.
- Select your application deployment target with the **Connection Explorer** view (Select **Window → Show View → Connection Explorer**.)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d0b74949/docs/en/edge/guide/upgrading/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/upgrading/ios/index.md b/docs/en/edge/guide/upgrading/ios/index.md
index e35fd0d..08543ed 100644
--- a/docs/en/edge/guide/upgrading/ios/index.md
+++ b/docs/en/edge/guide/upgrading/ios/index.md
@@ -170,7 +170,7 @@ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Referenc
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. Press the **Option-Command-1** key combination to show the **File Inspector** (or menuitem **View -> Utilities -> Show File Inspector**)
+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
@@ -212,8 +212,8 @@ __NOTE:__ 1.9.0 supports the new **BackupWebStorage** boolean `Cordova.plist` se
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
-2. In your project, select the `Capture.bundle` item into Xcode into your Project Navigator, and press the **Delete** key, then select **Remove Reference** from the dialog that pops up.
-3. Drag the new `Capture.bundle` from Step 1. above into Xcode into your Project Navigator, and 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 Cordova 1.6.x projects to 1.7.0 ##
@@ -252,16 +252,16 @@ If you intend on using the **Capture API**, you will need the new **iPad retina-
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. Press the **Delete** key and delete the `PhoneGap.framework` reference in the Project Navigator
-7. Press 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. Press 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)
+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. Press the **Option-Command-1** key combination to show the **File Inspector**
+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. Press 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. Press 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)
+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:
[44/46] docs commit: Merge 'mike-sierra/copy_edit' into master
Posted by mw...@apache.org.
Merge 'mike-sierra/copy_edit' into master
Conflicts:
docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
docs/en/edge/cordova/camera/camera.cleanup.md
docs/en/edge/cordova/camera/camera.getPicture.md
docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
docs/en/edge/cordova/camera/parameter/cameraError.md
docs/en/edge/cordova/camera/parameter/cameraOptions.md
docs/en/edge/cordova/camera/parameter/cameraSuccess.md
docs/en/edge/cordova/compass/compass.getCurrentHeading.md
docs/en/edge/cordova/compass/compass.watchHeading.md
docs/en/edge/cordova/compass/compassError/compassError.md
docs/en/edge/cordova/compass/parameters/compassHeading.md
docs/en/edge/cordova/compass/parameters/compassSuccess.md
docs/en/edge/cordova/connection/connection.type.md
docs/en/edge/cordova/contacts/Contact/contact.md
docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
docs/en/edge/cordova/contacts/ContactField/contactfield.md
docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
docs/en/edge/cordova/contacts/ContactName/contactname.md
docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
docs/en/edge/cordova/contacts/contacts.find.md
docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
docs/en/edge/cordova/device/device.cordova.md
docs/en/edge/cordova/device/device.model.md
docs/en/edge/cordova/device/device.name.md
docs/en/edge/cordova/device/device.platform.md
docs/en/edge/cordova/device/device.uuid.md
docs/en/edge/cordova/device/device.version.md
docs/en/edge/cordova/events/events.backbutton.md
docs/en/edge/cordova/events/events.batterycritical.md
docs/en/edge/cordova/events/events.batterylow.md
docs/en/edge/cordova/events/events.batterystatus.md
docs/en/edge/cordova/events/events.deviceready.md
docs/en/edge/cordova/events/events.endcallbutton.md
docs/en/edge/cordova/events/events.menubutton.md
docs/en/edge/cordova/events/events.offline.md
docs/en/edge/cordova/events/events.online.md
docs/en/edge/cordova/events/events.pause.md
docs/en/edge/cordova/events/events.resume.md
docs/en/edge/cordova/events/events.searchbutton.md
docs/en/edge/cordova/events/events.startcallbutton.md
docs/en/edge/cordova/events/events.volumedownbutton.md
docs/en/edge/cordova/events/events.volumeupbutton.md
docs/en/edge/cordova/file/directoryentry/directoryentry.md
docs/en/edge/cordova/file/fileentry/fileentry.md
docs/en/edge/cordova/file/fileerror/fileerror.md
docs/en/edge/cordova/file/filereader/filereader.md
docs/en/edge/cordova/file/filetransfer/filetransfer.md
docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
docs/en/edge/cordova/file/filewriter/filewriter.md
docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
docs/en/edge/cordova/geolocation/Position/position.md
docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
docs/en/edge/cordova/globalization/globalization.dateToString.md
docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
docs/en/edge/cordova/globalization/globalization.getDateNames.md
docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
docs/en/edge/cordova/globalization/globalization.getLocaleName.md
docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
docs/en/edge/cordova/globalization/globalization.stringToDate.md
docs/en/edge/cordova/globalization/globalization.stringToNumber.md
docs/en/edge/cordova/inappbrowser/inappbrowser.md
docs/en/edge/cordova/inappbrowser/window.open.md
docs/en/edge/cordova/media/capture/CaptureCB.md
docs/en/edge/cordova/media/capture/CaptureError.md
docs/en/edge/cordova/media/capture/ConfigurationData.md
docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
docs/en/edge/cordova/media/capture/MediaFileData.md
docs/en/edge/cordova/media/capture/capture.md
docs/en/edge/cordova/media/capture/captureAudio.md
docs/en/edge/cordova/media/capture/captureImage.md
docs/en/edge/cordova/media/capture/captureVideo.md
docs/en/edge/cordova/media/media.getCurrentPosition.md
docs/en/edge/cordova/media/media.getDuration.md
docs/en/edge/cordova/media/media.md
docs/en/edge/cordova/media/media.pause.md
docs/en/edge/cordova/media/media.play.md
docs/en/edge/cordova/media/media.release.md
docs/en/edge/cordova/media/media.seekTo.md
docs/en/edge/cordova/media/media.startRecord.md
docs/en/edge/cordova/media/media.stop.md
docs/en/edge/cordova/media/media.stopRecord.md
docs/en/edge/cordova/notification/notification.beep.md
docs/en/edge/cordova/notification/notification.confirm.md
docs/en/edge/cordova/notification/notification.prompt.md
docs/en/edge/cordova/splashscreen/splashscreen.md
docs/en/edge/cordova/storage/database/database.md
docs/en/edge/cordova/storage/localstorage/localstorage.md
docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
docs/en/edge/guide/command-line/index.md
docs/en/edge/guide/cordova-webview/ios.md
docs/en/edge/guide/getting-started/tizen/index.md
docs/en/edge/guide/getting-started/windows-phone-7/index.md
docs/en/edge/guide/getting-started/windows-phone-8/index.md
docs/en/edge/guide/plugin-development/android/index.md
docs/en/edge/guide/upgrading/ios/index.md
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/bf39501f
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/bf39501f
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/bf39501f
Branch: refs/heads/master
Commit: bf39501f1174307a8f252f1e13fc3e38a30d28e9
Parents: d0c89ff f98807e
Author: Michael Brooks <mi...@michaelbrooks.ca>
Authored: Tue Jun 11 17:07:55 2013 -0700
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Tue Jun 11 17:07:55 2013 -0700
----------------------------------------------------------------------
.../accelerometer/acceleration/acceleration.md | 16 +-
.../accelerometer/accelerometer.clearWatch.md | 23 +-
.../accelerometer.getCurrentAcceleration.md | 16 +-
.../accelerometer.watchAcceleration.md | 36 +--
.../parameters/accelerometerOptions.md | 2 +-
.../parameters/accelerometerSuccess.md | 2 +-
docs/en/edge/cordova/camera/camera.cleanup.md | 6 +-
.../en/edge/cordova/camera/camera.getPicture.md | 32 +-
.../camera/parameter/CameraPopoverHandle.md | 2 +-
.../camera/parameter/CameraPopoverOptions.md | 38 +--
.../cordova/camera/parameter/cameraError.md | 2 +-
.../cordova/camera/parameter/cameraOptions.md | 24 +-
.../cordova/camera/parameter/cameraSuccess.md | 2 +-
.../edge/cordova/compass/compass.clearWatch.md | 20 +-
.../compass/compass.getCurrentHeading.md | 14 +-
docs/en/edge/cordova/compass/compass.md | 4 +-
.../cordova/compass/compass.watchHeading.md | 26 +-
.../compass/compassError/compassError.md | 6 +-
.../compass/parameters/compassHeading.md | 11 +-
.../compass/parameters/compassOptions.md | 4 +-
.../compass/parameters/compassSuccess.md | 2 +-
.../edge/cordova/connection/connection.type.md | 74 ++---
.../en/edge/cordova/contacts/Contact/contact.md | 202 ++++++-------
.../contacts/ContactAddress/contactaddress.md | 122 ++++----
.../contacts/ContactError/contactError.md | 2 +-
.../contacts/ContactField/contactfield.md | 115 +++----
.../ContactFindOptions/contactfindoptions.md | 62 ++--
.../cordova/contacts/ContactName/contactname.md | 95 +++---
.../ContactOrganization/contactorganization.md | 91 +++---
.../en/edge/cordova/contacts/contacts.create.md | 12 +-
docs/en/edge/cordova/contacts/contacts.find.md | 95 +++---
.../contacts/parameters/contactFindOptions.md | 5 +-
.../contacts/parameters/contactSuccess.md | 2 +-
docs/en/edge/cordova/device/device.cordova.md | 7 +-
docs/en/edge/cordova/device/device.model.md | 11 +-
docs/en/edge/cordova/device/device.name.md | 9 +-
docs/en/edge/cordova/device/device.platform.md | 5 +-
docs/en/edge/cordova/device/device.uuid.md | 7 +-
docs/en/edge/cordova/device/device.version.md | 7 +-
.../en/edge/cordova/events/events.backbutton.md | 19 +-
.../cordova/events/events.batterycritical.md | 36 +--
.../en/edge/cordova/events/events.batterylow.md | 32 +-
.../edge/cordova/events/events.batterystatus.md | 32 +-
.../edge/cordova/events/events.deviceready.md | 25 +-
.../edge/cordova/events/events.endcallbutton.md | 12 +-
.../en/edge/cordova/events/events.menubutton.md | 15 +-
docs/en/edge/cordova/events/events.offline.md | 29 +-
docs/en/edge/cordova/events/events.online.md | 29 +-
docs/en/edge/cordova/events/events.pause.md | 42 +--
docs/en/edge/cordova/events/events.resume.md | 41 ++-
.../edge/cordova/events/events.searchbutton.md | 17 +-
.../cordova/events/events.startcallbutton.md | 17 +-
.../cordova/events/events.volumedownbutton.md | 17 +-
.../cordova/events/events.volumeupbutton.md | 17 +-
.../file/directoryentry/directoryentry.md | 191 ++++++------
.../file/directoryreader/directoryreader.md | 11 +-
docs/en/edge/cordova/file/file.md | 2 +-
.../en/edge/cordova/file/fileentry/fileentry.md | 130 ++++----
.../en/edge/cordova/file/fileerror/fileerror.md | 8 +-
docs/en/edge/cordova/file/fileobj/fileobj.md | 27 +-
.../edge/cordova/file/filereader/filereader.md | 182 +++++------
.../edge/cordova/file/filesystem/filesystem.md | 47 +--
.../cordova/file/filetransfer/filetransfer.md | 159 +++++-----
.../file/filetransfererror/filetransfererror.md | 14 +-
.../file/fileuploadoptions/fileuploadoptions.md | 23 +-
.../file/fileuploadresult/fileuploadresult.md | 14 +-
.../edge/cordova/file/filewriter/filewriter.md | 162 +++++-----
docs/en/edge/cordova/file/flags/flags.md | 8 +-
.../file/localfilesystem/localfilesystem.md | 60 ++--
docs/en/edge/cordova/file/metadata/metadata.md | 20 +-
.../geolocation/Coordinates/coordinates.md | 29 +-
.../cordova/geolocation/Position/position.md | 41 ++-
.../geolocation/PositionError/positionError.md | 19 +-
.../geolocation/geolocation.clearWatch.md | 31 +-
.../geolocation.getCurrentPosition.md | 28 +-
docs/en/edge/cordova/geolocation/geolocation.md | 17 +-
.../geolocation/geolocation.watchPosition.md | 31 +-
.../parameters/geolocation.options.md | 10 +-
.../geolocation/parameters/geolocationError.md | 5 +-
.../parameters/geolocationSuccess.md | 7 +-
.../GlobalizationError/globalizationerror.md | 27 +-
.../globalization/globalization.dateToString.md | 42 +--
.../globalization.getCurrencyPattern.md | 73 +++--
.../globalization/globalization.getDateNames.md | 53 ++--
.../globalization.getDatePattern.md | 59 ++--
.../globalization.getFirstDayOfWeek.md | 31 +-
.../globalization.getLocaleName.md | 26 +-
.../globalization.getNumberPattern.md | 91 +++---
.../globalization.getPreferredLanguage.md | 26 +-
.../globalization.isDayLightSavingsTime.md | 36 ++-
.../edge/cordova/globalization/globalization.md | 6 +-
.../globalization.numberToString.md | 37 ++-
.../globalization/globalization.stringToDate.md | 67 ++--
.../globalization.stringToNumber.md | 43 ++-
.../edge/cordova/inappbrowser/inappbrowser.md | 112 ++++---
.../en/edge/cordova/inappbrowser/window.open.md | 56 ++--
.../edge/cordova/media/MediaError/mediaError.md | 10 +-
.../edge/cordova/media/Parameters/mediaError.md | 5 +-
docs/en/edge/cordova/media/capture/CaptureCB.md | 7 +-
.../edge/cordova/media/capture/CaptureError.md | 12 +-
.../cordova/media/capture/CaptureErrorCB.md | 8 +-
.../cordova/media/capture/ConfigurationData.md | 20 +-
.../media/capture/MediaFile.getFormatData.md | 18 +-
docs/en/edge/cordova/media/capture/MediaFile.md | 12 +-
.../edge/cordova/media/capture/MediaFileData.md | 49 +--
docs/en/edge/cordova/media/capture/capture.md | 19 +-
.../edge/cordova/media/capture/captureAudio.md | 33 +-
.../media/capture/captureAudioOptions.md | 10 +-
.../edge/cordova/media/capture/captureImage.md | 42 ++-
.../media/capture/captureImageOptions.md | 4 +-
.../edge/cordova/media/capture/captureVideo.md | 45 +--
.../media/capture/captureVideoOptions.md | 11 +-
.../cordova/media/media.getCurrentPosition.md | 76 ++---
docs/en/edge/cordova/media/media.getDuration.md | 66 ++--
docs/en/edge/cordova/media/media.md | 46 +--
docs/en/edge/cordova/media/media.pause.md | 45 ++-
docs/en/edge/cordova/media/media.play.md | 83 ++---
docs/en/edge/cordova/media/media.release.md | 52 ++--
docs/en/edge/cordova/media/media.seekTo.md | 96 +++---
docs/en/edge/cordova/media/media.startRecord.md | 25 +-
docs/en/edge/cordova/media/media.stop.md | 36 +--
docs/en/edge/cordova/media/media.stopRecord.md | 20 +-
.../cordova/notification/notification.alert.md | 55 ++--
.../cordova/notification/notification.beep.md | 39 +--
.../notification/notification.confirm.md | 78 ++---
.../edge/cordova/notification/notification.md | 10 +-
.../cordova/notification/notification.prompt.md | 35 +--
.../notification/notification.vibrate.md | 30 +-
.../cordova/splashscreen/splashscreen.hide.md | 17 +-
.../edge/cordova/splashscreen/splashscreen.md | 50 ++-
.../cordova/splashscreen/splashscreen.show.md | 10 +-
.../edge/cordova/storage/database/database.md | 99 +++---
.../storage/localstorage/localstorage.md | 57 ++--
.../cordova/storage/parameters/display_name.md | 2 +-
docs/en/edge/cordova/storage/parameters/name.md | 2 +-
docs/en/edge/cordova/storage/parameters/size.md | 2 +-
.../edge/cordova/storage/sqlerror/sqlerror.md | 5 +-
.../storage/sqlresultset/sqlresultset.md | 30 +-
.../sqlresultsetrowlist/sqlresultsetrowlist.md | 142 ++++-----
.../storage/sqltransaction/sqltransaction.md | 95 +++---
docs/en/edge/cordova/storage/storage.md | 11 +-
.../cordova/storage/storage.opendatabase.md | 17 +-
docs/en/edge/guide/command-line/index.md | 1 +
docs/en/edge/guide/cordova-webview/ios.md | 4 +-
docs/en/edge/guide/getting-started/ios/index.md | 2 +-
.../edge/guide/getting-started/tizen/index.md | 2 +-
.../getting-started/windows-phone-7/index.md | 2 +-
.../getting-started/windows-phone-8/index.md | 1 -
docs/en/edge/guide/overview/support.html | 302 +++++++++++++++++++
.../guide/plugin-development/android/index.md | 2 +-
.../en/edge/guide/upgrading/blackberry/index.md | 2 +-
151 files changed, 3093 insertions(+), 2513 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
index 148dbce,a32b1c4..337bd18
--- a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
@@@ -93,9 -93,9 +93,10 @@@ Full Exampl
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
- 'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
++
+ element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
+ 'Acceleration Y: ' + acceleration.y + '<br />' +
+ 'Acceleration Z: ' + acceleration.z + '<br />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index 8f0b0f5,b93a4a3..e8e8afe
--- a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@@ -105,9 -105,9 +105,9 @@@ Full Exampl
</body>
</html>
- iPhone Quirks
+ iOS Quirks
-------------
- - iPhone doesn't recognize the concept of getting the current acceleration at any given point.
+ - 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 Cordova `watchAccelerometer` call.
-- Thus, the `getCurrentAcceleration` function yields the last value reported from a `watchAccelerometer` call.
++- Thus, the `getCurrentAcceleration` function yields the last value reported from a `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
index 7f117d6,97510be..29163a2
--- a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
@@@ -138,11 -138,11 +138,11 @@@ Full Exampl
</body>
</html>
- iPhone Quirks
+ iOS Quirks
-------------
- - Cordova calls the success callback function at the interval
- requested, but restricts the range of requests to the device between
- 40ms and 1000ms. For example, if you request an interval of 3
- seconds, (3000ms), Cordova requests data from the device every 1
- second, but only executes the success callback every 3 seconds.
+ The API calls the success callback function at the interval requested,
+ but restricts the range of requests to the device between 40ms and
+ 1000ms. For example, if you request an interval of 3 seconds,
+ (3000ms), the API requests data from the device every 1 second, but
-only executes the success callback every 3 seconds.
++only executes the success callback every 3 seconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
index f52c045,e73429e..350fa1e
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
@@@ -25,4 -25,4 +25,4 @@@ An optional parameter to customize the
Options
-------
- - __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
-- __frequency__: How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
++- __frequency__: How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/camera/camera.cleanup.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/camera/parameter/cameraError.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/compass/compass.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/compass/compassError/compassError.md
index c8850b7,0c1769a..7f320f2
--- a/docs/en/edge/cordova/compass/compassError/compassError.md
+++ b/docs/en/edge/cordova/compass/compassError/compassError.md
@@@ -35,5 -35,5 +35,5 @@@ Constant
Description
-----------
- The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
-
+ When an error occurs, the `CompassError` object is passed as a
-parameter to a `compassError` callback function.
++parameter to a `compassError` callback function.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/compass/parameters/compassHeading.md
index dc15e5c,d44ded8..d1064fb
--- a/docs/en/edge/cordova/compass/parameters/compassHeading.md
+++ b/docs/en/edge/cordova/compass/parameters/compassHeading.md
@@@ -24,10 -24,10 +24,11 @@@ A `CompassHeading` object is returned t
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)_
- - __headingAccuracy:__ The deviation in degrees between the reported heading and the true heading. _(Number)_
- - __timestamp:__ The time at which this heading was determined. _(milliseconds)_
++
+ - __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
-----------
@@@ -43,4 -43,4 +44,4 @@@ iOS Quirk
----------
- `trueHeading` is only returned when location services are enabled via `navigator.geolocation.watchLocation()`
- - For iOS > 4 devices, heading factors in the device's current orientation, not in reference to its absolute position, for apps that supports that orientation.
-- 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.
++- 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/bf39501f/docs/en/edge/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/connection/connection.type.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/contacts/Contact/contact.md
index 3f05775,1b49d1f..45b8687
--- a/docs/en/edge/cordova/contacts/Contact/contact.md
+++ b/docs/en/edge/cordova/contacts/Contact/contact.md
@@@ -234,8 -234,8 +234,8 @@@ Windows Phone 7 and 8 Quirk
Bada Quirks
-----------
- - __displayName:__ Not supported.
- - __birthday:__ Not supported.
- - __photos:__ This property should be a list with one URL to a photo
- - __categories:__ Not supported.
- - __ims:__ Not supported.
+ - __displayName__: Not supported.
+ - __birthday__: Not supported.
+ - __photos__: This property should be a list with one URL to a photo
+ - __categories__: Not supported.
-- __ims__: Not supported.
++- __ims__: Not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
index 8939fe5,22983e8..04b6293
--- a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
+++ b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
@@@ -24,14 -24,14 +24,15 @@@ Contains address properties for a `Cont
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)_
++
+ - __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
-------
@@@ -159,5 -160,5 +161,5 @@@ iOS Quirk
Bada Quirks
-----------
- - __formatted:__ Not supported.
- - __type:__ Has to be either `WORK` or `HOME`
+ - __formatted__: Not supported.
-- __type__: Has to be either `WORK` or `HOME`
++- __type__: Has to be either `WORK` or `HOME`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
index 10ff14a,abdf600..f175d4d
--- a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@@ -115,4 -115,4 +115,4 @@@ Full Exampl
Bada Quirks
-----------
- __filter:__ Property can only apply to the following: _firstName_, _lastName_, _nickname_, _phoneNumber_, _email_, and _address_.
-__filter__: Property can only apply to the following: _firstName_, _lastName_, _nickname_, _phoneNumber_, _email_, and _address_.
++__filter__: Property can only apply to the following: _firstName_, _lastName_, _nickname_, _phoneNumber_, _email_, and _address_.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/contacts/ContactName/contactname.md
index 9799472,6bae487..470a4c7
--- a/docs/en/edge/cordova/contacts/ContactName/contactname.md
+++ b/docs/en/edge/cordova/contacts/ContactName/contactname.md
@@@ -123,7 -123,7 +123,8 @@@ Full Exampl
Android Quirks
------------
- - __formatted:__ Partially supported, and read-only. Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
++
+ - __formatted__: Partially supported, and read-only. Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
@@@ -137,11 -137,11 +138,13 @@@
iOS Quirks
------------
- - __formatted:__ Partially supported. Returns iOS Composite Name, but is read-only.
++
+ - __formatted__: Partially supported. Returns iOS Composite Name, but is read-only.
Bada Quirks
-----------
- - __formatted:__ Not supported
- - __middleName:__ Not supported
- _ __honorificPrefix:__ Not supported
- - __honorificSuffix:__ Not supported
++
+ - __formatted__: Not supported
+ - __middleName__: Not supported
+ _ __honorificPrefix__: Not supported
+ - __honorificSuffix__: Not supported
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
index 7ddbf8e,8975667..3dbd6bf
--- a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
@@@ -24,11 -24,11 +24,12 @@@ Contains a `Contact` object's organizat
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)_
++
+ - __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
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
index 660615b,773b56e..0b40bcd
--- a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
@@@ -31,6 -31,6 +31,5 @@@ contacts returned from the contacts dat
Options
-------
- - __filter:__ The search string used to filter contacts. _(DOMString)_ (Default: `""`)
- - __multiple:__ Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: `false`)
-
+ - __filter__: The search string used to filter contacts. _(DOMString)_ (Default: `""`)
-- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: `false`)
-
++- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: `false`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/device/device.cordova.md
index c7891ff,b848ad4..b29e24f
--- a/docs/en/edge/cordova/device/device.cordova.md
+++ b/docs/en/edge/cordova/device/device.cordova.md
@@@ -64,7 -64,7 +64,6 @@@ Full Exampl
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
-
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/device/device.model.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/device/device.model.md
index 59a711b,abea756..e5238e4
--- a/docs/en/edge/cordova/device/device.model.md
+++ b/docs/en/edge/cordova/device/device.model.md
@@@ -72,12 -72,12 +72,11 @@@ Full Exampl
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
-
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
'Device UUID: ' + device.uuid + '<br />' +
- 'Device Model: ' + device.model + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
'Device Version: ' + device.version + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/device/device.name.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/device/device.name.md
index 5391f8d,00cec23..a70648f
--- a/docs/en/edge/cordova/device/device.name.md
+++ b/docs/en/edge/cordova/device/device.name.md
@@@ -74,12 -74,12 +74,11 @@@ Full Exampl
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
-
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
'Device UUID: ' + device.uuid + '<br />' +
- 'Device Model: ' + device.model + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
'Device Version: ' + device.version + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/device/device.platform.md
index a259587,5f2baab..0d2cacb
--- a/docs/en/edge/cordova/device/device.platform.md
+++ b/docs/en/edge/cordova/device/device.platform.md
@@@ -67,7 -67,7 +67,6 @@@ Full Exampl
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
-
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/device/device.uuid.md
index 565ffae,9eaa7c9..76abf73
--- a/docs/en/edge/cordova/device/device.uuid.md
+++ b/docs/en/edge/cordova/device/device.uuid.md
@@@ -82,7 -82,7 +82,6 @@@ Full Exampl
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
-
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/device/device.version.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/device/device.version.md
index 9e1db70,09aa71c..ecd4733
--- a/docs/en/edge/cordova/device/device.version.md
+++ b/docs/en/edge/cordova/device/device.version.md
@@@ -71,7 -71,7 +71,6 @@@ Full Exampl
//
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
-
-
element.innerHTML = 'Device Name: ' + device.name + '<br />' +
'Device Cordova: ' + device.cordova + '<br />' +
'Device Platform: ' + device.platform + '<br />' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/events/events.backbutton.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/events/events.batterylow.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/events/events.deviceready.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/events/events.pause.md
index c30f847,f7c23cc..6d96378
--- a/docs/en/edge/cordova/events/events.pause.md
+++ b/docs/en/edge/cordova/events/events.pause.md
@@@ -27,10 -27,12 +27,13 @@@ The event fires when an application is
Details
-------
- Cordova consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired.
++
+ The `pause` event fires when the native platform puts the application
+ into the background, typically when the user switches to a different
+ application.
Applications typically should use `document.addEventListener` to
- attach an event listener once the Cordova `deviceready` event fires.
+ attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@@ -90,10 -88,19 +89,19 @@@ Full Exampl
iOS Quirks
--------------------------
- In the pause handler, any calls that go through Objective-C will not work, nor will any calls that are interactive, like alerts. This means that you cannot call console.log (and its variants), or any calls from Plugins or the Cordova API. These will only be processed when the app resumes (processed on the next run-loop).
-
- - __resign__ event
-
- This iOS specific event is available as a variant of the **pause** event, and is often used to detect when the "Lock" button has been pressed to lock the device when your app is the foreground app. If your app (and device) is enabled for multi-tasking, this will be paired with a subsequent **pause** event, but only under iOS 5 (effectively all "locked" apps in iOS 5 that have multi-tasking enabled are put to the background).
- Under iOS 5, if you want your app to still run when the device is locked, you will have to disable multi-tasking (UIApplicationExitsOnSuspend - YES) for your app. This is different when you are on iOS 4 - to have your app run when the device is locked, the multi-tasking setting for your app does not matter.
+ 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
+ interactive calls, such as alerts or `console.log()`. They are only
+ processed when the app resumes, on the next run loop.
+
+ The iOS-specific `resign` event is available as an alternative to
+ `pause`, and detects when users enable the __Lock__ button to lock the
+ device with the app running in the foreground. If the app (and
+ device) is enabled for multi-tasking, this is paired with a subsequent
+ `pause` event, but only under iOS 5. In effect, all locked apps in iOS
+ 5 that have multi-tasking enabled are pushed to the background. For
+ apps to remain running when locked under iOS 5, disable the app's
+ multi-tasking by setting
+ [UIApplicationExitsOnSuspend](http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html)
-to `YES`. To run when locked on iOS 4, this setting does not matter.
++to `YES`. To run when locked on iOS 4, this setting does not matter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/events/events.resume.md
index 0e0057f,ac3a7b2..4387879
--- a/docs/en/edge/cordova/events/events.resume.md
+++ b/docs/en/edge/cordova/events/events.resume.md
@@@ -90,21 -87,30 +87,33 @@@ Full Exampl
iOS Quirks
--------------------------
- Any calls to console.log during your **pause** event handler will be run now when the app resumes, see the iOS Quirks section for the **pause** event for an explanation.
-
- - __active__ event
- This iOS specific event is available as a variant of the **resume** event, and is often used to detect when the "Lock" button has been pressed to unlock the device when your app is the foreground app. If your app (and device) is enabled for multi-tasking, this will be paired with a subsequent **resume** event, but only under iOS 5 (effectively all "locked" apps in iOS 5 that have multi-tasking enabled are put to the background).
-When called from a `resume` event handler, interactive functions such
-as `alert()` need to be wrapped in a `setTimeout()` call with a
-timeout value of zero, or else the app hangs. For example:
-
- document.addEventListener("resume", onResume, false);
- function onResume() {
- setTimeout(function() {
- // TODO: do your thing!
- }, 0);
- }
-
+ Any interactive functions called from a `pause` event handler execute
+ later when the app resumes, as signaled by the `resume` event. These
+ include alerts, `console.log()`, and any calls from plugins or the
+ Cordova API, which go through Objective-C.
- Under iOS 5, if you want your app to still run when the device is locked, you will have to disable multi-tasking (UIApplicationExitsOnSuspend - YES) for your app. This is different when you are on iOS 4 - to have your app run when the device is locked, the multi-tasking setting for your app does not matter.
-The iOS-specific `active` event is available as an alternative to
++- __active__ event
+
++ The iOS-specific `active` event is available as an alternative to
+ `resume`, and detects when users disable the __Lock__ button to unlock
+ the device with the app running in the foreground. If the app (and
+ device) is enabled for multi-tasking, this is paired with a subsequent
+ `resume` event, but only under iOS 5. In effect, all locked apps in
+ iOS 5 that have multi-tasking enabled are pushed to the background.
+ For apps to remain running when locked under iOS 5, disable the app's
-multi-tasking by setting
-[UIApplicationExitsOnSuspend](http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html)
++multi-tasking by setting [UIApplicationExitsOnSuspend](http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html)
+ to `YES`. To run when locked on iOS 4, this setting does not matter.
++
+- __resume__ event
+
- Interactive functions like alert() when the resume event fires will need to be wrapped in a setTimeout call with a timeout value of zero, or else the app will hang. e.g.
++ When called from a `resume` event handler, interactive functions such
++as `alert()` need to be wrapped in a `setTimeout()` call with a
++timeout value of zero, or else the app hangs. For example:
+
+ document.addEventListener("resume", onResume, false);
+ function onResume() {
+ setTimeout(function() {
+ // TODO: do your thing!
+ }, 0);
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/file/directoryentry/directoryentry.md
index 24d2967,dd5142e..de01dd5
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@@ -277,8 -282,8 +282,8 @@@ __Quick Example_
alert('Failed to get parent directory: ' + error.code);
}
- // Get the parent DirectoryEntry
- entry.getParent(success, fail);
- // Get the parent DirectoryEntry
- entry.getParent(success, fail);
++ // Get the parent DirectoryEntry
++ entry.getParent(success, fail);
createReader
------------
@@@ -374,12 -379,13 +379,12 @@@ __Quick Example_
BlackBerry Quirks
-----------------
- May fail with a ControlledAccessException in the following cases:
+ May fail with a `ControlledAccessException` in the following cases:
- - Access is attempted on an directory created by a previous installation of an application.
+ - An app attempts to access a directory created by a previous installation of the app.
- > solution: insure temporary directories are cleaned manually, or by the application before reinstall
+ > Solution: ensure temporary directories are cleaned manually, or by the application prior to reinstallation.
- - if device is connected by usb
+ - If the device is connected by USB.
- > solution: disconnect usb cable from device and run again
-> Solution: disconnect the USB cable from the device and run again.
-
++> Solution: disconnect the USB cable from the device and run again.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/file/fileerror/fileerror.md
index 78ab485,a408736..c34c6be
--- a/docs/en/edge/cordova/file/fileerror/fileerror.md
+++ b/docs/en/edge/cordova/file/fileerror/fileerror.md
@@@ -46,4 -46,7 +46,6 @@@ Constant
Description
-----------
- The `FileError` object is the only parameter of any of the File API's error callbacks. Developers must read the code property to determine the type of error.
+ The `FileError` object is the only parameter provided to any of the
+ File API's error callbacks. To determine the type of error, compare
-its `code` property to any of the listings above.
-
++its `code` property to any of the listings above.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/file/filereader/filereader.md
index b06976c,d888999..25f6ff0
--- a/docs/en/edge/cordova/file/filereader/filereader.md
+++ b/docs/en/edge/cordova/file/filereader/filereader.md
@@@ -208,20 -216,20 +216,20 @@@ __Parameters:_
Quick Example
-------------
- function win(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("read success");
+ function win(file) {
+ var reader = new FileReader();
+ reader.onloadend = function (evt) {
+ console.log("read success");
console.log(evt.target.result);
};
- reader.readAsBinaryString(file);
- };
+ reader.readAsBinaryString(file);
+ };
+
+ var fail = function (evt) {
+ console.log(error.code);
+ };
- var fail = function(evt) {
- console.log(error.code);
- };
-
-entry.file(win, fail);
+ entry.file(win, fail);
Read As Array Buffer
--------------------
@@@ -229,7 -237,7 +237,8 @@@
Currently supported on iOS and Android only.
__Parameters:__
- - file - the file object to read
++
+ - __file__: the file object to read.
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
index 62808be,b043130..6172e53
--- a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
+++ b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
@@@ -124,4 -125,4 +125,4 @@@ Full Exampl
Android Quirks
-------------
- __altitudeAccuracy:__ Not supported by Android devices, returning `null`.
-__altitudeAccuracy__: Not supported by Android devices, returning `null`.
++__altitudeAccuracy__: Not supported by Android devices, returning `null`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/geolocation/geolocation.md
index ada9d36,d2613ce..e273a02
--- a/docs/en/edge/cordova/geolocation/geolocation.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.md
@@@ -20,14 -20,19 +20,21 @@@ license: Licensed to the Apache Softwar
Geolocation
===========
- > The `geolocation` object provides access to the device's GPS sensor.
+ > The `geolocation` object provides access to location data based on the device's GPS sensor or inferred from network signals.
- Geolocation provides location information for the device, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. No guarantee is given that the API returns the device's actual location.
+ `Geolocation` provides information about the device's location, such as
+ latitude and longitude. Common sources of location information include
+ Global Positioning System (GPS) and location inferred from network
+ signals such as IP address, RFID, WiFi and Bluetooth MAC addresses,
+ and GSM/CDMA cell IDs. There is no guarantee that the API returns the
+ device's actual location.
- This API is based on the [W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html). Some devices (Android, BlackBerry, Bada, Windows Phone 7, webOS and Tizen, to be specific) already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with Cordova's implementation. For devices that don't have geolocation support, the Cordova implementation adheres to the W3C specification.
+ This API is based on the
+ [W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html),
+ and only executes on devices that don't already provide an implementation.
+**Important privacy note:** Collection and use of geolocation data raises important privacy issues. Your app's [privacy policy](guide_getting-started_index.md.html) should discuss how the app uses geolocation data, whether it is shared with any other parties, and the level of precision of the data (for example, coarse, fine, ZIP code level, etc.). Geolocation data is generally considered sensitive because it can reveal a person's whereabouts and, if stored, the history of his or her travels. Therefore, in addition to your app's privacy policy, you should strongly consider providing a just-in-time notice prior to your app accessing geolocation data (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for "OK" and "No Thanks"). For more information, please see the Privacy Guide.
+
Methods
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/globalization/globalization.dateToString.md
index 19c6c18,dceb57c..da117bc
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.md
@@@ -27,17 -27,21 +27,22 @@@ Returns a date formatted as a string ac
Description
-----------
- It returns the formatted date string to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a String value.
+ Returns the formatted date `String` via a `value` property accessible
+ from the object passed as a parameter to the `successCallback`.
- The inbound ``date`` parameter should be of type ``Date``.
+ The inbound `date` parameter should be of type `Date`.
- If there is an error formatting the date, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+ If there is an error formatting the date, then the `errorCallback`
+ executes with a `GlobalizationError` object as a parameter. The
+ error's expected code is `GlobalizationError.FORMATTING\_ERROR`.
- `options.formatLength` can be 'short', 'medium', 'long', or 'full'.
- `options.selector` can be 'date', 'time' or 'date and time'.
+ The `options` parameter is optional, and its default values are:
- The default options are `{formatLength:'short', selector:'date and time'}`.
- The `options` parameter is optional.
+ {formatLength:'short', selector:'date and time'}
+
+ The `options.formatLength` can be `short`, `medium`, `long`, or `full`.
++
+ The `options.selector` can be `date`, `time` or `date and time`.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
index 2f591cc,f02f1e5..3d49d16
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@@ -102,4 -110,4 +110,3 @@@ Full Exampl
<button onclick="checkPattern()">Click for pattern</button>
</body>
</html>
--
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/globalization/globalization.getDateNames.md
index 92db64a,88d9a66..389cfa6
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@@ -25,17 -28,22 +28,23 @@@ depending on the client's user preferen
Description
-----------
- It returns the array of names to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
+ Returns the array of names to the `successCallback` with a
+ `properties` object as a parameter. That object contains a `value`
+ property with an `Array` of `String` values. The array features names
+ starting from either the first month in the year or the first day of
+ the week, depending on the option selected.
+
+ If there is an error obtaining the names, then the `errorCallback`
+ executes with a `GlobalizationError` object as a parameter. The
+ error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
- If there is an error obtaining the names, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+ The `options` parameter is optional, and its default values are:
- `options.type` can be 'narrow', or 'wide'.
- `options.item` can be 'months', or 'days'.
+ {type:'wide', item:'months'}
- The default options are `{type:'wide', item:'months'}`.
- The options parameter is optional.
+ The value of `options.type` can be `narrow` or `wide`.
++
+ The value of `options.item` can be `months` or `days`.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/inappbrowser/window.open.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/inappbrowser/window.open.md
index dba819b,d6d4a7c..f64eee5
--- a/docs/en/edge/cordova/inappbrowser/window.open.md
+++ b/docs/en/edge/cordova/inappbrowser/window.open.md
@@@ -20,40 -20,35 +20,41 @@@ license: Licensed to the Apache Softwar
window.open
===========
- Opens a URL in a new InAppBrowser instance, the current browser instance, or the system browser.
+ Opens a URL in a new `InAppBrowser` instance, the current browser
+ 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 you have Unicode characters in your URL.
- - __target:__ the target to load the URL in (`String`) (Optional, Default: "_self")
- _self - opens in the Cordova WebView if URL is in the white-list, else it opens in the InAppBrowser
- _blank - always open in the InAppBrowser
- _system - always open in the system web browser
-
-
- - __options:__ options for the InAppBrowser (`String`) (Optional, Default: "location=yes")
-
- The options string must not contain any blank space, each feature name and value must be separated by a comma. Feature names are case insensitive. Only the value below is supported on all platforms:
+ - __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`.
- - `_blank`: Opens in the `InAppBrowser`.
- - `_system`: Opens in the system's web browser.
++ - `_self`: Opens in the Cordova WebView if the URL is in the white list, otherwise it opens in the `InAppBrowser`.
++ - `_blank`: Opens in the `InAppBrowser`.
++ - `_system`: Opens in the system's web browser.
- - __location__ - set to 'yes' or 'no' to turn the location bar on or off for the InAppBrowser (defaults to 'yes')
+ - __options__: Options for the `InAppBrowser`. Optional, defaulting to: `location=yes`. _(String)_
+
+ The `options` string must not contain any blank space, and each feature's name/value pairs must be separated by a comma. Feature names are case insensitive. All platforms support the value below:
+
+ - __location__: Set to `yes` or `no` to turn the `InAppBrowser`'s location bar on or off.
+
- iOS and Android only
- --------------------
- - __closebuttoncaption__ - set to a string that will be the caption for the "Done" button. Note that if you set this for iOS, you will have to localize this value yourself.
++ Android only
++ ------------
++ - __closebuttoncaption__ - set to a string that will be the caption for the "Done" button.
iOS only
--------
++ - __closebuttoncaption__ - set to a string that will be the caption for the "Done" button. Note that you will have to localize this value yourself.
+ - __toolbar__ - set to 'yes' or 'no' to turn the toolbar on or off for the InAppBrowser (defaults to 'yes')
- - __enableViewportScale__ - set to 'yes' or 'no' to prevent viewport scaling through a meta tag (defaults to 'no')
- - __mediaPlaybackRequiresUserAction__ - set to 'yes' or 'no' to not allow autoplayed HTML5 video (defaults to 'no')
- - __allowInlineMediaPlayback__ - set to 'yes' or 'no' to allow inline HTML5 media playback, also, the video element in the HTML document must also include the webkit-playsinline attribute (defaults to 'no')
- - __keyboardDisplayRequiresUserAction__ - set to 'yes' or 'no' to open the keyboard when form elements get focus via the JavaScript focus() call (defaults to 'yes')
- - __suppressesIncrementalRendering__ - set to 'yes' or 'no' to wait until all new view content has been received before it is rendered (defaults to 'no')
- - __presentationstyle__ - set to 'pagesheet', 'formsheet' or 'fullscreen' to set the [presentation style](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle) (defaults to 'fullscreen')
- - __transitionstyle__ - set to 'fliphorizontal', 'crossdissolve' or 'coververtical' to set the [transition style](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle) (defaults to 'coververtical')
-
+ - __enableViewportScale__: Set to `yes` or `no` to prevent viewport scaling through a meta tag (defaults to `no`).
+ - __mediaPlaybackRequiresUserAction__: Set to `yes` or `no` to prevent HTML5 audio or video from autoplaying (defaults to `no`).
+ - __allowInlineMediaPlayback__: Set to `yes` or `no` to allow inline HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. The HTML's `video` element must also include the `webkit-playsinline` attribute (defaults to `no`)
+ - __keyboardDisplayRequiresUserAction__: Set to `yes` or `no` to open the keyboard when form elements receive focus via JavaScript's `focus()` call (defaults to `yes`).
+ - __suppressesIncrementalRendering__: Set to `yes` or `no` to wait until all new view content is received before being rendered (defaults to `no`).
+ - __presentationstyle__: Set to `pagesheet`, `formsheet` or `fullscreen` to set the [presentation style](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle) (defaults to `fullscreen`).
+ - __transitionstyle__: Set to `fliphorizontal`, `crossdissolve` or `coververtical` to set the [transition style](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle) (defaults to `coververtical`).
+
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/media/capture/CaptureError.md
index d94f885,0268f06..eb4a57d
--- a/docs/en/edge/cordova/media/capture/CaptureError.md
+++ b/docs/en/edge/cordova/media/capture/CaptureError.md
@@@ -30,8 -30,8 +30,8 @@@ Propertie
Constants
---------
- - CaptureError.`CAPTURE_INTERNAL_ERR`: Camera or microphone failed to capture image or sound.
- - CaptureError.`CAPTURE_APPLICATION_BUSY`: Camera application or audio capture application is currently serving other capture request.
- - CaptureError.`CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. limit parameter has value less than one).
- - CaptureError.`CAPTURE_NO_MEDIA_FILES`: User exited camera application or audio capture application before capturing anything.
- - CaptureError.`CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
+ - `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.
++- `CaptureError.CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
index a86e3fa,03fdd00..321958c
--- a/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
@@@ -51,4 -59,7 +59,6 @@@ The API to access media file format inf
iOS Quirks
----------
- The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
+
+ The API to access media file format information is limited, so not all
-`MediaFileData` properties are supported.
-
++`MediaFileData` properties are supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/media/capture/MediaFileData.md
index b29908c,545b549..5458b68
--- a/docs/en/edge/cordova/media/capture/MediaFileData.md
+++ b/docs/en/edge/cordova/media/capture/MediaFileData.md
@@@ -53,10 -56,10 +56,10 @@@ Supports the following `MediaFileData`
iOS Quirks
----------
- Support for the MediaFileData properties is as follows:
+ Supports the following `MediaFileData` properties:
- - __codecs:__ Not supported. The attribute will always be null.
- - __bitrate:__ Supported on iOS4 devices for audio only. The attribute will always be 0 for image and video.
- - __height:__ Supported. (Image and video files only).
- - __width:__ Supported. (Image and video files only).
- - __duration:__ Supported. (Audio and video files only).
+ - __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.
++- __duration__: Supported: audio and video files only.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/media/capture/capture.md
index 691a8bb,013d11b..b503965
--- a/docs/en/edge/cordova/media/capture/capture.md
+++ b/docs/en/edge/cordova/media/capture/capture.md
@@@ -20,10 -20,8 +20,10 @@@ license: Licensed to the Apache Softwar
Capture
=======
- > Provides access to the audio, image, and video capture capabilities of the device.
+ > Provides access to the device's audio, image, and video capture capabilities.
+**Important privacy note:** Collection and use of images, video, or audio from the device's camera or microphone raises important privacy issues. Your app's [privacy policy](guide_getting-started_index.md.html) should discuss how the app uses such sensors and whether the data recorded is shared with any other parties. In addition, if the app's use of the camera or microphone is not apparent in the user interface, you should provide a just-in-time notice prior to your app accessing the camera or microphone (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for "OK" and "No Thanks"). Note that some app marketplaces may require your app to provide just-in-time notice and obtain permission from the user prior to accessing the camera or microphone. For more information, please see the Privacy Guide.
+
Objects
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/media/media.getCurrentPosition.md
index 1aecb0f,c9e8d28..171bec6
--- a/docs/en/edge/cordova/media/media.getCurrentPosition.md
+++ b/docs/en/edge/cordova/media/media.getCurrentPosition.md
@@@ -48,27 -50,28 +50,27 @@@ Supported Platform
Quick Example
-------------
- // Audio player
- //
- var my_media = new Media(src, onSuccess, onError);
-
- // Update media position every second
- var mediaTimer = setInterval(function() {
- // get media position
- my_media.getCurrentPosition(
- // success callback
- function(position) {
- if (position > -1) {
- console.log((position) + " sec");
- }
- },
- // error callback
- function(e) {
- console.log("Error getting pos=" + e);
+ // Audio player
+ //
+ var my_media = new Media(src, onSuccess, onError);
+
+ // Update media position every second
+ var mediaTimer = setInterval(function () {
+ // get media position
+ my_media.getCurrentPosition(
+ // success callback
+ function (position) {
+ if (position > -1) {
+ console.log((position) + " sec");
}
- );
- }, 1000);
+ },
+ // error callback
+ function (e) {
+ console.log("Error getting pos=" + e);
+ }
+ );
+ }, 1000);
-
Full Example
------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/media/media.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/media/media.md
index f331838,09c7037..79d706b
--- a/docs/en/edge/cordova/media/media.md
+++ b/docs/en/edge/cordova/media/media.md
@@@ -48,16 -52,15 +52,16 @@@ The following constants are reported a
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 audio file.
- - media.pause: Pause playing audio file.
- - media.release: Releases the underlying OS'es audio resources.
- - media.seekTo: Moves the position within the audio file.
- - media.setVolume: Set the volume for audio playback.
- - media.startRecord: Start recording audio file.
- - media.stopRecord: Stop recording audio file.
- - media.stop: Stop playing audio file.
+ - `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
---------------------
@@@ -134,10 -137,6 +138,8 @@@ Reference: [Application Manifest for Wi
No permissions are required.
### Windows Phone Quirks
+
- Only one media file can be played back at a time.
-
- There are strict restrictions as to how your application interacts with other media. See the [Microsoft documentation for details][url].
+ - 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].
-- There are strict restrictions on how your application interacts with other media. See [Windows Phone Developer Center](http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx).
+[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/bf39501f/docs/en/edge/cordova/media/media.pause.md
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/notification/notification.prompt.md
index 11366b5,0d80029..31562ba
--- a/docs/en/edge/cordova/notification/notification.prompt.md
+++ b/docs/en/edge/cordova/notification/notification.prompt.md
@@@ -22,13 -22,12 +22,13 @@@ notification.promp
Shows a customizable prompt dialog box.
- navigator.notification.prompt(message, promptCallback, [title], [buttonLabels])
+ 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, Default: "Prompt")
- - __buttonLabels:__ Array of strings for the button labels (`Array`) (Optional, Default: ["OK","Cancel"])
- - __defaultText:__ Default textbox input value (`String`) (Optional, Default: "Default text")
+ - __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")
Description
-----------
@@@ -64,10 -64,9 +65,10 @@@ Quick Exampl
function showPrompt() {
navigator.notification.prompt(
'Please enter your name', // message
- onPrompt, // callback to invoke
+ onPrompt, // callback to invoke
'Registration', // title
- ['Ok','Exit'] // buttonLabels
+ ['Ok','Exit'], // buttonLabels
+ 'Jane Doe' // defaultText
);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/cordova/splashscreen/splashscreen.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/splashscreen/splashscreen.md
index 93519c8,2e36ac2..1a96b9d
--- a/docs/en/edge/cordova/splashscreen/splashscreen.md
+++ b/docs/en/edge/cordova/splashscreen/splashscreen.md
@@@ -67,17 -67,15 +67,15 @@@ Setu
### iOS
- 1. Copy your splash screen images into the **Resources/splash** directory of your iOS project. Only add the images for the devices you want to support (iPad screen size or iPhone screen size). The sizes of each image should be:
-
- - Default-568h@2x~iphone.png (640x1136 pixels)
- - Default-Landscape@2x~ipad.png (2048x1496 pixels)
- - Default-Landscape~ipad.png (1024x748 pixels)
- - Default-Portrait@2x~ipad.png (1536x2008 pixels)
- - Default-Portrait~ipad.png (768x1004 pixels)
- - Default@2x~iphone.png (640x960 pixels)
- - Default~iphone.png (320x480 pixels)
-
-
-
-
-
+ Copy your splash screen images into the iOS project's
+ `Resources/splash` directory. Only add the images for the devices you
+ want to support, such as iPad or iPhone. The size of each image
+ should be:
+
+ - Default-568h@2x~iphone.png (640x1136 pixels)
+ - Default-Landscape@2x~ipad.png (2048x1496 pixels)
+ - Default-Landscape~ipad.png (1024x748 pixels)
+ - Default-Portrait@2x~ipad.png (1536x2008 pixels)
+ - Default-Portrait~ipad.png (768x1004 pixels)
+ - Default@2x~iphone.png (640x960 pixels)
-- Default~iphone.png (320x480 pixels)
++- Default~iphone.png (320x480 pixels)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/guide/command-line/index.md
----------------------------------------------------------------------
diff --cc docs/en/edge/guide/command-line/index.md
index 28f885c,46295f1..9f91f87
--- a/docs/en/edge/guide/command-line/index.md
+++ b/docs/en/edge/guide/command-line/index.md
@@@ -267,133 -218,3 +267,134 @@@ for Playbook and BlackBerry smartphone
7.0 and above. You can also access your application's logs (including
any calls to `console.log`) on your device by holding down the ''ALT''
key from the home screen and typing ''lglg'' keys.
+
++
+## BlackBerry 10
+
+Command-line tools are based on shell scripts. If you need help with a command, type the command with the `-h` or `-help` arguments, which are supported by all commands and which will provide descriptions for each of the available arguments.
+
+The following commands are available:
+
+## create
+
+The 'create' command creates a new project:
+
+```
+bin/create <path-to-project>
+```
+
+## target
+
+The `target` command allows you to manage the BlackBerry device(s) or simulator that you will use to test your app. You can add or remove a target, or set a target as the default target.
+
+### Add a target
+
+```
+<path-to-project>/cordova/target add <name> <ip-address> <device | simulator> [-p | --password <password>] [--pin <device-pin>]
+```
+
+where
+
+- `<name>` specifies a unique name for the target.
+- `<ip-address>` specifies the ip address of the BlackBerry device or simulator.
+- `-p|--password <password>` specifies the password for the device or simulator. This is required only if the device or simulator is password protected.
+- `--pin <device-pin>` specifies the PIN of the BlackBerry device, which identifies that device as a valid host for the debug token. This argument is required only if you are creating a debug token.
+
+### Remove a target
+
+```
+<path-to-project>/cordova/target remove <name>
+```
+
+### Set a target as the default
+
+```
+<path-to-project>/cordova/target default <name>
+```
+
+## build
+
+The `build` command builds the project as a .bar file. You can build your app in either release mode (which produces a signed .bar file) or in debug mode (which produces an unsigned .bar file).
+
+### Build your project in release mode
+
+```
+<path-to-project>/cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-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
+
+```
+<path-to-project>/cordova/build debug [<target>] [-k|--keystorepass <password>] [-p|--params <params-JSON-file>] [-ll|--loglevel <error|warn|verbose>]
+```
+
+where
+
+- `<target>` specifies the name of a previously added target. If `<target>` is not specified, the default target is used, if one has been created. This argument is only required if you want the script to deploy your app to a BlackBerry device or simulator and you have not created a default target. Additionally, if `<target>` is a device, then that device must be connected to your computer by USB connection or be connected to the same Wi-Fi network as your computer.
+- `-k|--keystorepass <password>` specifies the password you defined when you configured your computer to sign applications. This password is also used to create your debug token. This argument is only required if you want the script to create and install the debug token for you.
+- `-p|--params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools.
+- `-ll|--loglevel <level>` specifies the log level. The log level may be one of `error`, `warn`, or `verbose`.
+
+If you have previously defined a default target (and previously installed a debug token, if that target is a BlackBerry device), you can run the script with no arguments, and the script will package your app and deploy it to the default target. For example:
+
+```
+<path-to-project>/cordova/build debug
+```
+
+## run
+
+The `run` command deploys the app on the specified BlackBerry device or a simulator. Before deploying your app, you must first create a target for the device or simulator you want to deploy your app to. The deploy script will deploy the most recent build of your app.
+
+```
+<path-to-project>/cordova/run <target>
+```
+
+where
+- `<target> `specifies the name of a previously added target. If `<target> `is a device, then that device must be connected to your computer by USB connection or be connected to the same Wi-Fi network as your computer.
+
+## plugin
+
+The `target` command allows you to add and remove plugins
+
+### Fetch a locally-hosted plugin
+
+
+```
+<path-to-project>/cordova/plugin fetch <path-to-plugin>
+```
+
+### View a list of installed plugins
+
+```
+<path-to-project>/cordova/plugin ls
+```
+
+### Add a plugin
+
+```
+<path-to-project>/cordova/plugin add <name>
+```
+
+### Remove a plugin
+
+```
+<path-to-project>/cordova/plugin rm <name>
+```
+
+## Windows 8
+
+The Windows 8 command line tools support creating new projects only.
+Commands must be run from a cmd or powershell prompt.
+
+### Create a project
+
+Run the `create` command with the following parameters:
+
+* Path to your new Cordova Windows 8 project
+* Package Name, following reverse-domain style convention ( this becomes the default Namespace )
+* Project name
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/guide/cordova-webview/ios.md
----------------------------------------------------------------------
diff --cc docs/en/edge/guide/cordova-webview/ios.md
index cd945ab,a606aeb..4605368
--- a/docs/en/edge/guide/cordova-webview/ios.md
+++ b/docs/en/edge/guide/cordova-webview/ios.md
@@@ -76,10 -76,10 +76,8 @@@ Adding Cleaver to your Xcode project (C
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"
-
-
++ "$(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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/bf39501f/docs/en/edge/guide/getting-started/ios/index.md
----------------------------------------------------------------------
[22/46] docs commit: to start of file api
Posted by mw...@apache.org.
to start of file api
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/0a03c5ae
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/0a03c5ae
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/0a03c5ae
Branch: refs/heads/master
Commit: 0a03c5ae513a7d6da9ae1fa63773473bbe7e971b
Parents: 909bb28
Author: Mike Sierra <le...@gmail.com>
Authored: Thu May 16 11:21:36 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Thu May 16 11:21:36 2013 -0400
----------------------------------------------------------------------
.../accelerometer/acceleration/acceleration.md | 2 +-
.../accelerometer/accelerometer.clearWatch.md | 2 +-
.../accelerometer.getCurrentAcceleration.md | 2 +-
.../edge/cordova/accelerometer/accelerometer.md | 2 +-
.../accelerometer.watchAcceleration.md | 2 +-
.../parameters/accelerometerError.md | 2 +-
.../parameters/accelerometerOptions.md | 2 +-
.../parameters/accelerometerSuccess.md | 2 +-
docs/en/edge/cordova/camera/camera.cleanup.md | 2 +-
.../en/edge/cordova/camera/camera.getPicture.md | 2 +-
docs/en/edge/cordova/camera/camera.md | 2 +-
.../camera/parameter/CameraPopoverHandle.md | 2 +-
.../camera/parameter/CameraPopoverOptions.md | 2 +-
.../cordova/camera/parameter/cameraError.md | 2 +-
.../cordova/camera/parameter/cameraOptions.md | 2 +-
.../cordova/camera/parameter/cameraSuccess.md | 2 +-
.../edge/cordova/compass/compass.clearWatch.md | 2 +-
.../cordova/compass/compass.clearWatchFilter.md | 2 +-
.../compass/compass.getCurrentHeading.md | 2 +-
docs/en/edge/cordova/compass/compass.md | 2 +-
.../cordova/compass/compass.watchHeading.md | 2 +-
.../compass/compass.watchHeadingFilter.md | 2 +-
.../compass/compassError/compassError.md | 2 +-
.../cordova/compass/parameters/compassError.md | 2 +-
.../compass/parameters/compassHeading.md | 2 +-
.../compass/parameters/compassOptions.md | 2 +-
.../compass/parameters/compassSuccess.md | 2 +-
docs/en/edge/cordova/connection/connection.md | 2 +-
.../edge/cordova/connection/connection.type.md | 2 +-
.../en/edge/cordova/contacts/Contact/contact.md | 2 +-
.../contacts/ContactAddress/contactaddress.md | 2 +-
.../contacts/ContactError/contactError.md | 2 +-
.../contacts/ContactField/contactfield.md | 2 +-
.../ContactFindOptions/contactfindoptions.md | 2 +-
.../cordova/contacts/ContactName/contactname.md | 2 +-
.../ContactOrganization/contactorganization.md | 2 +-
.../en/edge/cordova/contacts/contacts.create.md | 2 +-
docs/en/edge/cordova/contacts/contacts.find.md | 2 +-
docs/en/edge/cordova/contacts/contacts.md | 2 +-
.../cordova/contacts/parameters/contactError.md | 2 +-
.../contacts/parameters/contactFields.md | 2 +-
.../contacts/parameters/contactFindOptions.md | 2 +-
.../contacts/parameters/contactSuccess.md | 2 +-
docs/en/edge/cordova/device/device.cordova.md | 2 +-
docs/en/edge/cordova/device/device.md | 2 +-
docs/en/edge/cordova/device/device.model.md | 2 +-
docs/en/edge/cordova/device/device.name.md | 2 +-
docs/en/edge/cordova/device/device.platform.md | 2 +-
docs/en/edge/cordova/device/device.uuid.md | 2 +-
docs/en/edge/cordova/device/device.version.md | 2 +-
.../en/edge/cordova/events/events.backbutton.md | 2 +-
.../cordova/events/events.batterycritical.md | 2 +-
.../en/edge/cordova/events/events.batterylow.md | 2 +-
.../edge/cordova/events/events.batterystatus.md | 2 +-
.../edge/cordova/events/events.deviceready.md | 2 +-
.../edge/cordova/events/events.endcallbutton.md | 2 +-
docs/en/edge/cordova/events/events.md | 2 +-
.../en/edge/cordova/events/events.menubutton.md | 2 +-
docs/en/edge/cordova/events/events.offline.md | 2 +-
docs/en/edge/cordova/events/events.online.md | 2 +-
docs/en/edge/cordova/events/events.pause.md | 26 ++++++++++-----
docs/en/edge/cordova/events/events.resume.md | 35 +++++++++++++-------
.../edge/cordova/events/events.searchbutton.md | 5 +--
.../cordova/events/events.startcallbutton.md | 5 +--
.../cordova/events/events.volumedownbutton.md | 5 +--
.../cordova/events/events.volumeupbutton.md | 4 +--
.../file/directoryentry/directoryentry.md | 4 +--
.../file/directoryreader/directoryreader.md | 2 +-
docs/en/edge/cordova/file/file.md | 2 +-
.../en/edge/cordova/file/fileentry/fileentry.md | 4 +--
.../en/edge/cordova/file/fileerror/fileerror.md | 2 +-
docs/en/edge/cordova/file/fileobj/fileobj.md | 2 +-
.../edge/cordova/file/filereader/filereader.md | 2 +-
.../edge/cordova/file/filesystem/filesystem.md | 2 +-
.../cordova/file/filetransfer/filetransfer.md | 2 +-
.../file/filetransfererror/filetransfererror.md | 2 +-
.../file/fileuploadoptions/fileuploadoptions.md | 2 +-
.../file/fileuploadresult/fileuploadresult.md | 2 +-
.../edge/cordova/file/filewriter/filewriter.md | 2 +-
docs/en/edge/cordova/file/flags/flags.md | 2 +-
.../file/localfilesystem/localfilesystem.md | 2 +-
docs/en/edge/cordova/file/metadata/metadata.md | 4 +--
.../geolocation/Coordinates/coordinates.md | 2 +-
.../cordova/geolocation/Position/position.md | 2 +-
.../geolocation/PositionError/positionError.md | 2 +-
.../geolocation/geolocation.clearWatch.md | 2 +-
.../geolocation.getCurrentPosition.md | 2 +-
docs/en/edge/cordova/geolocation/geolocation.md | 2 +-
.../geolocation/geolocation.watchPosition.md | 2 +-
.../parameters/geolocation.options.md | 2 +-
.../geolocation/parameters/geolocationError.md | 2 +-
.../parameters/geolocationSuccess.md | 2 +-
.../GlobalizationError/globalizationerror.md | 2 +-
.../globalization/globalization.dateToString.md | 2 +-
.../globalization.getCurrencyPattern.md | 2 +-
.../globalization/globalization.getDateNames.md | 2 +-
.../globalization.getDatePattern.md | 2 +-
.../globalization.getFirstDayOfWeek.md | 2 +-
.../globalization.getLocaleName.md | 2 +-
.../globalization.getNumberPattern.md | 2 +-
.../globalization.getPreferredLanguage.md | 2 +-
.../globalization.isDayLightSavingsTime.md | 2 +-
.../edge/cordova/globalization/globalization.md | 2 +-
.../globalization.numberToString.md | 2 +-
.../globalization/globalization.stringToDate.md | 2 +-
.../globalization.stringToNumber.md | 2 +-
.../edge/cordova/inappbrowser/inappbrowser.md | 2 +-
.../en/edge/cordova/inappbrowser/window.open.md | 2 +-
.../edge/cordova/media/MediaError/mediaError.md | 2 +-
.../edge/cordova/media/Parameters/mediaError.md | 2 +-
docs/en/edge/cordova/media/capture/CaptureCB.md | 2 +-
.../edge/cordova/media/capture/CaptureError.md | 2 +-
.../cordova/media/capture/CaptureErrorCB.md | 2 +-
.../cordova/media/capture/ConfigurationData.md | 2 +-
.../media/capture/MediaFile.getFormatData.md | 2 +-
docs/en/edge/cordova/media/capture/MediaFile.md | 4 +--
.../edge/cordova/media/capture/MediaFileData.md | 2 +-
docs/en/edge/cordova/media/capture/capture.md | 2 +-
.../edge/cordova/media/capture/captureAudio.md | 2 +-
.../media/capture/captureAudioOptions.md | 2 +-
.../edge/cordova/media/capture/captureImage.md | 2 +-
.../media/capture/captureImageOptions.md | 2 +-
.../edge/cordova/media/capture/captureVideo.md | 2 +-
.../media/capture/captureVideoOptions.md | 2 +-
.../cordova/media/media.getCurrentPosition.md | 2 +-
docs/en/edge/cordova/media/media.getDuration.md | 2 +-
docs/en/edge/cordova/media/media.md | 2 +-
docs/en/edge/cordova/media/media.pause.md | 2 +-
docs/en/edge/cordova/media/media.play.md | 2 +-
docs/en/edge/cordova/media/media.release.md | 2 +-
docs/en/edge/cordova/media/media.seekTo.md | 2 +-
docs/en/edge/cordova/media/media.startRecord.md | 2 +-
docs/en/edge/cordova/media/media.stop.md | 2 +-
docs/en/edge/cordova/media/media.stopRecord.md | 2 +-
.../cordova/notification/notification.alert.md | 2 +-
.../cordova/notification/notification.beep.md | 2 +-
.../notification/notification.confirm.md | 2 +-
.../edge/cordova/notification/notification.md | 2 +-
.../cordova/notification/notification.prompt.md | 2 +-
.../notification/notification.vibrate.md | 2 +-
.../cordova/splashscreen/splashscreen.hide.md | 2 +-
.../edge/cordova/splashscreen/splashscreen.md | 2 +-
.../cordova/splashscreen/splashscreen.show.md | 2 +-
.../edge/cordova/storage/database/database.md | 2 +-
.../storage/localstorage/localstorage.md | 2 +-
.../cordova/storage/parameters/display_name.md | 4 +--
docs/en/edge/cordova/storage/parameters/name.md | 4 +--
docs/en/edge/cordova/storage/parameters/size.md | 4 +--
.../edge/cordova/storage/parameters/version.md | 2 +-
.../edge/cordova/storage/sqlerror/sqlerror.md | 2 +-
.../storage/sqlresultset/sqlresultset.md | 2 +-
.../sqlresultsetrowlist/sqlresultsetrowlist.md | 2 +-
.../storage/sqltransaction/sqltransaction.md | 2 +-
docs/en/edge/cordova/storage/storage.md | 2 +-
.../cordova/storage/storage.opendatabase.md | 2 +-
155 files changed, 208 insertions(+), 184 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
index 1a2b8e8..fb77e01 100644
--- a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
+++ b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
index 148dbce..3568cf0 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index 8f0b0f5..6b8a936 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.md b/docs/en/edge/cordova/accelerometer/accelerometer.md
index c578dbf..8e4609e 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
index 7f117d6..074687d 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
index 5faf51e..814df4d 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
index f52c045..0396055 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
index 9cdcdf7..c402ece 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/camera/camera.cleanup.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.cleanup.md b/docs/en/edge/cordova/camera/camera.cleanup.md
index 5d5e700..883cd12 100644
--- a/docs/en/edge/cordova/camera/camera.cleanup.md
+++ b/docs/en/edge/cordova/camera/camera.cleanup.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.getPicture.md b/docs/en/edge/cordova/camera/camera.getPicture.md
index 8608caf..cae7aba 100644
--- a/docs/en/edge/cordova/camera/camera.getPicture.md
+++ b/docs/en/edge/cordova/camera/camera.getPicture.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.md b/docs/en/edge/cordova/camera/camera.md
index 797b00d..026ccdb 100644
--- a/docs/en/edge/cordova/camera/camera.md
+++ b/docs/en/edge/cordova/camera/camera.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
index 180e83f..70ce431 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
index 25118c2..8bd0728 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/camera/parameter/cameraError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraError.md b/docs/en/edge/cordova/camera/parameter/cameraError.md
index 1460a8e..f36840f 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraError.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraError.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraOptions.md b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
index 0414446..a7a9974 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraSuccess.md b/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
index ab213c6..12e9c26 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.clearWatch.md b/docs/en/edge/cordova/compass/compass.clearWatch.md
index 839c0e0..c270820 100755
--- a/docs/en/edge/cordova/compass/compass.clearWatch.md
+++ b/docs/en/edge/cordova/compass/compass.clearWatch.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.clearWatchFilter.md b/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
index 92b7c9c..97ea194 100644
--- a/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
+++ b/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
index b1c08f5..c8af90a 100755
--- a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
+++ b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.md b/docs/en/edge/cordova/compass/compass.md
index 7797f10..d85be8c 100755
--- a/docs/en/edge/cordova/compass/compass.md
+++ b/docs/en/edge/cordova/compass/compass.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeading.md b/docs/en/edge/cordova/compass/compass.watchHeading.md
index 0f7c0b2..b3c9fd5 100755
--- a/docs/en/edge/cordova/compass/compass.watchHeading.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeading.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md b/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
index f64c2c7..6a0283f 100644
--- a/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compassError/compassError.md b/docs/en/edge/cordova/compass/compassError/compassError.md
index c8850b7..43058eb 100644
--- a/docs/en/edge/cordova/compass/compassError/compassError.md
+++ b/docs/en/edge/cordova/compass/compassError/compassError.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassError.md b/docs/en/edge/cordova/compass/parameters/compassError.md
index 7a8fe49..fb4e09a 100755
--- a/docs/en/edge/cordova/compass/parameters/compassError.md
+++ b/docs/en/edge/cordova/compass/parameters/compassError.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassHeading.md b/docs/en/edge/cordova/compass/parameters/compassHeading.md
index dc15e5c..544a6b6 100644
--- a/docs/en/edge/cordova/compass/parameters/compassHeading.md
+++ b/docs/en/edge/cordova/compass/parameters/compassHeading.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassOptions.md b/docs/en/edge/cordova/compass/parameters/compassOptions.md
index 62e84a3..99e648c 100755
--- a/docs/en/edge/cordova/compass/parameters/compassOptions.md
+++ b/docs/en/edge/cordova/compass/parameters/compassOptions.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassSuccess.md b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
index 9f4daf0..4e11974 100644
--- a/docs/en/edge/cordova/compass/parameters/compassSuccess.md
+++ b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.md b/docs/en/edge/cordova/connection/connection.md
index bb773e9..ea24cc9 100644
--- a/docs/en/edge/cordova/connection/connection.md
+++ b/docs/en/edge/cordova/connection/connection.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.type.md b/docs/en/edge/cordova/connection/connection.type.md
index 89bffbe..341cf68 100644
--- a/docs/en/edge/cordova/connection/connection.type.md
+++ b/docs/en/edge/cordova/connection/connection.type.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/Contact/contact.md b/docs/en/edge/cordova/contacts/Contact/contact.md
index 3f05775..2b5985e 100644
--- a/docs/en/edge/cordova/contacts/Contact/contact.md
+++ b/docs/en/edge/cordova/contacts/Contact/contact.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
index 8939fe5..7038135 100644
--- a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
+++ b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactError/contactError.md b/docs/en/edge/cordova/contacts/ContactError/contactError.md
index 0e67b68..0be9191 100644
--- a/docs/en/edge/cordova/contacts/ContactError/contactError.md
+++ b/docs/en/edge/cordova/contacts/ContactError/contactError.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactField/contactfield.md b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
index 727b184..d18fafc 100644
--- a/docs/en/edge/cordova/contacts/ContactField/contactfield.md
+++ b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
index 10ff14a..cfa939a 100644
--- a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactName/contactname.md b/docs/en/edge/cordova/contacts/ContactName/contactname.md
index 9799472..912355c 100644
--- a/docs/en/edge/cordova/contacts/ContactName/contactname.md
+++ b/docs/en/edge/cordova/contacts/ContactName/contactname.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
index 7ddbf8e..497a368 100644
--- a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.create.md b/docs/en/edge/cordova/contacts/contacts.create.md
index f3548d3..6552884 100644
--- a/docs/en/edge/cordova/contacts/contacts.create.md
+++ b/docs/en/edge/cordova/contacts/contacts.create.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.find.md b/docs/en/edge/cordova/contacts/contacts.find.md
index 592c621..3d527be 100644
--- a/docs/en/edge/cordova/contacts/contacts.find.md
+++ b/docs/en/edge/cordova/contacts/contacts.find.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.md b/docs/en/edge/cordova/contacts/contacts.md
index 3ed59e5..28e3e5e 100644
--- a/docs/en/edge/cordova/contacts/contacts.md
+++ b/docs/en/edge/cordova/contacts/contacts.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/parameters/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactError.md b/docs/en/edge/cordova/contacts/parameters/contactError.md
index 5c451b1..4ce8289 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactError.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactError.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactFields.md b/docs/en/edge/cordova/contacts/parameters/contactFields.md
index d3b5988..92f80c6 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactFields.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactFields.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
index 660615b..7c0d59b 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
index a8cf4dc..c3cdda2 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.cordova.md b/docs/en/edge/cordova/device/device.cordova.md
index c7891ff..94d9df0 100644
--- a/docs/en/edge/cordova/device/device.cordova.md
+++ b/docs/en/edge/cordova/device/device.cordova.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/device/device.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.md b/docs/en/edge/cordova/device/device.md
index 3748d36..294cb42 100644
--- a/docs/en/edge/cordova/device/device.md
+++ b/docs/en/edge/cordova/device/device.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/device/device.model.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.model.md b/docs/en/edge/cordova/device/device.model.md
index 59a711b..b645772 100644
--- a/docs/en/edge/cordova/device/device.model.md
+++ b/docs/en/edge/cordova/device/device.model.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.name.md b/docs/en/edge/cordova/device/device.name.md
index 5391f8d..f671e8c 100644
--- a/docs/en/edge/cordova/device/device.name.md
+++ b/docs/en/edge/cordova/device/device.name.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.platform.md b/docs/en/edge/cordova/device/device.platform.md
index a259587..893b02f 100644
--- a/docs/en/edge/cordova/device/device.platform.md
+++ b/docs/en/edge/cordova/device/device.platform.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.uuid.md b/docs/en/edge/cordova/device/device.uuid.md
index 565ffae..90d598c 100644
--- a/docs/en/edge/cordova/device/device.uuid.md
+++ b/docs/en/edge/cordova/device/device.uuid.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.version.md b/docs/en/edge/cordova/device/device.version.md
index 9e1db70..8304536 100644
--- a/docs/en/edge/cordova/device/device.version.md
+++ b/docs/en/edge/cordova/device/device.version.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.backbutton.md b/docs/en/edge/cordova/events/events.backbutton.md
index 46e6d84..4208187 100644
--- a/docs/en/edge/cordova/events/events.backbutton.md
+++ b/docs/en/edge/cordova/events/events.backbutton.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterycritical.md b/docs/en/edge/cordova/events/events.batterycritical.md
index 0fa68f9..5568845 100644
--- a/docs/en/edge/cordova/events/events.batterycritical.md
+++ b/docs/en/edge/cordova/events/events.batterycritical.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterylow.md b/docs/en/edge/cordova/events/events.batterylow.md
index d40ddf6..6159c3d 100644
--- a/docs/en/edge/cordova/events/events.batterylow.md
+++ b/docs/en/edge/cordova/events/events.batterylow.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.batterystatus.md b/docs/en/edge/cordova/events/events.batterystatus.md
index 9040074..e91050d 100644
--- a/docs/en/edge/cordova/events/events.batterystatus.md
+++ b/docs/en/edge/cordova/events/events.batterystatus.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.deviceready.md b/docs/en/edge/cordova/events/events.deviceready.md
index 30786ae..663f598 100644
--- a/docs/en/edge/cordova/events/events.deviceready.md
+++ b/docs/en/edge/cordova/events/events.deviceready.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.endcallbutton.md b/docs/en/edge/cordova/events/events.endcallbutton.md
index a9abb30..1372e25 100644
--- a/docs/en/edge/cordova/events/events.endcallbutton.md
+++ b/docs/en/edge/cordova/events/events.endcallbutton.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.md b/docs/en/edge/cordova/events/events.md
index 4ae67aa..1581844 100644
--- a/docs/en/edge/cordova/events/events.md
+++ b/docs/en/edge/cordova/events/events.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.menubutton.md b/docs/en/edge/cordova/events/events.menubutton.md
index 661502f..ae97e43 100644
--- a/docs/en/edge/cordova/events/events.menubutton.md
+++ b/docs/en/edge/cordova/events/events.menubutton.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.offline.md b/docs/en/edge/cordova/events/events.offline.md
index 62d41cb..0a4864a 100644
--- a/docs/en/edge/cordova/events/events.offline.md
+++ b/docs/en/edge/cordova/events/events.offline.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.online.md b/docs/en/edge/cordova/events/events.online.md
index 7c49990..549359b 100644
--- a/docs/en/edge/cordova/events/events.online.md
+++ b/docs/en/edge/cordova/events/events.online.md
@@ -1,5 +1,5 @@
---
- license: Licensed to the Apache Software Foundation (ASF) under one
+license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.pause.md b/docs/en/edge/cordova/events/events.pause.md
index 3a5604d..6615369 100644
--- a/docs/en/edge/cordova/events/events.pause.md
+++ b/docs/en/edge/cordova/events/events.pause.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
pause
===========
-This event fires when a Cordova application is put into the background.
+The event fires when a Cordova application is put into the background.
document.addEventListener("pause", yourCallbackFunction, false);
@@ -28,7 +28,7 @@ Details
-------
Cordova consists of two code bases: native and JavaScript. When the
-native code puts the application into the background, the pause event
+native code puts the application into the background, the `pause` event
fires.
Applications typically should use `document.addEventListener` to
@@ -92,10 +92,20 @@ Full Example
iOS Quirks
--------------------------
-In the pause handler, any calls that go through Objective-C will not work, nor will any calls that are interactive, like alerts. This means that you cannot call console.log (and its variants), or any calls from Plugins or the Cordova API. These will only be processed when the app resumes (processed on the next run-loop).
-- __resign__ event
-
- This iOS specific event is available as a variant of the **pause** event, and is often used to detect when the "Lock" button has been pressed to lock the device when your app is the foreground app. If your app (and device) is enabled for multi-tasking, this will be paired with a subsequent **pause** event, but only under iOS 5 (effectively all "locked" apps in iOS 5 that have multi-tasking enabled are put to the background).
-
- Under iOS 5, if you want your app to still run when the device is locked, you will have to disable multi-tasking (UIApplicationExitsOnSuspend - YES) for your app. This is different when you are on iOS 4 - to have your app run when the device is locked, the multi-tasking setting for your app does not matter.
+In the `pause` handler, any calls that go through Objective-C do not
+work, nor do any calls that are interactive, such as alerts. You
+can't make calls with `console.log()`, or any calls from plugins or
+the Cordova API. They are only processed when the app resumes, on the
+next run-loop.
+
+The iOS-specific `resign` event is available as an alternative to
+`pause`, and detects when users enable the __Lock__ button to lock the
+device with the app running in the foreground. If the app (and
+device) is enabled for multi-tasking, this is paired with a subsequent
+`pause` event, but only under iOS 5. In effect, all locked apps in iOS
+5 that have multi-tasking enabled are pushed to the background. For
+apps to remain running when locked under iOS 5, disable the app's
+multi-tasking by setting
+[UIApplicationExitsOnSuspend](http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html)
+to `YES`. To run when locked on iOS 4, this setting does not matter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.resume.md b/docs/en/edge/cordova/events/events.resume.md
index 0e0057f..2bded1c 100644
--- a/docs/en/edge/cordova/events/events.resume.md
+++ b/docs/en/edge/cordova/events/events.resume.md
@@ -20,14 +20,16 @@ license: Licensed to the Apache Software Foundation (ASF) under one
resume
===========
-This event fires when a Cordova application is retrieved from the background.
+The event fires when a Cordova application is retrieved from the background.
document.addEventListener("resume", yourCallbackFunction, false);
Details
-------
-Cordova consists of two code bases: native and JavaScript. While the native code pulls the application from the background the resume event is fired.
+Cordova consists of two code bases: native and JavaScript. The
+`resume` event fires when the native code pulls the application from
+the background.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
@@ -90,17 +92,10 @@ Full Example
iOS Quirks
--------------------------
-Any calls to console.log during your **pause** event handler will be run now when the app resumes, see the iOS Quirks section for the **pause** event for an explanation.
-- __active__ event
-
- This iOS specific event is available as a variant of the **resume** event, and is often used to detect when the "Lock" button has been pressed to unlock the device when your app is the foreground app. If your app (and device) is enabled for multi-tasking, this will be paired with a subsequent **resume** event, but only under iOS 5 (effectively all "locked" apps in iOS 5 that have multi-tasking enabled are put to the background).
-
- Under iOS 5, if you want your app to still run when the device is locked, you will have to disable multi-tasking (UIApplicationExitsOnSuspend - YES) for your app. This is different when you are on iOS 4 - to have your app run when the device is locked, the multi-tasking setting for your app does not matter.
-
-- __resume__ event
-
- Interactive functions like alert() when the resume event fires will need to be wrapped in a setTimeout call with a timeout value of zero, or else the app will hang. e.g.
+When called from a `resume` event handler, interactive functions such
+as `alert()` need to be wrapped in a `setTimeout()` call with a
+timeout value of zero, or else the app hangs. For example:
document.addEventListener("resume", onResume, false);
function onResume() {
@@ -108,3 +103,19 @@ Any calls to console.log during your **pause** event handler will be run now whe
// TODO: do your thing!
}, 0);
}
+
+Any interactive functions called from a `pause` event handler execute
+later when the app resumes, as signaled by the `resume` event. These
+include alerts, `console.log()`, and any calls from plugins or the
+Cordova API, which go through Objective-C.
+
+The iOS-specific `active` event is available as an alternative to
+`resume`, and detects when users disable the __Lock__ button to unlock
+the device with the app running in the foreground. If the app (and
+device) is enabled for multi-tasking, this is paired with a subsequent
+`resume` event, but only under iOS 5. In effect, all locked apps in
+iOS 5 that have multi-tasking enabled are pushed to the background.
+For apps to remain running when locked under iOS 5, disable the app's
+multi-tasking by setting
+[UIApplicationExitsOnSuspend](http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html)
+to `YES`. To run when locked on iOS 4, this setting does not matter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.searchbutton.md b/docs/en/edge/cordova/events/events.searchbutton.md
index 12b09b8..da54bcd 100644
--- a/docs/en/edge/cordova/events/events.searchbutton.md
+++ b/docs/en/edge/cordova/events/events.searchbutton.md
@@ -20,14 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
searchbutton
===========
-This event fires when the user presses the search button on Android.
+The event fires when the user presses the search button on Android.
document.addEventListener("searchbutton", yourCallbackFunction, false);
Details
-------
-If you need to override the default search button behavior on Android you can register an event listener for the 'searchbutton' event.
+If you need to override the default search button behavior on Android
+you can register an event listener for the 'searchbutton' event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.startcallbutton.md b/docs/en/edge/cordova/events/events.startcallbutton.md
index ca6ac46..6720823 100644
--- a/docs/en/edge/cordova/events/events.startcallbutton.md
+++ b/docs/en/edge/cordova/events/events.startcallbutton.md
@@ -20,14 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
startcallbutton
===========
-This event fires when the user presses the start call button.
+The event fires when the user presses the start call button.
document.addEventListener("startcallbutton", yourCallbackFunction, false);
Details
-------
-If you need to override the default start call behavior you can register an event listener for the 'startcallbutton' event.
+If you need to override the default start call behavior you can
+register an event listener for the `startcallbutton` event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumedownbutton.md b/docs/en/edge/cordova/events/events.volumedownbutton.md
index 09c9d64..0704318 100644
--- a/docs/en/edge/cordova/events/events.volumedownbutton.md
+++ b/docs/en/edge/cordova/events/events.volumedownbutton.md
@@ -20,14 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
volumedownbutton
===========
-This event fires when the user presses the volume down button.
+The event fires when the user presses the volume down button.
document.addEventListener("volumedownbutton", yourCallbackFunction, false);
Details
-------
-If you need to override the default volume down behavior you can register an event listener for the 'volumedownbutton' event.
+If you need to override the default volume down behavior you can
+register an event listener for the `volumedownbutton` event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumeupbutton.md b/docs/en/edge/cordova/events/events.volumeupbutton.md
index 1016303..73f64a9 100644
--- a/docs/en/edge/cordova/events/events.volumeupbutton.md
+++ b/docs/en/edge/cordova/events/events.volumeupbutton.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
volumeupbutton
===========
-This event fires when the user presses the volume up button.
+The event fires when the user presses the volume up button.
document.addEventListener("volumeupbutton", yourCallbackFunction, false);
@@ -28,7 +28,7 @@ Details
-------
If you need to override the default volume up behavior you can
-register an event listener for the 'volumeupbutton' event.
+register an event listener for the `volumeupbutton` event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index b7d4da8..05121d7 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -30,7 +30,7 @@ Properties
- __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 attributes are defined by the W3C specification, but are __not supported__ by Cordova:
+__NOTE:__ The following attributes are defined by the W3C specification, but are __not supported__ by Cordova:
- __filesystem:__ The file system on which the DirectoryEntry resides. _(FileSystem)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryreader/directoryreader.md b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
index 2e88be1..e7aff92 100644
--- a/docs/en/edge/cordova/file/directoryreader/directoryreader.md
+++ b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/file.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/file.md b/docs/en/edge/cordova/file/file.md
index 192d1ee..18e0a7a 100644
--- a/docs/en/edge/cordova/file/file.md
+++ b/docs/en/edge/cordova/file/file.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileentry/fileentry.md b/docs/en/edge/cordova/file/fileentry/fileentry.md
index b67bee2..b1ac22b 100644
--- a/docs/en/edge/cordova/file/fileentry/fileentry.md
+++ b/docs/en/edge/cordova/file/fileentry/fileentry.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -30,7 +30,7 @@ Properties
- __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 attributes are defined by the W3C specification, but are __not supported__ by Cordova:
+__NOTE:__ The following attributes are defined by the W3C specification, but are __not supported__ by Cordova:
- __filesystem:__ The file system on which the FileEntry resides. _(FileSystem)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileerror/fileerror.md b/docs/en/edge/cordova/file/fileerror/fileerror.md
index 78ab485..5aca921 100644
--- a/docs/en/edge/cordova/file/fileerror/fileerror.md
+++ b/docs/en/edge/cordova/file/fileerror/fileerror.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileobj/fileobj.md b/docs/en/edge/cordova/file/fileobj/fileobj.md
index 7455289..4d42525 100644
--- a/docs/en/edge/cordova/file/fileobj/fileobj.md
+++ b/docs/en/edge/cordova/file/fileobj/fileobj.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filereader/filereader.md b/docs/en/edge/cordova/file/filereader/filereader.md
index 3d44f20..17220ff 100644
--- a/docs/en/edge/cordova/file/filereader/filereader.md
+++ b/docs/en/edge/cordova/file/filereader/filereader.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filesystem/filesystem.md b/docs/en/edge/cordova/file/filesystem/filesystem.md
index f51dd41..b768e78 100644
--- a/docs/en/edge/cordova/file/filesystem/filesystem.md
+++ b/docs/en/edge/cordova/file/filesystem/filesystem.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfer/filetransfer.md b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
index 6b8e864..91e881d 100644
--- a/docs/en/edge/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md b/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
index 52e8eff..7c7d634 100644
--- a/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
+++ b/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
index feeb2e3..d0c1c3c 100644
--- a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md b/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
index 05abd59..df3e040 100644
--- a/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filewriter/filewriter.md b/docs/en/edge/cordova/file/filewriter/filewriter.md
index fd62f5f..8477192 100644
--- a/docs/en/edge/cordova/file/filewriter/filewriter.md
+++ b/docs/en/edge/cordova/file/filewriter/filewriter.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/flags/flags.md b/docs/en/edge/cordova/file/flags/flags.md
index fe7e224..5380de7 100644
--- a/docs/en/edge/cordova/file/flags/flags.md
+++ b/docs/en/edge/cordova/file/flags/flags.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
index 8d8ff37..324d33c 100644
--- a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
+++ b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/metadata/metadata.md b/docs/en/edge/cordova/file/metadata/metadata.md
index 46eacb9..4871069 100644
--- a/docs/en/edge/cordova/file/metadata/metadata.md
+++ b/docs/en/edge/cordova/file/metadata/metadata.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -49,4 +49,4 @@ Quick Example
}
// Request the metadata object for this entry
- entry.getMetadata(win, null);
\ No newline at end of file
+ entry.getMetadata(win, null);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
index 62808be..eba7792 100644
--- a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
+++ b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Position/position.md b/docs/en/edge/cordova/geolocation/Position/position.md
index abab68d..94113b3 100644
--- a/docs/en/edge/cordova/geolocation/Position/position.md
+++ b/docs/en/edge/cordova/geolocation/Position/position.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/PositionError/positionError.md b/docs/en/edge/cordova/geolocation/PositionError/positionError.md
index 5fda2f5..1290af1 100755
--- a/docs/en/edge/cordova/geolocation/PositionError/positionError.md
+++ b/docs/en/edge/cordova/geolocation/PositionError/positionError.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md b/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
index 50e5896..ff747d0 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
index 3831afd..5e505e9 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.md b/docs/en/edge/cordova/geolocation/geolocation.md
index aaa0f93..55ea2c8 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
index bba8212..10beaa8 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a03c5ae/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
index d822d24..2d5112d 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
[33/46] docs commit: notifications
Posted by mw...@apache.org.
notifications
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/03ce2cad
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/03ce2cad
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/03ce2cad
Branch: refs/heads/master
Commit: 03ce2cadfa516a227f733e0e0c1ed9c37a1cd042
Parents: 6e77968
Author: Mike Sierra <le...@gmail.com>
Authored: Sun May 19 14:31:12 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Sun May 19 14:31:12 2013 -0400
----------------------------------------------------------------------
.../notification/notification.confirm.md | 65 +++++++++++---------
.../edge/cordova/notification/notification.md | 2 +-
.../cordova/notification/notification.prompt.md | 29 ++++-----
.../notification/notification.vibrate.md | 16 ++---
4 files changed, 59 insertions(+), 53 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/03ce2cad/docs/en/edge/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.confirm.md b/docs/en/edge/cordova/notification/notification.confirm.md
index b7c8c16..4b87585 100755
--- a/docs/en/edge/cordova/notification/notification.confirm.md
+++ b/docs/en/edge/cordova/notification/notification.confirm.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,27 +20,30 @@ license: Licensed to the Apache Software Foundation (ASF) under one
notification.confirm
====================
-Shows a customizable confirmation dialog box.
+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, Default: "Confirm")
-- __buttonLabels__: Comma separated string with button labels _(String)_ (Optional, Default: "OK,Cancel")
+- __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
-----------
-Function `notification.confirm` displays a native dialog box that is more customizable than the browser's `confirm` function.
+The `notification.confirm` method displays a native dialog box that is
+more customizable than the browser's `confirm` function.
confirmCallback
---------------
The `confirmCallback` executes when the user presses one of the
-buttons on the confirmation dialog box.
+buttons in the confirmation dialog box.
-The callback takes the argument `buttonIndex` _(Number)_, which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc.
+The callback takes the argument `buttonIndex` _(Number)_, which is the
+index of the pressed button. Note that the index uses one-based
+indexing, so the value is `1`, `2`, `3`, etc.
Supported Platforms
-------------------
@@ -56,19 +59,19 @@ Supported Platforms
Quick Example
-------------
- // process the confirmation dialog result
- function onConfirm(buttonIndex) {
- alert('You selected button ' + buttonIndex);
- }
+ // process the confirmation dialog result
+ function onConfirm(buttonIndex) {
+ alert('You selected button ' + buttonIndex);
+ }
// Show a custom confirmation dialog
//
function showConfirm() {
navigator.notification.confirm(
- 'You are the winner!', // message
- onConfirm, // callback to invoke with index of button pressed
- 'Game Over', // title
- 'Restart,Exit' // buttonLabels
+ 'You are the winner!', // message
+ onConfirm, // callback to invoke with index of button pressed
+ 'Game Over', // title
+ 'Restart,Exit' // buttonLabels
);
}
@@ -93,19 +96,19 @@ Full Example
// Empty
}
- // process the confirmation dialog result
- function onConfirm(buttonIndex) {
- alert('You selected button ' + buttonIndex);
- }
+ // process the confirmation dialog result
+ function onConfirm(buttonIndex) {
+ alert('You selected button ' + buttonIndex);
+ }
// Show a custom confirmation dialog
//
function showConfirm() {
navigator.notification.confirm(
- 'You are the winner!', // message
- onConfirm, // callback to invoke with index of button pressed
- 'Game Over', // title
- 'Restart,Exit' // buttonLabels
+ 'You are the winner!', // message
+ onConfirm, // callback to invoke with index of button pressed
+ 'Game Over', // title
+ 'Restart,Exit' // buttonLabels
);
}
@@ -119,16 +122,18 @@ Full Example
Windows Phone 7 and 8 Quirks
----------------------
-- There is no built-in browser function for `window.confirm`
- - You can bind `window.confirm` by assigning `window.confirm = navigator.notification.confirm;`.
-- Calls to `alert` and `confirm` are non-blocking and result is only available asynchronously.
+- There is no built-in browser function for `window.confirm`, but you can bind it by assigning:
+
+ window.confirm = navigator.notification.confirm;
+
+- Calls to `alert` and `confirm` are non-blocking, so the result is only available asynchronously.
Bada 2.x Quirks
---------------
-- `confirm` uses the browser's built-in `alert` function.
+- Calls to `confirm` uses the browser's built-in `alert` function.
Bada 1.2 Quirks
---------------
-- Ignore button names, always `'OK|Cancel'`.
+- Ignores button names, so always evaluates as `'OK|Cancel'`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/03ce2cad/docs/en/edge/cordova/notification/notification.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.md b/docs/en/edge/cordova/notification/notification.md
index e18b13b..52ac21f 100644
--- a/docs/en/edge/cordova/notification/notification.md
+++ b/docs/en/edge/cordova/notification/notification.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/03ce2cad/docs/en/edge/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.prompt.md b/docs/en/edge/cordova/notification/notification.prompt.md
index 631c80d..6940458 100644
--- a/docs/en/edge/cordova/notification/notification.prompt.md
+++ b/docs/en/edge/cordova/notification/notification.prompt.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -24,25 +24,26 @@ Shows a customizable prompt dialog box.
navigator.notification.prompt(message, promptCallback, [title], [buttonLabels])
-- __message__: Dialog message _(String)_
-- __promptCallback__: Callback to invoke when a button is pressed _(Function)_
-- __title__: Dialog title _(String)_ (Optional, Default: "Prompt")
-- __buttonLabels__: Array of strings for the button labels _(Array)_ (Optional, Default: ["OK","Cancel"])
+- __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"]`)
Description
-----------
-Function `notification.prompt` displays a native dialog box that is more customizable than the browser's `prompt` function.
+The `notification.prompt` method displays a native dialog box that is
+more customizable than the browser's `prompt` function.
promptCallback
---------------
-The `promptCallback` executes when the user has pressed one of the buttons on the prompt dialog box.
-
-The callback takes the argument `results` which contains the following properties:
+The `promptCallback` executes when the user presses one of the buttons
+in the prompt dialog box. The `results` object passed to the callback
+contains the following properties:
-- __buttonIndex__: _(Number)_, which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc.
-- __input1__: _(String)_, which is the text entered in the prompt dialog box.
+- __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
-------------------
@@ -63,7 +64,7 @@ Quick Example
function showPrompt() {
navigator.notification.prompt(
'Please enter your name', // message
- onPrompt, // callback to invoke
+ onPrompt, // callback to invoke
'Registration', // title
['Ok','Exit'] // buttonLabels
);
@@ -116,5 +117,5 @@ Full Example
Android Quirks
----------------------
-- Android supports up to a maximum of 3 buttons. Additional button labels over 3 are ignored.
-- On Android 3.0 and later, the buttons will be displayed in reverse order for devices using the Holo theme.
+- 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/03ce2cad/docs/en/edge/cordova/notification/notification.vibrate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.vibrate.md b/docs/en/edge/cordova/notification/notification.vibrate.md
index fcc92f2..779436a 100644
--- a/docs/en/edge/cordova/notification/notification.vibrate.md
+++ b/docs/en/edge/cordova/notification/notification.vibrate.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -24,7 +24,7 @@ Vibrates the device for the specified amount of time.
navigator.notification.vibrate(milliseconds)
-- __time__: Milliseconds to vibrate the device. 1000 milliseconds equals 1 second _(Number)_
+- __time__: Milliseconds to vibrate the device, where 1000 milliseconds equals 1 second. _(Number)_
Supported Platforms
-------------------
@@ -66,11 +66,11 @@ Full Example
// Show a custom alert
//
function showAlert() {
- navigator.notification.alert(
- 'You are the winner!', // message
- 'Game Over', // title
- 'Done' // buttonName
- );
+ navigator.notification.alert(
+ 'You are the winner!', // message
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
}
// Beep three times
@@ -97,7 +97,7 @@ Full Example
iPhone Quirks
-------------
-- __time__: Ignores the time and vibrates for a pre-set amount of time.
+- __time__: Ignores the specified time and vibrates for a pre-set amount of time.
navigator.notification.vibrate();
navigator.notification.vibrate(2500); // 2500 is ignored
[19/46] docs commit: edits up to menu button event
Posted by mw...@apache.org.
edits up to menu button event
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/6899777b
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/6899777b
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/6899777b
Branch: refs/heads/master
Commit: 6899777bc8c01923b68902d3ffefc8be89cf003a
Parents: 9048602
Author: Mike Sierra <le...@gmail.com>
Authored: Wed May 15 09:52:38 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Wed May 15 09:52:38 2013 -0400
----------------------------------------------------------------------
.../accelerometer/acceleration/acceleration.md | 1 -
.../accelerometer/accelerometer.clearWatch.md | 4 +-
.../accelerometer.getCurrentAcceleration.md | 2 +-
.../accelerometer.watchAcceleration.md | 4 +-
docs/en/edge/cordova/camera/camera.cleanup.md | 3 +-
.../en/edge/cordova/camera/camera.getPicture.md | 27 +++----
.../camera/parameter/CameraPopoverOptions.md | 6 +-
.../cordova/camera/parameter/cameraOptions.md | 2 +-
.../edge/cordova/compass/compass.clearWatch.md | 3 +-
.../compass/compass.getCurrentHeading.md | 2 +-
.../cordova/compass/compass.watchHeading.md | 5 +-
.../compass/compassError/compassError.md | 3 +-
.../cordova/compass/parameters/compassError.md | 2 +-
.../compass/parameters/compassSuccess.md | 1 -
.../edge/cordova/connection/connection.type.md | 2 +-
.../en/edge/cordova/contacts/Contact/contact.md | 85 ++++++++++----------
.../contacts/ContactAddress/contactaddress.md | 50 ++++++------
.../contacts/ContactError/contactError.md | 7 +-
.../contacts/ContactField/contactfield.md | 41 +++++++---
.../ContactFindOptions/contactfindoptions.md | 10 +--
.../cordova/contacts/ContactName/contactname.md | 56 ++++++-------
.../ContactOrganization/contactorganization.md | 44 +++++-----
.../en/edge/cordova/contacts/contacts.create.md | 7 +-
docs/en/edge/cordova/contacts/contacts.find.md | 34 +++++---
docs/en/edge/cordova/contacts/contacts.md | 2 +-
.../cordova/contacts/parameters/contactError.md | 4 +-
.../contacts/parameters/contactFields.md | 4 +-
.../contacts/parameters/contactFindOptions.md | 17 ++--
.../contacts/parameters/contactSuccess.md | 9 ++-
docs/en/edge/cordova/device/device.cordova.md | 12 +--
docs/en/edge/cordova/device/device.md | 2 +-
docs/en/edge/cordova/device/device.model.md | 29 ++++---
docs/en/edge/cordova/device/device.name.md | 32 ++++----
docs/en/edge/cordova/device/device.platform.md | 21 ++---
docs/en/edge/cordova/device/device.uuid.md | 30 ++++---
docs/en/edge/cordova/device/device.version.md | 12 +--
.../en/edge/cordova/events/events.backbutton.md | 12 +--
.../cordova/events/events.batterycritical.md | 24 +++---
.../en/edge/cordova/events/events.batterylow.md | 23 +++---
.../edge/cordova/events/events.batterystatus.md | 29 ++++---
.../edge/cordova/events/events.deviceready.md | 21 +++--
.../edge/cordova/events/events.endcallbutton.md | 9 ++-
docs/en/edge/cordova/events/events.md | 2 +-
.../en/edge/cordova/events/events.menubutton.md | 8 +-
docs/en/edge/cordova/events/events.offline.md | 7 +-
docs/en/edge/cordova/events/events.online.md | 7 +-
docs/en/edge/cordova/events/events.pause.md | 13 +--
docs/en/edge/cordova/events/events.resume.md | 19 ++---
.../edge/cordova/events/events.searchbutton.md | 5 +-
.../cordova/events/events.startcallbutton.md | 5 +-
.../cordova/events/events.volumedownbutton.md | 5 +-
.../cordova/events/events.volumeupbutton.md | 5 +-
.../file/directoryentry/directoryentry.md | 16 +---
.../file/directoryreader/directoryreader.md | 3 +-
.../en/edge/cordova/file/fileentry/fileentry.md | 16 +---
.../en/edge/cordova/file/fileerror/fileerror.md | 4 +-
docs/en/edge/cordova/file/fileobj/fileobj.md | 1 -
.../edge/cordova/file/filereader/filereader.md | 8 +-
.../cordova/file/filetransfer/filetransfer.md | 14 ++--
.../file/fileuploadoptions/fileuploadoptions.md | 3 +-
.../file/fileuploadresult/fileuploadresult.md | 2 +-
.../edge/cordova/file/filewriter/filewriter.md | 4 +-
.../file/localfilesystem/localfilesystem.md | 1 -
.../geolocation/Coordinates/coordinates.md | 4 +-
.../cordova/geolocation/Position/position.md | 2 +-
.../geolocation/geolocation.clearWatch.md | 5 +-
.../geolocation.getCurrentPosition.md | 5 +-
docs/en/edge/cordova/geolocation/geolocation.md | 1 -
.../geolocation/geolocation.watchPosition.md | 1 -
.../GlobalizationError/globalizationerror.md | 2 +-
.../globalization/globalization.dateToString.md | 4 +-
.../globalization.getCurrencyPattern.md | 3 +-
.../globalization/globalization.getDateNames.md | 2 -
.../globalization.getFirstDayOfWeek.md | 1 -
.../globalization.getLocaleName.md | 4 +-
.../globalization.getNumberPattern.md | 3 +-
.../globalization.getPreferredLanguage.md | 2 -
.../globalization/globalization.stringToDate.md | 6 +-
.../globalization.stringToNumber.md | 2 -
.../edge/cordova/inappbrowser/inappbrowser.md | 5 +-
.../en/edge/cordova/inappbrowser/window.open.md | 6 +-
.../edge/cordova/media/MediaError/mediaError.md | 1 -
docs/en/edge/cordova/media/capture/CaptureCB.md | 2 +-
.../edge/cordova/media/capture/CaptureError.md | 2 +-
.../cordova/media/capture/ConfigurationData.md | 7 +-
.../media/capture/MediaFile.getFormatData.md | 6 +-
.../edge/cordova/media/capture/MediaFileData.md | 10 +--
docs/en/edge/cordova/media/capture/capture.md | 3 +-
.../edge/cordova/media/capture/captureAudio.md | 10 +--
.../edge/cordova/media/capture/captureImage.md | 13 ++-
.../edge/cordova/media/capture/captureVideo.md | 12 +--
.../cordova/media/media.getCurrentPosition.md | 13 ++-
docs/en/edge/cordova/media/media.getDuration.md | 12 ++-
docs/en/edge/cordova/media/media.md | 4 +-
docs/en/edge/cordova/media/media.pause.md | 14 ++--
docs/en/edge/cordova/media/media.play.md | 13 ++-
docs/en/edge/cordova/media/media.release.md | 11 ++-
docs/en/edge/cordova/media/media.seekTo.md | 12 ++-
docs/en/edge/cordova/media/media.startRecord.md | 12 ++-
docs/en/edge/cordova/media/media.stop.md | 13 ++-
docs/en/edge/cordova/media/media.stopRecord.md | 12 ++-
.../cordova/notification/notification.beep.md | 2 +-
.../notification/notification.confirm.md | 1 -
.../edge/cordova/splashscreen/splashscreen.md | 2 -
.../edge/cordova/storage/database/database.md | 6 +-
.../storage/localstorage/localstorage.md | 3 +-
.../storage/sqlresultset/sqlresultset.md | 6 +-
.../sqlresultsetrowlist/sqlresultsetrowlist.md | 2 +-
.../storage/sqltransaction/sqltransaction.md | 4 +-
109 files changed, 547 insertions(+), 560 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
index ea72f91..1a2b8e8 100644
--- a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
+++ b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
@@ -50,7 +50,6 @@ Supported Platforms
- Tizen
- Windows 8
-
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
index e5467f5..148dbce 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
@@ -88,14 +88,14 @@ Full Example
watchID = null;
}
}
-
+
// onSuccess: Get a snapshot of the current acceleration
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
+ 'Acceleration Z: ' + acceleration.z + '<br />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index 8ff09a6..8f0b0f5 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -104,7 +104,7 @@ Full Example
<p>getCurrentAcceleration</p>
</body>
</html>
-
+
iPhone Quirks
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
index 25592fc..7f117d6 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -25,7 +25,7 @@ At a regular interval, get the acceleration along the _x_, _y_, and _z_ axis.
var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
accelerometerError,
[accelerometerOptions]);
-
+
Description
-----------
@@ -137,7 +137,7 @@ Full Example
<div id="accelerometer">Waiting for accelerometer...</div>
</body>
</html>
-
+
iPhone Quirks
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/camera/camera.cleanup.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.cleanup.md b/docs/en/edge/cordova/camera/camera.cleanup.md
index f1e5153..5d5e700 100644
--- a/docs/en/edge/cordova/camera/camera.cleanup.md
+++ b/docs/en/edge/cordova/camera/camera.cleanup.md
@@ -38,11 +38,10 @@ Supported Platforms
- iOS
-
Example
-------------
- navigator.camera.cleanup(onSuccess, onFail);
+ navigator.camera.cleanup(onSuccess, onFail);
function onSuccess() {
console.log("Camera cleanup success.")
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.getPicture.md b/docs/en/edge/cordova/camera/camera.getPicture.md
index 8f97851..8608caf 100644
--- a/docs/en/edge/cordova/camera/camera.getPicture.md
+++ b/docs/en/edge/cordova/camera/camera.getPicture.md
@@ -48,7 +48,7 @@ The return value is sent to the `cameraSuccess` callback function, in
one of the following formats, depending on the specified
`cameraOptions`:
-- A `String` containing the Base64-encoded photo image (default).
+- A `String` containing the base64-encoded photo image (default).
- A `String` representing the image file location on local storage.
You can do whatever you want with the encoded image or URI, for
@@ -84,7 +84,7 @@ can cause problems. Wrap the alert within a `setTimeout()` to allow
the iOS image picker or popover to fully close before the alert
displays:
- setTimeout(function() {
+ setTimeout(function() {
// do your thing here!
}, 0);
@@ -104,11 +104,11 @@ Tizen only supports a `destinationType` of
Quick Example
-------------
-Take a photo and retrieve it as a Base64-encoded image:
+Take a photo and retrieve it as a base64-encoded image:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
destinationType: Camera.DestinationType.DATA_URL
- });
+ });
function onSuccess(imageData) {
var image = document.getElementById('myImage');
@@ -119,10 +119,10 @@ Take a photo and retrieve it as a Base64-encoded image:
alert('Failed because: ' + message);
}
-Take a photo and retrieve the image's file location:
+Take a photo and retrieve the image's file location:
- navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: Camera.DestinationType.FILE_URI });
+ navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
+ destinationType: Camera.DestinationType.FILE_URI });
function onSuccess(imageURI) {
var image = document.getElementById('myImage');
@@ -133,7 +133,6 @@ Take a photo and retrieve the image's file location:
alert('Failed because: ' + message);
}
-
Full Example
------------
@@ -146,7 +145,7 @@ Full Example
<script type="text/javascript" charset="utf-8">
var pictureSource; // picture source
- var destinationType; // sets the format of returned value
+ var destinationType; // sets the format of returned value
// Wait for Cordova to connect with the device
//
@@ -162,7 +161,7 @@ Full Example
// Called when a photo is successfully retrieved
//
function onPhotoDataSuccess(imageData) {
- // Uncomment to view the base64 encoded image data
+ // Uncomment to view the base64-encoded image data
// console.log(imageData);
// Get image handle
@@ -182,7 +181,7 @@ Full Example
// Called when a photo is successfully retrieved
//
function onPhotoURISuccess(imageURI) {
- // Uncomment to view the image file URI
+ // Uncomment to view the image file URI
// console.log(imageURI);
// Get image handle
@@ -210,7 +209,7 @@ Full Example
// A button will call this function
//
function capturePhotoEdit() {
- // Take picture using device camera, allow edit, and retrieve image as base64-encoded string
+ // Take picture using device camera, allow edit, and retrieve image as base64-encoded string
navigator.camera.getPicture(onPhotoDataSuccess, onFail, { quality: 20, allowEdit: true,
destinationType: destinationType.DATA_URL });
}
@@ -219,13 +218,13 @@ Full Example
//
function getPhoto(source) {
// Retrieve image file location from specified source
- navigator.camera.getPicture(onPhotoURISuccess, onFail, { quality: 50,
+ navigator.camera.getPicture(onPhotoURISuccess, onFail, { quality: 50,
destinationType: destinationType.FILE_URI,
sourceType: source });
}
// Called if something bad happens.
- //
+ //
function onFail(message) {
alert('Failed because: ' + message);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
index 79b755b..25118c2 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
@@ -24,7 +24,7 @@ iOS-only parameters that specify the anchor element location and arrow
direction of the popover when selecting images from an iPad's library
or album.
- { x : 0,
+ { x : 0,
y : 32,
width : 320,
height : 480,
@@ -43,7 +43,7 @@ CameraPopoverOptions
- __height:__ height, in pixels, of the screen element onto which to anchor the popover. (`Number`)
- __arrowDir:__ Direction the arrow on the popover should point. Defined in `Camera.PopoverArrowDirection` (`Number`)
-
+
Camera.PopoverArrowDirection = {
ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants
ARROW_DOWN : 2,
@@ -51,7 +51,7 @@ CameraPopoverOptions
ARROW_RIGHT : 8,
ARROW_ANY : 15
};
-
+
Note that the size of the popover may change to adjust to the
direction of the arrow and orientation of the screen. Make sure to
account for orientation changes when specifying the anchor element
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraOptions.md b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
index 30f8832..0414446 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
@@ -40,7 +40,7 @@ Options
- __destinationType:__ Choose the format of the return value. Defined in `navigator.camera.DestinationType` (`Number`)
Camera.DestinationType = {
- DATA_URL : 0, // Return image as base64 encoded string
+ DATA_URL : 0, // Return image as base64-encoded string
FILE_URI : 1, // Return image file URI
NATIVE_URI : 2 // Return image native URI (e.g. assets-library:// on iOS or content:// on Android)
};
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.clearWatch.md b/docs/en/edge/cordova/compass/compass.clearWatch.md
index 120923c..839c0e0 100755
--- a/docs/en/edge/cordova/compass/compass.clearWatch.md
+++ b/docs/en/edge/cordova/compass/compass.clearWatch.md
@@ -45,7 +45,7 @@ Quick Example
// ... later on ...
navigator.compass.clearWatch(watchID);
-
+
Full Example
------------
@@ -102,7 +102,6 @@ Full Example
alert('Compass error: ' + compassError.code);
}
-
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
index 97f42bd..b1c08f5 100755
--- a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
+++ b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
@@ -98,4 +98,4 @@ Full Example
<p>getCurrentHeading</p>
</body>
</html>
-
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeading.md b/docs/en/edge/cordova/compass/compass.watchHeading.md
index b6d925e..0f7c0b2 100755
--- a/docs/en/edge/cordova/compass/compass.watchHeading.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeading.md
@@ -23,7 +23,7 @@ compass.watchHeading
At a regular interval, get the compass heading in degrees.
var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
-
+
Description
-----------
@@ -51,7 +51,6 @@ Supported Platforms
- Tizen
- Windows 8
-
Quick Example
-------------
@@ -132,7 +131,7 @@ Full Example
<button onclick="stopWatch();">Stop Watching</button>
</body>
</html>
-
+
iOS Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compassError/compassError.md b/docs/en/edge/cordova/compass/compassError/compassError.md
index ef594e6..c8850b7 100644
--- a/docs/en/edge/cordova/compass/compassError/compassError.md
+++ b/docs/en/edge/cordova/compass/compassError/compassError.md
@@ -29,7 +29,7 @@ Properties
Constants
---------
-- `CompassError.COMPASS_INTERNAL_ERR`
+- `CompassError.COMPASS_INTERNAL_ERR`
- `CompassError.COMPASS_NOT_SUPPORTED`
Description
@@ -37,4 +37,3 @@ Description
The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassError.md b/docs/en/edge/cordova/compass/parameters/compassError.md
index 1751d55..7a8fe49 100755
--- a/docs/en/edge/cordova/compass/parameters/compassError.md
+++ b/docs/en/edge/cordova/compass/parameters/compassError.md
@@ -20,7 +20,7 @@
compassError
==========
-onError callback function for compass functions.
+onError callback function for compass functions.
Example
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassSuccess.md b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
index 6822357..9f4daf0 100644
--- a/docs/en/edge/cordova/compass/parameters/compassSuccess.md
+++ b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
@@ -29,7 +29,6 @@ onSuccess callback function that provides the compass heading information via a
Parameters
----------
-
- __heading:__ The heading information. _(compassHeading)_
Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.type.md b/docs/en/edge/cordova/connection/connection.type.md
index c346890..89bffbe 100644
--- a/docs/en/edge/cordova/connection/connection.type.md
+++ b/docs/en/edge/cordova/connection/connection.type.md
@@ -73,7 +73,7 @@ Full Example
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
- //
+ //
document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is loaded and it is now safe to make calls Cordova methods
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/Contact/contact.md b/docs/en/edge/cordova/contacts/Contact/contact.md
index 34d96db..3f05775 100644
--- a/docs/en/edge/cordova/contacts/Contact/contact.md
+++ b/docs/en/edge/cordova/contacts/Contact/contact.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -28,7 +28,7 @@ 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 to address the contact by. _(DOMString)_
+- __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[])_
@@ -37,23 +37,27 @@ Properties
- __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 contacts user defined categories. _(ContactField[])_
-- __urls:__ An array of web pages associated to the contact. _(ContactField[])_
+- __categories:__ An array of all the contact's user-defined categories. _(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. An error callback is called with a `ContactError` object if the removal is unsuccessful.
+- __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
-------
-The `Contact` object represents a user contact. Contacts can be created, saved to, or removed from the device contacts database. Contacts can also be retrieved (individually or in bulk) from the database by invoking the `contacts.find` method.
+The `Contact` object represents a user contact. Contacts can be
+created, stored, or removed from the device contacts database.
+Contacts can also be retrieved (individually or in bulk) from the
+database by invoking the `contacts.find` method.
-_Note: Not all of the above contact fields are supported on every device platform. Please check each platform's Quirks section for information about which fields are supported._
+__NOTE:__ Not all of the contact fields listed above are supported on
+every device platform. Please check each platform's _Quirks_ section
+for details.
Supported Platforms
-------------------
@@ -97,7 +101,7 @@ Clone Quick Example
var clone = contact.clone();
clone.name.givenName = "John";
console.log("Original contact name = " + contact.name.givenName);
- console.log("Cloned contact name = " + clone.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
Remove Quick Example
--------------------
@@ -147,7 +151,7 @@ Full Example
var clone = contact.clone();
clone.name.givenName = "John";
console.log("Original contact name = " + contact.name.givenName);
- console.log("Cloned contact name = " + clone.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
// remove
contact.remove(onRemoveSuccess,onRemoveError);
@@ -188,51 +192,50 @@ Full Example
Android 2.X Quirks
------------------
-- __categories:__ This property is not support by Android 2.X devices, and will always be returned as `null`.
-
+- __categories:__ Not supported on Android 2.X devices, returning `null`.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
-- __id:__ Supported. Assigned by device when contact is saved.
+- __id:__ Supported. Assigned by the device when saving the contact.
- __displayName:__ Supported. Stored in BlackBerry __user1__ field.
-- __nickname:__ This property is not supported, and will always be returned as `null`.
-- __phoneNumbers:__ Partially supported. Phone numbers will be 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 will be stored in the BlackBerry __email1__, __email2__, and __email3__ fields, respectively.
-- __addresses:__ Partially supported. The first and second addresses will be stored in the BlackBerry __homeAddress__ and __workAddress__ fields, respectively.
-- __ims:__ This property is not supported, and will always be returned as `null`.
+- __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 will be 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.
+- __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:__ This property is not supported by iOS and will be returned as `null` unless there is no ContactName specified. If there is no ContactName, then composite name, __nickname__ or "" is returned for __displayName__, respectively.
-- __birthday:__ For input, this property must be provided as a JavaScript Date object. It is returned as a JavaScript Date object.
-- __photos:__ Returned Photo is stored in the application's temporary directory and a File URL to photo is returned. Contents of temporary folder is deleted when application exits.
-- __categories:__ This property is not currently supported and will always be returned as `null`.
+
+- __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, user inputs multiple web addresses in the url field and saves the contact. While pulling the information during the contact search url field do not show up multiple web addresses
-- __phoneNumbers:__ _pref_ is not supported, _type_ is not supported in a _find_ operation, only supports one phoneNumber of each _type_
-- __emails:__ _pref_ is not supported, home and personal points to same email entry, supports only one entry for each _type_
-- __addresses:__ supports only _type_ of work, home/personal, _type_ home and personal points to same address entry, supports only one entry for each _type_
-- __organizations:__ Multiple _organizations_ are not supported, does not support the attributes: _pref_, _type_, _department_
-- __note:__ This property is not supported, and will always be returned as `null`.
-- __ims:__ This property is not supported, and will always be returned as `null`.
-- __birthdays:__ This property is not supported, and will always be returned as `null`.
-- __categories:__ This property is not supported, and will always be returned as `null`.
-
+- __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`.
Bada Quirks
-----------
-- __displayName:__ This property is not supported
-- __birthday:__ This property is not supported
+- __displayName:__ Not supported.
+- __birthday:__ Not supported.
- __photos:__ This property should be a list with one URL to a photo
-- __categories:__ This property is not supported
-- __ims:__ This property is not supported
+- __categories:__ Not supported.
+- __ims:__ Not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
index 937e9de..8939fe5 100644
--- a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
+++ b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -25,7 +25,7 @@ Contains address properties for a `Contact` object.
Properties
----------
- __pref:__ Set to `true` if this `ContactAddress` contains the user's preferred value. _(boolean)_
-- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)
+- __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)_
@@ -36,7 +36,9 @@ Properties
Details
-------
-The `ContactAddress` object stores the properties of a single address of a contact. A `Contact` object can have one or more addresses in a `ContactAddress[]` array.
+The `ContactAddress` object stores the properties of a single address
+of a contact. A `Contact` object may include more than one address in
+a `ContactAddress[]` array.
Supported Platforms
-------------------
@@ -57,11 +59,11 @@ Quick Example
for (var j=0; j<contacts[i].addresses.length; j++) {
alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
"Type: " + contacts[i].addresses[j].type + "\n" +
- "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
- "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
- "Locality: " + contacts[i].addresses[j].locality + "\n" +
- "Region: " + contacts[i].addresses[j].region + "\n" +
- "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
+ "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
+ "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
+ "Locality: " + contacts[i].addresses[j].locality + "\n" +
+ "Region: " + contacts[i].addresses[j].region + "\n" +
+ "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
"Country: " + contacts[i].addresses[j].country);
}
}
@@ -73,7 +75,7 @@ Quick Example
// find all contacts
var options = new ContactFindOptions();
- options.filter="";
+ options.filter="";
var filter = ["displayName","addresses"];
navigator.contacts.find(filter, onSuccess, onError, options);
@@ -97,7 +99,7 @@ Full Example
function onDeviceReady() {
// find all contacts
var options = new ContactFindOptions();
- options.filter="";
+ options.filter="";
var filter = ["displayName","addresses"];
navigator.contacts.find(filter, onSuccess, onError, options);
}
@@ -110,11 +112,11 @@ Full Example
for (var j=0; j<contacts[i].addresses.length; j++) {
alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
"Type: " + contacts[i].addresses[j].type + "\n" +
- "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
- "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
- "Locality: " + contacts[i].addresses[j].locality + "\n" +
- "Region: " + contacts[i].addresses[j].region + "\n" +
- "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
+ "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
+ "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
+ "Locality: " + contacts[i].addresses[j].locality + "\n" +
+ "Region: " + contacts[i].addresses[j].region + "\n" +
+ "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
"Country: " + contacts[i].addresses[j].country);
}
}
@@ -137,14 +139,14 @@ Full Example
Android 2.X Quirks
------------------
-- __pref:__ This property is not supported by Android 2.X devices and will always return `false`.
+- __pref:__ Not supported, returning `false` on Android 2.X devices.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
-- __pref:__ This property is not supported on Blackberry devices and will always return `false`.
-- __type:__ Partially supported. Only one each of "Work" and "Home" type addresses can be stored per contact.
-- __formatted:__ Partially supported. Will return concatenation of all BlackBerry address fields.
-- __streetAddress:__ Supported. Will return concatenation of BlackBerry __address1__ and __address2__ address fields.
+- __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.
@@ -152,10 +154,10 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
iOS Quirks
----------
-- __pref:__ This property is not supported on iOS devices and will always return `false`.
-- __formatted:__ Not currently supported.
+- __pref:__ Not supported on iOS devices, returning `false`.
+- __formatted:__ Currently not supported.
Bada Quirks
-----------
-- __formatted:__ This property is not supported
-- __type:__ Has to be one of the following: WORK, HOME
+- __formatted:__ Not supported.
+- __type:__ Has to be either `WORK` or `HOME`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactError/contactError.md b/docs/en/edge/cordova/contacts/ContactError/contactError.md
index 45b5873..0e67b68 100644
--- a/docs/en/edge/cordova/contacts/ContactError/contactError.md
+++ b/docs/en/edge/cordova/contacts/ContactError/contactError.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
ContactError
========
-A `ContactError` object is returned to the `contactError` callback when an error occurs.
+A `ContactError` object is passed to the `contactError` callback when an error occurs.
Properties
----------
@@ -41,5 +41,6 @@ Constants
Description
-----------
-The `ContactError` object is returned to the user through the `contactError` callback function when an error occurs.
+The `ContactError` object is returned to the user through the
+`contactError` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactField/contactfield.md b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
index f85a704..727b184 100644
--- a/docs/en/edge/cordova/contacts/ContactField/contactfield.md
+++ b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,21 +20,35 @@ license: Licensed to the Apache Software Foundation (ASF) under one
ContactField
============
-Supports generic fields in a `Contact` object. Some properties that are stored as `ContactField` objects include email addresses, phone numbers, and urls.
+Supports generic fields in a `Contact` object. Some properties stored
+as `ContactField` objects include email addresses, phone numbers, and
+URLs.
Properties
----------
-- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)_
-- __value:__ The value of the field (such as a phone number or email address). _(DOMString)_
+- __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
-------
-The `ContactField` object is a reusable component that is used to support contact fields in a generic fashion. Each `ContactField` object contains a value property, a type property, and a pref property. A `Contact` object stores several properties in `ContactField[]` arrays, such as phone numbers and email addresses.
-
-In most instances, there are no pre-determined values for the __type__ attribute of a `ContactField` object. For example, a phone number can have __type__ values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular device platform. However, in the case of the `Contact` __photos__ field, Cordova makes use of the __type__ field to indicate the format of the returned image. Cordova will return __type: 'url'__ when the __value__ attribute contains a URL to the photo image, or __type: 'base64'__ when the returned __value__ attribute contains a Base64 encoded image string.
+The `ContactField` object is a reusable component that represents
+contact fields generically. Each `ContactField` object contains a
+`value`, `type`, and `pref` property. A `Contact` object stores
+several properties in `ContactField[]` arrays, such as phone numbers
+and email addresses.
+
+In most instances, there are no pre-determined values for a
+`ContactField` object's __type__ attribute. For example, a phone
+number can specify __type__ values of _home_, _work_, _mobile_,
+_iPhone_, or any other value that is supported by a particular device
+platform's contact database. However, for the `Contact` __photos__
+field, Cordova uses the __type__ field to indicate the format of the
+returned image. Cordova returns a __type__ of __url__ when the
+__value__ attribute contains a URL to the photo image, or _base64_
+when the __value__ contains a base64-encoded image string.
Supported Platforms
-------------------
@@ -106,8 +120,8 @@ Full Example
for (var i=0; i<contacts.length; i++) {
// display phone numbers
for (var j=0; j<contacts[i].phoneNumbers.length; j++) {
- alert("Type: " + contacts[i].phoneNumbers[j].type + "\n" +
- "Value: " + contacts[i].phoneNumbers[j].value + "\n" +
+ alert("Type: " + contacts[i].phoneNumbers[j].type + "\n" +
+ "Value: " + contacts[i].phoneNumbers[j].value + "\n" +
"Preferred: " + contacts[i].phoneNumbers[j].pref);
}
}
@@ -130,19 +144,20 @@ Full Example
Android Quirks
--------------
-- __pref:__ This property is not support by Android devices, and will always return `false`.
+- __pref:__ Not supported, returning `false`.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
- __type:__ Partially supported. Used for phone numbers.
- __value:__ Supported.
-- __pref:__ This property is not supported, and will always return `false`.
+- __pref:__ Not supported, returning `false`.
iOS Quirks
-----------
-- __pref:__ This property is not supported on iOS devices and will always return `false`.
+- __pref:__ Not supported, returning `false`.
Bada Quirks
-----------
-- __type:__ Property has to be one of the following for Email or Address fields: "WORK", "HOME". Property has to be one of the following for Phone fields: "WORK", "HOME", "VOICE", "FAX", "MSG", "CELL", "PAGER","BBS", "MODEM", "CAR", "ISDN","VIDEO", "PCS"
+
+- __type:__ For email or address fields, property must be _WORK_ or _HOME_. For phone fields, must be _WORK_, _HOME_, _VOICE_, _FAX_, _MSG_, _CELL_, _PAGER_, _BBS_, _MODEM_, _CAR_, _ISDN_,_VIDEO_, or _PCS_.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
index 4acf254..10ff14a 100644
--- a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -25,9 +25,8 @@ Contains properties that can be used to filter the results of a `contacts.find`
Properties
----------
-- __filter:__ The search string used to find contacts. _(DOMString)_ (Default: "")
-- __multiple:__ Determines if the find operation should return multiple contacts. _(Boolean)_ (Default: false)
-
+- __filter:__ The search string used to find contacts. _(DOMString)_ (Default: `""`)
+- __multiple:__ Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: false)
Supported Platforms
-------------------
@@ -115,4 +114,5 @@ Full Example
Bada Quirks
-----------
-__filter:__ Property can only apply to the following: "firstName", "lastName", "nickname", "phoneNumber", "email", "address"
+
+__filter:__ Property can only apply to the following: _firstName_, _lastName_, _nickname_, _phoneNumber_, _email_, and _address_.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactName/contactname.md b/docs/en/edge/cordova/contacts/ContactName/contactname.md
index 91915fb..9799472 100644
--- a/docs/en/edge/cordova/contacts/ContactName/contactname.md
+++ b/docs/en/edge/cordova/contacts/ContactName/contactname.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,22 +20,22 @@ license: Licensed to the Apache Software Foundation (ASF) under one
ContactName
===========
-Contains name properties of a `Contact` object.
+Contains different kinds of information about a `Contact` object's name.
Properties
----------
- __formatted:__ The complete name of the contact. _(DOMString)_
-- __familyName:__ The contacts family name. _(DOMString)_
-- __givenName:__ The contacts given name. _(DOMString)_
-- __middleName:__ The contacts middle name. _(DOMString)_
-- __honorificPrefix:__ The contacts prefix (example Mr. or Dr.) _(DOMString)_
-- __honorificSuffix:__ The contacts suffix (example Esq.). _(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
-------
-The `ContactName` object stores name properties of a contact.
+The `ContactName` object stores a contact's name properties.
Supported Platforms
-------------------
@@ -52,11 +52,11 @@ Quick Example
function onSuccess(contacts) {
for (var i=0; i<contacts.length; i++) {
- alert("Formatted: " + contacts[i].name.formatted + "\n" +
- "Family Name: " + contacts[i].name.familyName + "\n" +
- "Given Name: " + contacts[i].name.givenName + "\n" +
- "Middle Name: " + contacts[i].name.middleName + "\n" +
- "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
+ alert("Formatted: " + contacts[i].name.formatted + "\n" +
+ "Family Name: " + contacts[i].name.familyName + "\n" +
+ "Given Name: " + contacts[i].name.givenName + "\n" +
+ "Middle Name: " + contacts[i].name.middleName + "\n" +
+ "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
"Prefix: " + contacts[i].name.honorificSuffix);
}
};
@@ -98,11 +98,11 @@ Full Example
//
function onSuccess(contacts) {
for (var i=0; i<contacts.length; i++) {
- alert("Formatted: " + contacts[i].name.formatted + "\n" +
- "Family Name: " + contacts[i].name.familyName + "\n" +
- "Given Name: " + contacts[i].name.givenName + "\n" +
- "Middle Name: " + contacts[i].name.middleName + "\n" +
- "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
+ alert("Formatted: " + contacts[i].name.formatted + "\n" +
+ "Family Name: " + contacts[i].name.familyName + "\n" +
+ "Given Name: " + contacts[i].name.givenName + "\n" +
+ "Middle Name: " + contacts[i].name.middleName + "\n" +
+ "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
"Prefix: " + contacts[i].name.honorificPrefix);
}
};
@@ -123,25 +123,25 @@ Full Example
Android Quirks
------------
-- __formatted:__ Partially supported. Will return the concatenation of honorificPrefix, givenName, middleName, familyName and honorificSuffix but will not store.
+- __formatted:__ Partially supported, and read-only. Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
-- __formatted:__ Partially supported. Will return concatenation of BlackBerry __firstName__ and __lastName__ fields.
+- __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:__ This property is not supported, and will always return `null`.
-- __honorificPrefix:__ This property is not supported, and will always return `null`.
-- __honorificSuffix:__ This property is not supported, and will always return `null`.
+- __middleName:__ Not supported, returning `null`.
+- __honorificPrefix:__ Not supported, returning `null`.
+- __honorificSuffix:__ Not supported, returning `null`.
iOS Quirks
------------
-- __formatted:__ Partially supported. Will return iOS Composite Name but will not store.
+- __formatted:__ Partially supported. Returns iOS Composite Name, but is read-only.
Bada Quirks
-----------
-- __formatted:__ Property not supported
-- __middleName:__ Property not supported
-_ __honorificPrefix:__ Property not supported
-- __honorificSuffix:__ Property not supported
+- __formatted:__ Not supported
+- __middleName:__ Not supported
+_ __honorificPrefix:__ Not supported
+- __honorificSuffix:__ Not supported
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
index aef1248..7ddbf8e 100644
--- a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,20 +20,22 @@ license: Licensed to the Apache Software Foundation (ASF) under one
ContactOrganization
===================
-Contains organization properties of a `Contact` object.
+Contains a `Contact` object's organization properties.
Properties
----------
- __pref:__ Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_
-- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)
+- __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 contacts title at the organization. _(DOMString)_
+- __title:__ The contact's title at the organization. _(DOMString)_
Details
-------
-The `ContactOrganization` object stores a contact's organization properties. A `Contact` object stores one or more `ContactOrganization` objects in an array.
+The `ContactOrganization` object stores a contact's organization
+properties. A `Contact` object stores one or more
+`ContactOrganization` objects in an array.
Supported Platforms
-------------------
@@ -53,8 +55,8 @@ Quick Example
for (var j=0; j<contacts[i].organizations.length; j++) {
alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
"Type: " + contacts[i].organizations[j].type + "\n" +
- "Name: " + contacts[i].organizations[j].name + "\n" +
- "Department: " + contacts[i].organizations[j].department + "\n" +
+ "Name: " + contacts[i].organizations[j].name + "\n" +
+ "Department: " + contacts[i].organizations[j].department + "\n" +
"Title: " + contacts[i].organizations[j].title);
}
}
@@ -100,8 +102,8 @@ Full Example
for (var j=0; j<contacts[i].organizations.length; j++) {
alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
"Type: " + contacts[i].organizations[j].type + "\n" +
- "Name: " + contacts[i].organizations[j].name + "\n" +
- "Department: " + contacts[i].organizations[j].department + "\n" +
+ "Name: " + contacts[i].organizations[j].name + "\n" +
+ "Department: " + contacts[i].organizations[j].department + "\n" +
"Title: " + contacts[i].organizations[j].title);
}
}
@@ -125,24 +127,24 @@ Full Example
Android 2.X Quirks
------------------
-- __pref:__ This property is not supported by Android 2.X devices and will always return `false`.
+- __pref:__ Not supported by Android 2.X devices, returning `false`.
BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
-- __pref:__ This property is not supported by Blackberry devices and will always return `false`.
-- __type:__ This property is not supported by Blackberry devices and will always return `null`.
-- __name:__ Partially supported. The first organization name will be stored in the BlackBerry __company__ field.
-- __department:__ This property is not supported, and will always be returned as `null`.
-- __title:__ Partially supported. The first organization title will be stored in the BlackBerry __jobTitle__ field.
+- __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:__ This property is not supported on iOS devices and will always return `false`.
-- __type:__ This property is not supported on iOS devices and will always return `null`.
-- __name:__ Partially supported. The first organization name will be stored in the iOS __kABPersonOrganizationProperty__ field.
-- __department__: Partially supported. The first department name will be stored in the iOS __kABPersonDepartmentProperty__ field.
-- __title__: Partially supported. The first title will be stored in the iOS __kABPersonJobTitleProperty__ field.
+- __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.
Bada 2.0 Quirks
---------------
-- ContactOrganization not supported
+- `ContactOrganization` is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.create.md b/docs/en/edge/cordova/contacts/contacts.create.md
index 42e8cb3..f3548d3 100644
--- a/docs/en/edge/cordova/contacts/contacts.create.md
+++ b/docs/en/edge/cordova/contacts/contacts.create.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -27,9 +27,10 @@ Returns a new Contact object.
Description
-----------
-contacts.create is a synchronous function that returns a new `Contact` object.
+The `contacts.create` method is synchronous, and returns a new `Contact` object.
-This method does not persist the Contact object to the device contacts database. To persist the Contact object to the device, invoke the `Contact.save` method.
+This method does not retain the Contact object in the device contacts
+database, for which you need to invoke the `Contact.save` method.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.find.md b/docs/en/edge/cordova/contacts/contacts.find.md
index ad97108..592c621 100644
--- a/docs/en/edge/cordova/contacts/contacts.find.md
+++ b/docs/en/edge/cordova/contacts/contacts.find.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,25 +20,38 @@ license: Licensed to the Apache Software Foundation (ASF) under one
contacts.find
=============
-Queries the device contacts database and returns one or more `Contact` objects, each containing the fields specified.
+Queries the device contacts database and returns one or more `Contact`
+objects, each containing the fields specified.
navigator.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions);
Description
-----------
-contacts.find is an asynchronous function that queries the device contacts database and returns an array of `Contact` objects. The resulting objects are passed to the `contactSuccess` callback function specified by the __contactSuccess__ parameter.
+The `contacts.find` method executes asynchronously, querying the
+device contacts database and returning an array of `Contact` objects.
+The resulting objects are passed to the `contactSuccess` callback
+function specified by the __contactSuccess__ parameter.
-Users must specify the contact fields to be used as a search qualifier in the __contactFields__ parameter. Only the fields specified in the __contactFields__ parameter will be returned as properties of the `Contact` objects that are passed to the __contactSuccess__ callback function. A zero-length __contactFields__ parameter is invalid and will result in a `ContactError.INVALID_ARGUMENT_ERROR` . A __contactFields__ value of ["*"] will return all contact fields.
+The __contactFields__ parameter specifies the fields to be used as a
+search qualifier, and only those results are passed to the
+__contactSuccess__ callback function. A zero-length __contactFields__
+parameter is invalid and results in
+`ContactError.INVALID_ARGUMENT_ERROR`. A __contactFields__ value of
+`"*"` returns all contact fields.
-The __contactFindOptions.filter__ string can be used as a search filter when querying the contacts database. If provided, a case-insensitive, partial value match is applied to each field specified in the __contactFields__ parameter. If a match is found in a comparison with _any_ of the specified fields, the contact is returned.
+The __contactFindOptions.filter__ string can be used as a search
+filter when querying the contacts database. If provided, a
+case-insensitive, partial value match is applied to each field
+specified in the __contactFields__ parameter. If there's a match for
+_any_ of the specified fields, the contact is returned.
Parameters
----------
-- __contactFields:__ Contact fields to be used as search qualifier. Only these fields will have values in the resulting `Contact` objects. _(DOMString[])_ [Required]
-- __contactSuccess:__ Success callback function that is invoked with the contacts returned from the contacts database. [Required]
-- __contactError:__ Error callback function. Invoked when error occurs. [Optional]
+- __contactFields:__ Contact fields to use as a search qualifier. Only these fields will have values in the resulting `Contact` objects. _(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
@@ -65,7 +78,7 @@ Quick Example
// find all contacts with 'Bob' in any name field
var options = new ContactFindOptions();
options.filter="Bob";
- options.multiple=true;
+ options.multiple=true;
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
@@ -89,7 +102,7 @@ Full Example
function onDeviceReady() {
// find all contacts with 'Bob' in any name field
var options = new ContactFindOptions();
- options.filter="Bob";
+ options.filter="Bob";
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
}
@@ -115,5 +128,4 @@ Full Example
<p>Find Contacts</p>
</body>
</html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.md b/docs/en/edge/cordova/contacts/contacts.md
index 28e3e5e..3ed59e5 100644
--- a/docs/en/edge/cordova/contacts/contacts.md
+++ b/docs/en/edge/cordova/contacts/contacts.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/parameters/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactError.md b/docs/en/edge/cordova/contacts/parameters/contactError.md
index 6b50ddc..5c451b1 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactError.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactError.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -24,4 +24,4 @@ Error callback function for contact functions.
function(error) {
// Handle the error
- }
\ No newline at end of file
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactFields.md b/docs/en/edge/cordova/contacts/parameters/contactFields.md
index 66c9d3d..d3b5988 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactFields.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactFields.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,6 +20,6 @@ license: Licensed to the Apache Software Foundation (ASF) under one
contactFields
=============
-Required parameter of the `contacts.find` method. Use this parameter to specify which fields should be included in the `Contact` objects resulting from a find operation.
+Required parameter for the `contacts.find` method, used to specify which fields should be included in the `Contact` objects resulting from a find operation.
["name", "phoneNumbers", "emails"]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
index 2eb9afc..660615b 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,16 +20,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
contactFindOptions
==================
-Optional parameter of the `contacts.find` method. Use this parameter to filter the contacts returned from the contacts database.
+Optional parameter of the `contacts.find` method, used to filter the
+contacts returned from the contacts database.
- {
- filter: "",
- multiple: true,
- };
+ {
+ filter: "",
+ multiple: true,
+ };
Options
-------
-- __filter:__ The search string used to filter contacts. _(DOMString)_ (Default: "")
-- __multiple:__ Determines if the find operation should return multiple contacts. _(Boolean)_ (Default: false)
+- __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/6899777b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
index 9068218..a8cf4dc 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -35,6 +35,7 @@ Example
-------
function contactSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- console.log("Display Name = " + contacts[i].displayName;
- }
\ No newline at end of file
+ for (var i=0; i<contacts.length; i++) {
+ console.log("Display Name = " + contacts[i].displayName);
+ }
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.cordova.md b/docs/en/edge/cordova/device/device.cordova.md
index 451aeb3..c7891ff 100644
--- a/docs/en/edge/cordova/device/device.cordova.md
+++ b/docs/en/edge/cordova/device/device.cordova.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -23,7 +23,7 @@ device.cordova
Get the version of Cordova running on the device.
var string = device.cordova;
-
+
Description
-----------
@@ -65,10 +65,10 @@ Full Example
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device Cordova: ' + device.cordova + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
'Device Version: ' + device.version + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/device/device.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.md b/docs/en/edge/cordova/device/device.md
index 294cb42..3748d36 100644
--- a/docs/en/edge/cordova/device/device.md
+++ b/docs/en/edge/cordova/device/device.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/device/device.model.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.model.md b/docs/en/edge/cordova/device/device.model.md
index 7aaa5da..59a711b 100644
--- a/docs/en/edge/cordova/device/device.model.md
+++ b/docs/en/edge/cordova/device/device.model.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -23,11 +23,13 @@ device.model
Get the device's model name.
var string = device.model;
-
+
Description
-----------
-`device.model` returns the name of the device's model or product. This value is set by the device manufacturer and may be different across versions of the same product.
+The `device.model` returns the name of the device's model or
+product. The value is set by the device manufacturer and may be
+different across versions of the same product.
Supported Platforms
-------------------
@@ -71,11 +73,11 @@ Full Example
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device Cordova: ' + device.cordova + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
- 'Device Model: ' + device.model + '<br />' +
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
'Device Version: ' + device.version + '<br />';
}
@@ -86,23 +88,20 @@ Full Example
</body>
</html>
-
Android Quirks
--------------
-- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL).
- - The product name is often the code name given during production.
- - e.g. Nexus One returns "Passion", Motorola Droid returns "voles"
+- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL), which is often the production code name. For example, the Nexus One returns `Passion`, and Motorola Droid returns `voles`.
Windows Phone 7 and 8 Quirks
-------------
-- returns the manufacturer specified device model, for example, the Samsung Focus returns 'SGH-i917'
+- Returns the device model specified by the manufacturer. For example, the Samsung Focus returns `SGH-i917`.
Bada Quirks
-----------
-- returns the manufacturer model name. For example 'Samsung Wave S8500'
+- Returns the manufacturer model name, for example, `Samsung Wave S8500`
Tizen Quirks
-----------
-- returns the device model assigned by the vendor. For example 'TIZEN'
+- Returns the device model assigned by the vendor, for example, `TIZEN`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.name.md b/docs/en/edge/cordova/device/device.name.md
index 180c770..5391f8d 100644
--- a/docs/en/edge/cordova/device/device.name.md
+++ b/docs/en/edge/cordova/device/device.name.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -19,16 +19,19 @@ license: Licensed to the Apache Software Foundation (ASF) under one
device.name
===========
-WARNING: device.name is deprecated as of version 2.3.0, use device.model instead
+
+__WARNING:__ `device.name` is deprecated as of version 2.3.0. Use `device.model` instead.
Get the device's model name.
var string = device.name;
-
+
Description
-----------
-`device.name` returns the name of the device's model or product. This value is set by the device manufacturer and may be different across versions of the same product.
+`device.name` returns the name of the device's model or product. This
+value is set by the device manufacturer and may be different across
+versions of the same product.
Supported Platforms
-------------------
@@ -72,11 +75,11 @@ Full Example
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device Cordova: ' + device.cordova + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
- 'Device Model: ' + device.model + '<br />' +
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
'Device Version: ' + device.version + '<br />';
}
@@ -87,23 +90,20 @@ Full Example
</body>
</html>
-
Android Quirks
--------------
-- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL).
- - The product name is often the code name given during production.
- - e.g. Nexus One returns "Passion", Motorola Droid returns "voles"
+- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL), which is often the production code name. For example, the Nexus One returns `Passion`, and Motorola Droid returns `voles`.
Windows Phone 7 and 8 Quirks
-------------
-- returns the manufacturer specified device name, for example, the Samsung Focus returns 'SGH-i917'
+- Returns the device model specified by the manufacturer. For example, the Samsung Focus returns `SGH-i917`.
Bada Quirks
-----------
-- returns the manufacturer model name. For example 'Samsung Wave S8500'
+- Returns the manufacturer model name, for example, `Samsung Wave S8500`
Tizen Quirks
-----------
-- returns the device model assigned by the vendor. For example 'TIZEN'
+- Returns the device model assigned by the vendor, for example, `TIZEN`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6899777b/docs/en/edge/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.platform.md b/docs/en/edge/cordova/device/device.platform.md
index 410798e..a259587 100644
--- a/docs/en/edge/cordova/device/device.platform.md
+++ b/docs/en/edge/cordova/device/device.platform.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -68,10 +68,10 @@ Full Example
function onDeviceReady() {
var element = document.getElementById('deviceProperties');
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device Cordova: ' + device.cordova + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
'Device Version: ' + device.version + '<br />';
}
@@ -81,19 +81,20 @@ Full Example
<p id="deviceProperties">Loading device properties...</p>
</body>
</html>
-
+
BlackBerry Quirks
-----------------
-Devices may return the device platform version instead of the platform name. For example, the Storm2 9550 would return '2.13.0.95' or similar.
+Devices may return the device platform version number instead of the
+platform name. For example, the Storm2 9550 returns a value such as
+`2.13.0.95`.
Windows Phone 7 Quirks
-----------------
-Windows Phone 7 devices report platform as 'WinCE'
-
+Windows Phone 7 devices report the platform as `WinCE`.
Windows Phone 8 Quirks
-----------------
-Windows Phone 8 devices report platform as 'Win32NT'
+Windows Phone 8 devices report the platform as `Win32NT`.
[40/46] sanitize code & trim xtra Cordova refs
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToDate.md b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
index 3bdd068..a1b9350 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
@@ -25,7 +25,7 @@ preferences and calendar using the time zone of the client, and
returns the corresponding date object.
navigator.globalization.stringToDate(dateString, successCallback, errorCallback, options);
-
+
Description
-----------
@@ -72,12 +72,12 @@ that the month integer is one less than the string, as the month
integer represents an array index.
navigator.globalization.stringToDate(
- '9/25/2012',
- function (date) {alert('month:' + date.month +
- ' day:' + date.day +
- ' year:' + date.year + '\n');},
- function () {alert('Error getting date\n');},
- {selector:'date'}
+ '9/25/2012',
+ function (date) {alert('month:' + date.month +
+ ' day:' + date.day +
+ ' year:' + date.year + '\n');},
+ function () {alert('Error getting date\n');},
+ {selector: 'date'}
);
Full Example
@@ -86,10 +86,10 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>stringToDate Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkStringDate() {
navigator.globalization.stringToDate(
'9/25/2012',
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
index 429a6a5..738491e 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
@@ -24,7 +24,7 @@ Parses a number formatted as a string according to the client's user
preferences and returns the corresponding number.
navigator.globalization.stringToNumber(string, successCallback, errorCallback, options);
-
+
Description
-----------
@@ -59,10 +59,10 @@ When the browser is set to the `en\_US` locale, this should display a
popup dialog with text similar to `number: 1234.56`:
navigator.globalization.stringToNumber(
- '1234.56',
- function (number) {alert('number: ' + number.value + '\n');},
- function () {alert('Error getting number\n');},
- {type:'decimal'}
+ '1234.56',
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
);
Full Example
@@ -71,10 +71,10 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>stringToNumber Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkNumber() {
navigator.globalization.stringToNumber(
'1234.56',
@@ -83,7 +83,7 @@ Full Example
{type:'decimal'}
);
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/inappbrowser/inappbrowser.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/inappbrowser.md b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
index d85aa4a..3ea6f4c 100644
--- a/docs/en/edge/cordova/inappbrowser/inappbrowser.md
+++ b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
@@ -98,11 +98,11 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
var ref = window.open('http://apache.org', '_blank', 'location=yes');
@@ -162,7 +162,7 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
@@ -189,7 +189,7 @@ Full Example
iabRef.removeEventListener('exit', iabClose);
}
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
iabRef = window.open('http://apache.org', '_blank', 'location=yes');
@@ -239,11 +239,11 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
var ref = window.open('http://apache.org', '_blank', 'location=yes');
@@ -299,10 +299,10 @@ Full Example
<head>
<title>InAppBrowser.executeScript Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
@@ -324,7 +324,7 @@ Full Example
iabRef.removeEventListener('exit', iabClose);
}
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
iabRef = window.open('http://apache.org', '_blank', 'location=yes');
@@ -373,10 +373,10 @@ Full Example
<head>
<title>InAppBrowser.executeScript Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
@@ -398,7 +398,7 @@ Full Example
iabRef.removeEventListener('exit', iabClose);
}
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
iabRef = window.open('http://apache.org', '_blank', 'location=yes');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/inappbrowser/window.open.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/window.open.md b/docs/en/edge/cordova/inappbrowser/window.open.md
index eec3a42..d6d4a7c 100644
--- a/docs/en/edge/cordova/inappbrowser/window.open.md
+++ b/docs/en/edge/cordova/inappbrowser/window.open.md
@@ -24,7 +24,7 @@ Opens a URL in a new `InAppBrowser` instance, the current browser
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)_
@@ -32,9 +32,9 @@ instance, or the system browser.
- `_self`: Opens in the Cordova WebView if the URL is in the white list, otherwise it opens in the `InAppBrowser`.
- `_blank`: Opens in the `InAppBrowser`.
- `_system`: Opens in the system's web browser.
-
+
- __options__: Options for the `InAppBrowser`. Optional, defaulting to: `location=yes`. _(String)_
-
+
The `options` string must not contain any blank space, and each feature's name/value pairs must be separated by a comma. Feature names are case insensitive. All platforms support the value below:
- __location__: Set to `yes` or `no` to turn the `InAppBrowser`'s location bar on or off.
@@ -48,7 +48,7 @@ instance, or the system browser.
- __suppressesIncrementalRendering__: Set to `yes` or `no` to wait until all new view content is received before being rendered (defaults to `no`).
- __presentationstyle__: Set to `pagesheet`, `formsheet` or `fullscreen` to set the [presentation style](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle) (defaults to `fullscreen`).
- __transitionstyle__: Set to `fliphorizontal`, `crossdissolve` or `coververtical` to set the [transition style](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle) (defaults to `coververtical`).
-
+
Supported Platforms
-------------------
@@ -74,11 +74,11 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
// external url
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudio.md b/docs/en/edge/cordova/media/capture/captureAudio.md
index cfc318a..30ad560 100644
--- a/docs/en/edge/cordova/media/capture/captureAudio.md
+++ b/docs/en/edge/cordova/media/capture/captureAudio.md
@@ -23,8 +23,8 @@ capture.captureAudio
> Start the audio recorder application and return information about the captured audio clip file(s).
navigator.device.capture.captureAudio(
- CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
- );
+ CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
+ );
Description
-----------
@@ -93,13 +93,13 @@ Full Example
var i, len;
for (i = 0, len = mediaFiles.length; i < len; i += 1) {
uploadFile(mediaFiles[i]);
- }
+ }
}
// Called if something bad happens.
//
function captureError(error) {
- var msg = 'An error occurred during capture: ' + error.code;
+ var msg = 'An error occurred during capture: ' + error.code;
navigator.notification.alert(msg, null, 'Uh oh!');
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureImage.md b/docs/en/edge/cordova/media/capture/captureImage.md
index 3bbc124..dbd79ae 100644
--- a/docs/en/edge/cordova/media/capture/captureImage.md
+++ b/docs/en/edge/cordova/media/capture/captureImage.md
@@ -23,8 +23,8 @@ capture.captureImage
> Start the camera application and return information about captured image file(s).
navigator.device.capture.captureImage(
- CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
- );
+ CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
+ );
Description
-----------
@@ -99,13 +99,13 @@ Full Example
var i, len;
for (i = 0, len = mediaFiles.length; i < len; i += 1) {
uploadFile(mediaFiles[i]);
- }
+ }
}
// Called if something bad happens.
//
function captureError(error) {
- var msg = 'An error occurred during capture: ' + error.code;
+ var msg = 'An error occurred during capture: ' + error.code;
navigator.notification.alert(msg, null, 'Uh oh!');
}
@@ -161,7 +161,7 @@ the WebView without launching any camera app. Here's how:
var options = { destinationFilename: "images/cam01.jpg", highRes: false};
navigator.capture.captureImage(success, fail, options);
-
+
4. Dismiss the camera preview as follows:
navigator.camera.hidePreview("preview");
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureVideo.md b/docs/en/edge/cordova/media/capture/captureVideo.md
index cb9c591..6e80b3a 100644
--- a/docs/en/edge/cordova/media/capture/captureVideo.md
+++ b/docs/en/edge/cordova/media/capture/captureVideo.md
@@ -23,8 +23,8 @@ capture.captureVideo
> Start the video recorder application and return information about captured video clip file(s).
navigator.device.capture.captureVideo(
- CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureVideoOptions options]
- );
+ CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureVideoOptions options]
+ );
Description
-----------
@@ -94,13 +94,13 @@ Full Example
var i, len;
for (i = 0, len = mediaFiles.length; i < len; i += 1) {
uploadFile(mediaFiles[i]);
- }
+ }
}
// Called if something bad happens.
//
function captureError(error) {
- var msg = 'An error occurred during capture: ' + error.code;
+ var msg = 'An error occurred during capture: ' + error.code;
navigator.notification.alert(msg, null, 'Uh oh!');
}
@@ -160,7 +160,7 @@ the WebView without launching any camera app. Here's how:
3. Once the preview is available, use code such as this to start capturing a video:
navigator.capture.startVideoCapture(success, fail, {duration: 5000, destinationFilename: "videos/a.3gp"});
-
+
4. Use this to stop the video capture:
navigator.capture.stopVideoCapture();
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.getCurrentPosition.md b/docs/en/edge/cordova/media/media.getCurrentPosition.md
index 2284b5c..c9e8d28 100644
--- a/docs/en/edge/cordova/media/media.getCurrentPosition.md
+++ b/docs/en/edge/cordova/media/media.getCurrentPosition.md
@@ -50,26 +50,27 @@ Supported Platforms
Quick Example
-------------
- // Audio player
- //
- var my_media = new Media(src, onSuccess, onError);
-
- // Update media position every second
- var mediaTimer = setInterval(function() {
- // get media position
- my_media.getCurrentPosition(
- // success callback
- function(position) {
- if (position > -1) {
- console.log((position) + " sec");
- }
- },
- // error callback
- function(e) {
- console.log("Error getting pos=" + e);
+ // Audio player
+ //
+ var my_media = new Media(src, onSuccess, onError);
+
+ // Update media position every second
+ var mediaTimer = setInterval(function () {
+ // get media position
+ my_media.getCurrentPosition(
+ // success callback
+ function (position) {
+ if (position > -1) {
+ console.log((position) + " sec");
}
- );
- }, 1000);
+ },
+ // error callback
+ function (e) {
+ console.log("Error getting pos=" + e);
+ }
+ );
+ }, 1000);
+
Full Example
------------
@@ -79,34 +80,34 @@ Full Example
<html>
<head>
<title>Media Example</title>
-
+
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
+
+ // device APIs are available
//
function onDeviceReady() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
-
+
// Audio player
//
var my_media = null;
var mediaTimer = null;
-
+
// Play audio
//
function playAudio(src) {
// Create Media object from src
my_media = new Media(src, onSuccess, onError);
-
+
// Play audio
my_media.play();
-
+
// Update my_media position every second
if (mediaTimer == null) {
mediaTimer = setInterval(function() {
@@ -127,7 +128,7 @@ Full Example
}, 1000);
}
}
-
+
// Pause audio
//
function pauseAudio() {
@@ -135,7 +136,7 @@ Full Example
my_media.pause();
}
}
-
+
// Stop audio
//
function stopAudio() {
@@ -145,26 +146,26 @@ Full Example
clearInterval(mediaTimer);
mediaTimer = null;
}
-
+
// onSuccess Callback
//
function onSuccess() {
console.log("playAudio():Audio Success");
}
-
+
// onError Callback
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
-
+
// Set audio position
//
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/media.getDuration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.getDuration.md b/docs/en/edge/cordova/media/media.getDuration.md
index b7825dd..f48f9a0 100644
--- a/docs/en/edge/cordova/media/media.getDuration.md
+++ b/docs/en/edge/cordova/media/media.getDuration.md
@@ -44,23 +44,23 @@ Supported Platforms
Quick Example
-------------
- // Audio player
- //
- var my_media = new Media(src, onSuccess, onError);
-
- // Get duration
- var counter = 0;
- var timerDur = setInterval(function() {
- counter = counter + 100;
- if (counter > 2000) {
- clearInterval(timerDur);
- }
- var dur = my_media.getDuration();
- if (dur > 0) {
- clearInterval(timerDur);
- document.getElementById('audio_duration').innerHTML = (dur) + " sec";
- }
- }, 100);
+ // Audio player
+ //
+ var my_media = new Media(src, onSuccess, onError);
+
+ // Get duration
+ var counter = 0;
+ var timerDur = setInterval(function() {
+ counter = counter + 100;
+ if (counter > 2000) {
+ clearInterval(timerDur);
+ }
+ var dur = my_media.getDuration();
+ if (dur > 0) {
+ clearInterval(timerDur);
+ document.getElementById('audio_duration').innerHTML = (dur) + " sec";
+ }
+ }, 100);
Full Example
------------
@@ -70,34 +70,34 @@ Full Example
<html>
<head>
<title>Media Example</title>
-
+
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
+
+ // device APIs are available
//
function onDeviceReady() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
-
+
// Audio player
//
var my_media = null;
var mediaTimer = null;
-
+
// Play audio
//
function playAudio(src) {
// Create Media object from src
my_media = new Media(src, onSuccess, onError);
-
+
// Play audio
my_media.play();
-
+
// Update my_media position every second
if (mediaTimer == null) {
mediaTimer = setInterval(function() {
@@ -118,7 +118,7 @@ Full Example
}, 1000);
}
}
-
+
// Pause audio
//
function pauseAudio() {
@@ -126,7 +126,7 @@ Full Example
my_media.pause();
}
}
-
+
// Stop audio
//
function stopAudio() {
@@ -136,26 +136,26 @@ Full Example
clearInterval(mediaTimer);
mediaTimer = null;
}
-
+
// onSuccess Callback
//
function onSuccess() {
console.log("playAudio():Audio Success");
}
-
+
// onError Callback
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
-
+
// Set audio position
//
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/media.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.pause.md b/docs/en/edge/cordova/media/media.pause.md
index 116e3ea..bed8fa6 100644
--- a/docs/en/edge/cordova/media/media.pause.md
+++ b/docs/en/edge/cordova/media/media.pause.md
@@ -38,7 +38,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Tizen
- Windows 8
-
+
Quick Example
-------------
@@ -48,23 +48,21 @@ Quick Example
// Play the audio file at url
var my_media = new Media(url,
// success callback
- function() {
- console.log("playAudio():Audio Success");
- },
+ function () { console.log("playAudio():Audio Success"); },
// error callback
- function(err) {
- console.log("playAudio():Audio Error: "+err);
- });
+ function (err) { console.log("playAudio():Audio Error: " + err); }
+ );
// Play audio
my_media.play();
// Pause after 10 seconds
- setTimeout(function() {
+ setTimeout(function () {
media.pause();
}, 10000);
}
+
Full Example
------------
@@ -73,34 +71,34 @@ Full Example
<html>
<head>
<title>Media Example</title>
-
+
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
+
+ // device APIs are available
//
function onDeviceReady() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
-
+
// Audio player
//
var my_media = null;
var mediaTimer = null;
-
+
// Play audio
//
function playAudio(src) {
// Create Media object from src
my_media = new Media(src, onSuccess, onError);
-
+
// Play audio
my_media.play();
-
+
// Update my_media position every second
if (mediaTimer == null) {
mediaTimer = setInterval(function() {
@@ -121,7 +119,7 @@ Full Example
}, 1000);
}
}
-
+
// Pause audio
//
function pauseAudio() {
@@ -129,7 +127,7 @@ Full Example
my_media.pause();
}
}
-
+
// Stop audio
//
function stopAudio() {
@@ -139,26 +137,26 @@ Full Example
clearInterval(mediaTimer);
mediaTimer = null;
}
-
+
// onSuccess Callback
//
function onSuccess() {
console.log("playAudio():Audio Success");
}
-
+
// onError Callback
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
-
+
// Set audio position
//
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/media.play.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.play.md b/docs/en/edge/cordova/media/media.play.md
index c489704..19899db 100644
--- a/docs/en/edge/cordova/media/media.play.md
+++ b/docs/en/edge/cordova/media/media.play.md
@@ -49,14 +49,14 @@ Quick Example
// Play the audio file at url
var my_media = new Media(url,
// success callback
- function() {
+ function () {
console.log("playAudio():Audio Success");
},
// error callback
- function(err) {
- console.log("playAudio():Audio Error: "+err);
- });
-
+ function (err) {
+ console.log("playAudio():Audio Error: " + err);
+ }
+ );
// Play audio
my_media.play();
}
@@ -69,35 +69,35 @@ Full Example
<html>
<head>
<title>Media Example</title>
-
+
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
+
+ // device APIs are available
//
function onDeviceReady() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
-
+
// Audio player
//
var my_media = null;
var mediaTimer = null;
-
+
// Play audio
//
function playAudio(src) {
- if (my_media == null) {
- // Create Media object from src
- my_media = new Media(src, onSuccess, onError);
- } // else play current audio
+ if (my_media == null) {
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
+ } // else play current audio
// Play audio
my_media.play();
-
+
// Update my_media position every second
if (mediaTimer == null) {
mediaTimer = setInterval(function() {
@@ -118,7 +118,7 @@ Full Example
}, 1000);
}
}
-
+
// Pause audio
//
function pauseAudio() {
@@ -126,7 +126,7 @@ Full Example
my_media.pause();
}
}
-
+
// Stop audio
//
function stopAudio() {
@@ -136,26 +136,26 @@ Full Example
clearInterval(mediaTimer);
mediaTimer = null;
}
-
+
// onSuccess Callback
//
function onSuccess() {
console.log("playAudio():Audio Success");
}
-
+
// onError Callback
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
-
+
// Set audio position
//
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
-
+
</script>
</head>
<body>
@@ -180,7 +180,7 @@ iOS Quirks
- __numberOfLoops__: Pass this option to the `play` method to specify
the number of times you want the media file to play, e.g.:
-
+
var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
myMedia.play({ numberOfLoops: 2 })
@@ -188,7 +188,7 @@ iOS Quirks
method to specify whether you want to allow playback when the screen
is locked. If set to `true` (the default value), the state of the
hardware mute button is ignored, e.g.:
-
+
var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
myMedia.play({ playAudioWhenScreenIsLocked : false })
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/media.release.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.release.md b/docs/en/edge/cordova/media/media.release.md
index d7f933d..5ce1c4a 100644
--- a/docs/en/edge/cordova/media/media.release.md
+++ b/docs/en/edge/cordova/media/media.release.md
@@ -46,13 +46,13 @@ Supported Platforms
Quick Example
-------------
- // Audio player
- //
- var my_media = new Media(src, onSuccess, onError);
-
- my_media.play();
- my_media.stop();
- my_media.release();
+ // Audio player
+ //
+ var my_media = new Media(src, onSuccess, onError);
+
+ my_media.play();
+ my_media.stop();
+ my_media.release();
Full Example
------------
@@ -62,34 +62,34 @@ Full Example
<html>
<head>
<title>Media Example</title>
-
+
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
+
+ // device APIs are available
//
function onDeviceReady() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
-
+
// Audio player
//
var my_media = null;
var mediaTimer = null;
-
+
// Play audio
//
function playAudio(src) {
// Create Media object from src
my_media = new Media(src, onSuccess, onError);
-
+
// Play audio
my_media.play();
-
+
// Update my_media position every second
if (mediaTimer == null) {
mediaTimer = setInterval(function() {
@@ -110,7 +110,7 @@ Full Example
}, 1000);
}
}
-
+
// Pause audio
//
function pauseAudio() {
@@ -118,7 +118,7 @@ Full Example
my_media.pause();
}
}
-
+
// Stop audio
//
function stopAudio() {
@@ -128,26 +128,26 @@ Full Example
clearInterval(mediaTimer);
mediaTimer = null;
}
-
+
// onSuccess Callback
//
function onSuccess() {
console.log("playAudio():Audio Success");
}
-
+
// onError Callback
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
-
+
// Set audio position
//
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/media.seekTo.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.seekTo.md b/docs/en/edge/cordova/media/media.seekTo.md
index f1e47c0..371705c 100644
--- a/docs/en/edge/cordova/media/media.seekTo.md
+++ b/docs/en/edge/cordova/media/media.seekTo.md
@@ -49,72 +49,74 @@ Supported Platforms
Quick Example
-------------
- // Audio player
- //
- var my_media = new Media(src, onSuccess, onError);
- my_media.play();
- // SeekTo to 10 seconds after 5 seconds
- setTimeout(function() {
- my_media.seekTo(10000);
- }, 5000);
+ // Audio player
+ //
+ var my_media = new Media(src, onSuccess, onError);
+ my_media.play();
+ // SeekTo to 10 seconds after 5 seconds
+ setTimeout(function() {
+ my_media.seekTo(10000);
+ }, 5000);
Full Example
------------
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>Media Example</title>
-
+
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
+
+ // device APIs are available
//
function onDeviceReady() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
-
+
// Audio player
//
var my_media = null;
var mediaTimer = null;
-
+
// Play audio
//
function playAudio(src) {
// Create Media object from src
my_media = new Media(src, onSuccess, onError);
-
+
// Play audio
my_media.play();
+
// Update media position every second
- mediaTimer = setInterval(function() {
- // get media position
- my_media.getCurrentPosition(
- // success callback
- function(position) {
- if (position > -1) {
- setAudioPosition(position + " sec");
- }
- },
- // error callback
- function(e) {
- console.log("Error getting pos=" + e);
- }
- );
- }, 1000);
- // SeekTo to 10 seconds after 5 seconds
- setTimeout(function() {
- my_media.seekTo(10000);
- }, 5000);
- }
-
+ mediaTimer = setInterval(function() {
+ // get media position
+ my_media.getCurrentPosition(
+ // success callback
+ function(position) {
+ if (position > -1) {
+ setAudioPosition(position + " sec");
+ }
+ },
+ // error callback
+ function(e) {
+ console.log("Error getting pos=" + e);
+ }
+ );
+ }, 1000);
+
+ // SeekTo to 10 seconds after 5 seconds
+ setTimeout(function() {
+ my_media.seekTo(10000);
+ }, 5000);
+ }
+
// Stop audio
//
function stopAudio() {
@@ -124,26 +126,26 @@ Full Example
clearInterval(mediaTimer);
mediaTimer = null;
}
-
+
// onSuccess Callback
//
function onSuccess() {
console.log("playAudio():Audio Success");
}
-
+
// onError Callback
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
-
+
// Set audio position
//
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.startRecord.md b/docs/en/edge/cordova/media/media.startRecord.md
index e4e7d2d..b94cee9 100644
--- a/docs/en/edge/cordova/media/media.startRecord.md
+++ b/docs/en/edge/cordova/media/media.startRecord.md
@@ -38,7 +38,7 @@ Supported Platforms
- iOS
- Windows Phone 7 and 8
- Windows 8
-
+
Quick Example
-------------
@@ -51,7 +51,7 @@ Quick Example
function() {
console.log("recordAudio():Audio Success");
},
-
+
// error callback
function(err) {
console.log("recordAudio():Audio Error: "+ err.code);
@@ -72,7 +72,7 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
@@ -97,18 +97,18 @@ Full Example
}, 1000);
}
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
recordAudio();
}
-
+
// onSuccess Callback
//
function onSuccess() {
console.log("recordAudio():Audio Success");
}
-
+
// onError Callback
//
function onError(error) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/media.stop.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.stop.md b/docs/en/edge/cordova/media/media.stop.md
index 00b311b..77318d6 100644
--- a/docs/en/edge/cordova/media/media.stop.md
+++ b/docs/en/edge/cordova/media/media.stop.md
@@ -55,7 +55,8 @@ Quick Example
// error callback
function(err) {
console.log("playAudio():Audio Error: "+err);
- });
+ }
+ );
// Play audio
my_media.play();
@@ -74,34 +75,34 @@ Full Example
<html>
<head>
<title>Media Example</title>
-
+
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
+
+ // device APIs are available
//
function onDeviceReady() {
playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
}
-
+
// Audio player
//
var my_media = null;
var mediaTimer = null;
-
+
// Play audio
//
function playAudio(src) {
// Create Media object from src
my_media = new Media(src, onSuccess, onError);
-
+
// Play audio
my_media.play();
-
+
// Update my_media position every second
if (mediaTimer == null) {
mediaTimer = setInterval(function() {
@@ -122,7 +123,7 @@ Full Example
}, 1000);
}
}
-
+
// Pause audio
//
function pauseAudio() {
@@ -130,7 +131,7 @@ Full Example
my_media.pause();
}
}
-
+
// Stop audio
//
function stopAudio() {
@@ -140,26 +141,26 @@ Full Example
clearInterval(mediaTimer);
mediaTimer = null;
}
-
+
// onSuccess Callback
//
function onSuccess() {
console.log("playAudio():Audio Success");
}
-
+
// onError Callback
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
-
+
// Set audio position
//
function setAudioPosition(position) {
document.getElementById('audio_position').innerHTML = position;
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/media/media.stopRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/media.stopRecord.md b/docs/en/edge/cordova/media/media.stopRecord.md
index 0a97e6c..03fc246 100644
--- a/docs/en/edge/cordova/media/media.stopRecord.md
+++ b/docs/en/edge/cordova/media/media.stopRecord.md
@@ -38,7 +38,7 @@ Supported Platforms
- iOS
- Windows Phone 7 and 8
- Windows 8
-
+
Quick Example
-------------
@@ -51,11 +51,12 @@ Quick Example
function() {
console.log("recordAudio():Audio Success");
},
-
+
// error callback
function(err) {
console.log("recordAudio():Audio Error: "+ err.code);
- });
+ }
+ );
// Record audio
mediaRec.startRecord();
@@ -77,7 +78,7 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
@@ -102,18 +103,18 @@ Full Example
}, 1000);
}
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
recordAudio();
}
-
+
// onSuccess Callback
//
function onSuccess() {
console.log("recordAudio():Audio Success");
}
-
+
// onError Callback
//
function onError(error) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/notification/notification.alert.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.alert.md b/docs/en/edge/cordova/notification/notification.alert.md
index 4d972c6..d59d843 100644
--- a/docs/en/edge/cordova/notification/notification.alert.md
+++ b/docs/en/edge/cordova/notification/notification.alert.md
@@ -28,7 +28,7 @@ Shows a custom alert or dialog box.
- __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
-----------
@@ -63,7 +63,7 @@ Quick Example
'Game Over', // title
'Done' // buttonName
);
-
+
Full Example
------------
@@ -75,32 +75,32 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
// Empty
}
-
+
// alert dialog dismissed
- function alertDismissed() {
- // do something
- }
+ function alertDismissed() {
+ // do something
+ }
// Show a custom alertDismissed
//
function showAlert() {
- navigator.notification.alert(
- 'You are the winner!', // message
- alertDismissed, // callback
- 'Game Over', // title
- 'Done' // buttonName
- );
+ navigator.notification.alert(
+ 'You are the winner!', // message
+ alertDismissed, // callback
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.beep.md b/docs/en/edge/cordova/notification/notification.beep.md
index b550b2f..c1e9f4c 100644
--- a/docs/en/edge/cordova/notification/notification.beep.md
+++ b/docs/en/edge/cordova/notification/notification.beep.md
@@ -53,11 +53,11 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
// Empty
@@ -66,11 +66,11 @@ Full Example
// Show a custom alert
//
function showAlert() {
- navigator.notification.alert(
- 'You are the winner!', // message
- 'Game Over', // title
- 'Done' // buttonName
- );
+ navigator.notification.alert(
+ 'You are the winner!', // message
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
}
// Beep three times
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.confirm.md b/docs/en/edge/cordova/notification/notification.confirm.md
index f3a6193..73972ff 100755
--- a/docs/en/edge/cordova/notification/notification.confirm.md
+++ b/docs/en/edge/cordova/notification/notification.confirm.md
@@ -28,7 +28,7 @@ Displays a customizable confirmation dialog box.
- __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
-----------
@@ -74,7 +74,7 @@ Quick Example
'Restart,Exit' // buttonLabels
);
}
-
+
Full Example
------------
@@ -86,16 +86,16 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
// Empty
}
-
+
// process the confirmation dialog result
function onConfirm(buttonIndex) {
alert('You selected button ' + buttonIndex);
@@ -111,7 +111,7 @@ Full Example
'Restart,Exit' // buttonLabels
);
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.prompt.md b/docs/en/edge/cordova/notification/notification.prompt.md
index 8744b76..0d80029 100644
--- a/docs/en/edge/cordova/notification/notification.prompt.md
+++ b/docs/en/edge/cordova/notification/notification.prompt.md
@@ -81,11 +81,11 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
// Empty
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/notification/notification.vibrate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.vibrate.md b/docs/en/edge/cordova/notification/notification.vibrate.md
index 581dfd7..206fc4f 100644
--- a/docs/en/edge/cordova/notification/notification.vibrate.md
+++ b/docs/en/edge/cordova/notification/notification.vibrate.md
@@ -44,7 +44,7 @@ Quick Example
Full Example
------------
-
+
<!DOCTYPE html>
<html>
<head>
@@ -53,16 +53,16 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
// Empty
}
-
+
// Show a custom alert
//
function showAlert() {
@@ -72,13 +72,13 @@ Full Example
'Done' // buttonName
);
}
-
+
// Beep three times
//
function playBeep() {
navigator.notification.beep(3);
}
-
+
// Vibrate for 2 seconds
//
function vibrate() {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/splashscreen/splashscreen.hide.md b/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
index c4abcba..6680436 100644
--- a/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
+++ b/docs/en/edge/cordova/splashscreen/splashscreen.hide.md
@@ -51,16 +51,16 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- navigator.splashscreen.hide();
+ navigator.splashscreen.hide();
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/splashscreen/splashscreen.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/splashscreen/splashscreen.md b/docs/en/edge/cordova/splashscreen/splashscreen.md
index 2feaecc..2e36ac2 100644
--- a/docs/en/edge/cordova/splashscreen/splashscreen.md
+++ b/docs/en/edge/cordova/splashscreen/splashscreen.md
@@ -42,7 +42,7 @@ Permissions
#### config.xml
<plugin name="SplashScreen" value="CDVSplashScreen" />
-
+
Setup
-----
@@ -54,7 +54,7 @@ Setup
- large (hdpi): at least 640 × 480
- medium (mdpi): at least 470 × 320
- small (ldpi): at least 426 × 320
-
+
You should use a [9-patch image](https://developer.android.com/tools/help/draw9patch.html) for your splash screen.
2. In the `onCreate` method of the class that extends `DroidGap`, add the following two lines:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/splashscreen/splashscreen.show.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/splashscreen/splashscreen.show.md b/docs/en/edge/cordova/splashscreen/splashscreen.show.md
index 188d415..017fd96 100644
--- a/docs/en/edge/cordova/splashscreen/splashscreen.show.md
+++ b/docs/en/edge/cordova/splashscreen/splashscreen.show.md
@@ -51,16 +51,16 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- navigator.splashscreen.show();
+ navigator.splashscreen.show();
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/storage/database/database.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/database/database.md b/docs/en/edge/cordova/storage/database/database.md
index 9e1a279..ea676a7 100644
--- a/docs/en/edge/cordova/storage/database/database.md
+++ b/docs/en/edge/cordova/storage/database/database.md
@@ -44,29 +44,29 @@ Supported Platforms
Transaction Quick Example
------------------
- function populateDB(tx) {
- tx.executeSql('DROP TABLE IF EXISTS DEMO');
- tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
- tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
- tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
- }
-
- function errorCB(err) {
- alert("Error processing SQL: "+err.code);
- }
-
- function successCB() {
- alert("success!");
- }
-
- var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
- db.transaction(populateDB, errorCB, successCB);
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ function errorCB(err) {
+ alert("Error processing SQL: "+err.code);
+ }
+
+ function successCB() {
+ alert("success!");
+ }
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
Change Version Quick Example
-------------------
- var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
- db.changeVersion("1.0", "1.1");
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.changeVersion("1.0", "1.1");
Full Example
------------
@@ -79,38 +79,38 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
- db.transaction(populateDB, errorCB, successCB);
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
}
-
- // Populate the database
- //
- function populateDB(tx) {
- tx.executeSql('DROP TABLE IF EXISTS DEMO');
- tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
- tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
- tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
- }
-
- // Transaction error callback
- //
- function errorCB(tx, err) {
- alert("Error processing SQL: "+err);
- }
-
- // Transaction success callback
- //
- function successCB() {
- alert("success!");
- }
-
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(tx, err) {
+ alert("Error processing SQL: "+err);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ alert("success!");
+ }
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/storage/localstorage/localstorage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/localstorage/localstorage.md b/docs/en/edge/cordova/storage/localstorage/localstorage.md
index 7ca3978..1800293 100644
--- a/docs/en/edge/cordova/storage/localstorage/localstorage.md
+++ b/docs/en/edge/cordova/storage/localstorage/localstorage.md
@@ -64,18 +64,18 @@ Set Item Quick Example
Get Item Quick Example
-------------
- var value = window.localStorage.getItem("key");
- // value is now equal to "value"
+ var value = window.localStorage.getItem("key");
+ // value is now equal to "value"
Remove Item Quick Example
-------------
- window.localStorage.removeItem("key");
+ window.localStorage.removeItem("key");
Clear Quick Example
-------------
- window.localStorage.clear();
+ window.localStorage.clear();
Full Example
------------
@@ -88,24 +88,23 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- window.localStorage.setItem("key", "value");
- var keyname = window.localStorage.key(i);
- // keyname is now equal to "key"
- var value = window.localStorage.getItem("key");
- // value is now equal to "value"
- window.localStorage.removeItem("key");
- window.localStorage.setItem("key2", "value2");
- window.localStorage.clear();
- // localStorage is now empty
+ window.localStorage.setItem("key", "value");
+ var keyname = window.localStorage.key(i);
+ // keyname is now equal to "key"
+ var value = window.localStorage.getItem("key");
+ // value is now equal to "value"
+ window.localStorage.removeItem("key");
+ window.localStorage.setItem("key2", "value2");
+ window.localStorage.clear();
+ // localStorage is now empty
}
-
</script>
</head>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
index a1854d0..539fe96 100644
--- a/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
+++ b/docs/en/edge/cordova/storage/sqlresultset/sqlresultset.md
@@ -93,7 +93,7 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
@@ -138,7 +138,7 @@ Full Example
db.transaction(queryDB, errorCB);
}
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
index 8c35cb0..01365d6 100644
--- a/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
+++ b/docs/en/edge/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
@@ -66,13 +66,13 @@ Execute SQL Quick Example
console.log("Row = " + i + " ID = " + results.rows.item(i).id + " Data = " + results.rows.item(i).data);
}
}
-
- function errorCB(err) {
- alert("Error processing SQL: "+err.code);
- }
-
- var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
- db.transaction(queryDB, errorCB);
+
+ function errorCB(err) {
+ alert("Error processing SQL: "+err.code);
+ }
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
Full Example
------------
@@ -85,55 +85,55 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Populate the database
- //
- function populateDB(tx) {
- tx.executeSql('DROP TABLE IF EXISTS DEMO');
- tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
- tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
- tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
- }
-
- // Query the database
- //
- function queryDB(tx) {
- tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
- }
-
- // Query the success callback
- //
- function querySuccess(tx, results) {
- var len = results.rows.length;
- console.log("DEMO table: " + len + " rows found.");
- for (var i=0; i<len; i++){
- console.log("Row = " + i + " ID = " + results.rows.item(i).id + " Data = " + results.rows.item(i).data);
- }
- }
-
- // Transaction error callback
- //
- function errorCB(err) {
- console.log("Error processing SQL: "+err.code);
- }
-
- // Transaction success callback
- //
- function successCB() {
- var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
- db.transaction(queryDB, errorCB);
- }
-
- // Cordova is ready
- //
- function onDeviceReady() {
- var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
- db.transaction(populateDB, errorCB, successCB);
- }
-
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Query the database
+ //
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ // Query the success callback
+ //
+ function querySuccess(tx, results) {
+ var len = results.rows.length;
+ console.log("DEMO table: " + len + " rows found.");
+ for (var i=0; i<len; i++){
+ console.log("Row = " + i + " ID = " + results.rows.item(i).id + " Data = " + results.rows.item(i).data);
+ }
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(err) {
+ console.log("Error processing SQL: "+err.code);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
index 653c0ed..ed0fcf0 100644
--- a/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
+++ b/docs/en/edge/cordova/storage/sqltransaction/sqltransaction.md
@@ -45,23 +45,23 @@ Supported Platforms
Execute SQL Quick Example
------------------
- function populateDB(tx) {
- tx.executeSql('DROP TABLE IF EXISTS DEMO');
- tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
- tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
- tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
- }
-
- function errorCB(err) {
- alert("Error processing SQL: "+err);
- }
-
- function successCB() {
- alert("success!");
- }
-
- var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
- db.transaction(populateDB, errorCB, successCB);
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ function errorCB(err) {
+ alert("Error processing SQL: "+err);
+ }
+
+ function successCB() {
+ alert("success!");
+ }
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
Full Example
------------
@@ -74,38 +74,38 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
- db.transaction(populateDB, errorCB, successCB);
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
}
-
- // Populate the database
- //
- function populateDB(tx) {
- tx.executeSql('DROP TABLE IF EXISTS DEMO');
- tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
- tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
- tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
- }
-
- // Transaction error callback
- //
- function errorCB(err) {
- alert("Error processing SQL: "+err);
- }
-
- // Transaction success callback
- //
- function successCB() {
- alert("success!");
- }
-
+
+ // Transaction error callback
+ //
+ function errorCB(err) {
+ alert("Error processing SQL: "+err);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ alert("success!");
+ }
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/storage/storage.opendatabase.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/storage.opendatabase.md b/docs/en/edge/cordova/storage/storage.opendatabase.md
index 173bfec..76d0cec 100644
--- a/docs/en/edge/cordova/storage/storage.opendatabase.md
+++ b/docs/en/edge/cordova/storage/storage.opendatabase.md
@@ -55,16 +55,16 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- var db = window.openDatabase("test", "1.0", "Test DB", 1000000);
+ var db = window.openDatabase("test", "1.0", "Test DB", 1000000);
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/guide/command-line/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/command-line/index.md b/docs/en/edge/guide/command-line/index.md
index 3675408..46295f1 100644
--- a/docs/en/edge/guide/command-line/index.md
+++ b/docs/en/edge/guide/command-line/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/guide/cordova-webview/android.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/android.md b/docs/en/edge/guide/cordova-webview/android.md
index dd94819..72c4834 100644
--- a/docs/en/edge/guide/cordova-webview/android.md
+++ b/docs/en/edge/guide/cordova-webview/android.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -83,16 +83,16 @@ Guide to using CordovaWebView in an Android Project
public void startActivityForResult(CordovaPlugin command, Intent intent, int requestCode) {
this.activityResultCallback = command;
this.activityResultKeepRunning = this.keepRunning;
-
+
// If multitasking turned on, then disable it for activities that return results
if (command != null) {
this.keepRunning = false;
}
-
+
// Start activity
super.startActivityForResult(intent, requestCode);
}
-
+
@Override
/**
* Called when an activity you launched exits, giving you the requestCode you started it with,
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/guide/cordova-webview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/index.md b/docs/en/edge/guide/cordova-webview/index.md
index f7b58ba..d3e2e72 100644
--- a/docs/en/edge/guide/cordova-webview/index.md
+++ b/docs/en/edge/guide/cordova-webview/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/guide/cordova-webview/ios.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/ios.md b/docs/en/edge/guide/cordova-webview/ios.md
index cd945ab..a606aeb 100644
--- a/docs/en/edge/guide/cordova-webview/ios.md
+++ b/docs/en/edge/guide/cordova-webview/ios.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -77,9 +77,9 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
22. Search for **Header Search Paths**. For that setting, add these three values below (with quotes):
"$(TARGET_BUILD_DIR)/usr/local/lib/include"
-
+
"$(OBJROOT)/UninstalledProducts/include"
-
+
"$(BUILT_PRODUCTS_DIR)"
With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit → Refactor → Convert to Objective-C ARC...**, **de-select libCordova.a**, then run the wizard to completion.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/android/index.md b/docs/en/edge/guide/getting-started/android/index.md
index d652ab4..4370b2f 100644
--- a/docs/en/edge/guide/getting-started/android/index.md
+++ b/docs/en/edge/guide/getting-started/android/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/guide/getting-started/bada/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/bada/index.md b/docs/en/edge/guide/getting-started/bada/index.md
index 44bf15f..2cac9ce 100644
--- a/docs/en/edge/guide/getting-started/bada/index.md
+++ b/docs/en/edge/guide/getting-started/bada/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/guide/getting-started/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/blackberry/index.md b/docs/en/edge/guide/getting-started/blackberry/index.md
index 401b0ac..e720174 100644
--- a/docs/en/edge/guide/getting-started/blackberry/index.md
+++ b/docs/en/edge/guide/getting-started/blackberry/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/guide/getting-started/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/index.md b/docs/en/edge/guide/getting-started/index.md
index e8906f7..d937608 100644
--- a/docs/en/edge/guide/getting-started/index.md
+++ b/docs/en/edge/guide/getting-started/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/ios/index.md b/docs/en/edge/guide/getting-started/ios/index.md
index 1fa7d6b..bcba9ca 100644
--- a/docs/en/edge/guide/getting-started/ios/index.md
+++ b/docs/en/edge/guide/getting-started/ios/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -256,7 +256,7 @@ references the deprecated invokeString API:
<script type="text/javascript" src="cordova-2.2.0.js"></script>
<script type="text/javascript" src="js/index.js"></script>
<script type="text/javascript">
- app.initialize();
+ app.initialize();
</script>
**Wait for deviceReady Event**
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/guide/getting-started/tizen/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/tizen/index.md b/docs/en/edge/guide/getting-started/tizen/index.md
index 0f9b268..9da55e8 100644
--- a/docs/en/edge/guide/getting-started/tizen/index.md
+++ b/docs/en/edge/guide/getting-started/tizen/index.md
@@ -82,7 +82,7 @@ This guide describes how to set up your development environment for Cordova and
- A widget package should be generated in your project root directory (e.g: `cordova-basic.wgt`)
- - __NOTE:__ The provided samples Tizen Cordova projects are not basic hello world applications. They contain a simple example usage of the Battery Cordova API.
+ - __NOTE:__ The sample Tizen Cordova projects provided go beyond basic "hello world" applications, and feature example usage of the Battery API.
5A. Deploy to Simulator
-----------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/guide/plugin-development/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/android/index.md b/docs/en/edge/guide/plugin-development/android/index.md
index 01ab080..2f372e7 100644
--- a/docs/en/edge/guide/plugin-development/android/index.md
+++ b/docs/en/edge/guide/plugin-development/android/index.md
@@ -155,7 +155,7 @@ application:
}
}
-Let's take a look at the code. The necessary Cordova `imports` are at
+Let's take a look at the code. The necessary `imports` are at
the top. Our class extends from `CordovaPlugin`. We override the
execute() method in order to recieve messages from exec(). Our method
first compares against `action`: this plugin only supports one action,
[36/46] docs commit: feedback from 1st round of queries
Posted by mw...@apache.org.
feedback from 1st round of queries
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/5f4e3d98
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/5f4e3d98
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/5f4e3d98
Branch: refs/heads/master
Commit: 5f4e3d982e2fb617e1696103ad2f5df9ac8f6f14
Parents: efd1aa0
Author: Mike Sierra <le...@gmail.com>
Authored: Mon May 20 11:24:24 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon May 20 11:24:24 2013 -0400
----------------------------------------------------------------------
docs/en/edge/cordova/camera/camera.cleanup.md | 6 +++---
docs/en/edge/cordova/camera/parameter/cameraOptions.md | 4 ++--
docs/en/edge/cordova/compass/compass.getCurrentHeading.md | 4 ++--
docs/en/edge/cordova/compass/parameters/compassHeading.md | 2 +-
4 files changed, 8 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f4e3d98/docs/en/edge/cordova/camera/camera.cleanup.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.cleanup.md b/docs/en/edge/cordova/camera/camera.cleanup.md
index 883cd12..e56440a 100644
--- a/docs/en/edge/cordova/camera/camera.cleanup.md
+++ b/docs/en/edge/cordova/camera/camera.cleanup.md
@@ -20,15 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
camera.cleanup
=================
-Cleans up the photos taken by the camera and made available in a
-temporary storage location.
+Removes intermediate photos taken by the camera from temporary
+storage.
navigator.camera.cleanup( cameraSuccess, cameraError );
Description
-----------
-Cleans up the image files stored in the temporary storage location
+Removes intermediate image files that are kept in temporary storage
after calling `camera.getPicture`. Applies only when the value of
`Camera.sourceType` equals `Camera.PictureSourceType.CAMERA` and the
`Camera.destinationType` equals `Camera.DestinationType.FILE_URI`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f4e3d98/docs/en/edge/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraOptions.md b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
index 4e70f9f..6aff0b0 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
@@ -35,9 +35,9 @@ Optional parameters to customize the camera settings.
Options
-------
-- __quality__: Quality of saved image. Range is [0, 100]. _(Number)_
+- __quality__: Quality of the saved image, expressed as a range of 0-100, where 100 is typically full resolution with no loss from file compression. _(Number)_ (Note that information about the camera's resolution is unavailable.)
-- __destinationType__: Choose the format of the return value. Defined in `navigator.camera.DestinationType` _(Number)_
+- __destinationType__: Choose the format of the return value. Defined in `navigator.camera.DestinationType` _(Number)_
Camera.DestinationType = {
DATA_URL : 0, // Return image as base64-encoded string
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f4e3d98/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
index c8af90a..2e98fb2 100755
--- a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
+++ b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
@@ -28,8 +28,8 @@ Description
-----------
The compass is a sensor that detects the direction or heading that the
-device is pointed. It measures the heading in degrees from 0 to
-359.99.
+device is pointed, typically from the top of the device. It measures
+the heading in degrees from 0 to 359.99, where 0 is north.
The compass heading information is returned via a `CompassHeading`
object using the `compassSuccess` callback function.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f4e3d98/docs/en/edge/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassHeading.md b/docs/en/edge/cordova/compass/parameters/compassHeading.md
index 25bdf9d..d44ded8 100644
--- a/docs/en/edge/cordova/compass/parameters/compassHeading.md
+++ b/docs/en/edge/cordova/compass/parameters/compassHeading.md
@@ -43,4 +43,4 @@ iOS Quirks
----------
- `trueHeading` is only returned when location services are enabled via `navigator.geolocation.watchLocation()`
-- For iOS > 4 devices, heading factors in the device's current orientation, not in reference to its absolute position, for apps that supports that orientation.
+- 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.
[32/46] docs commit: amidst notification
Posted by mw...@apache.org.
amidst notification
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/6e779685
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/6e779685
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/6e779685
Branch: refs/heads/master
Commit: 6e7796852f69048e71c79a810ab35147c362473c
Parents: 45f896a
Author: Mike Sierra <le...@gmail.com>
Authored: Fri May 17 16:38:56 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Fri May 17 16:38:56 2013 -0400
----------------------------------------------------------------------
.../cordova/notification/notification.alert.md | 21 +++++++++++-------
.../cordova/notification/notification.beep.md | 23 ++++++++++----------
2 files changed, 25 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6e779685/docs/en/edge/cordova/notification/notification.alert.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.alert.md b/docs/en/edge/cordova/notification/notification.alert.md
index 0957677..dbfafb5 100644
--- a/docs/en/edge/cordova/notification/notification.alert.md
+++ b/docs/en/edge/cordova/notification/notification.alert.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -24,15 +24,17 @@ Shows a custom alert or dialog box.
navigator.notification.alert(message, alertCallback, [title], [buttonName])
-- __message__: Dialog message _(String)_
+- __message__: Dialog message. _(String)_
- __alertCallback__: Callback to invoke when alert dialog is dismissed. _(Function)_
-- __title__: Dialog title _(String)_ (Optional, Default: "Alert")
-- __buttonName__: Button name _(String)_ (Optional, Default: "OK")
+- __title__: Dialog title. _(String)_ (Optional, defaults to `Alert`)
+- __buttonName__: Button name. _(String)_ (Optional, defaults to `OK`)
Description
-----------
-Most Cordova implementations use a native dialog box for this feature. However, some platforms simply use the browser's `alert` function, which is typically less customizable.
+Most Cordova implementations use a native dialog box for this feature,
+but some platforms use the browser's `alert` function, which is
+typically less customizable.
Supported Platforms
-------------------
@@ -109,9 +111,12 @@ Full Example
Windows Phone 7 and 8 Quirks
-------------
-- There is no built in browser alert, so if you want to just write alert('foo'); you can assign window.alert = navigator.notification.alert;
-- alert + confirm calls are non-blocking, and result is only available asynchronously.
+- There is no built-in browser alert, so if you want to just write `alert('foo')`; you can assign:
+
+ window.alert = navigator.notification.alert;
+
+- `alert` and `confirm` calls are non-blocking, and the result is only available asynchronously.
Bada 2.x Quirks
---------------
-- alert uses javascript alert
+- Uses JavaScript's `alert`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6e779685/docs/en/edge/cordova/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.beep.md b/docs/en/edge/cordova/notification/notification.beep.md
index 7eed928..803aa22 100644
--- a/docs/en/edge/cordova/notification/notification.beep.md
+++ b/docs/en/edge/cordova/notification/notification.beep.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,11 +20,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one
notification.beep
=================
-The device will play a beep sound.
+The device plays a beep sound.
navigator.notification.beep(times);
-- __times__: The number of times to repeat the beep _(Number)_
+- __times__: The number of times to repeat the beep. _(Number)_
Supported Platforms
-------------------
@@ -97,24 +97,25 @@ Full Example
Android Quirks
--------------
-- Android plays the default "Notification ringtone" specified under the "Settings/Sound & Display" panel.
+- Android plays the default __Notification ringtone__ specified under the __Settings/Sound & Display__ panel.
iPhone Quirks
-------------
- Ignores the beep count argument.
-- There is no native beep API for iPhone.
- - Cordova implements beep by playing an audio file via the media API.
- - The user must provide a file with the desired beep tone.
- - This file must be less than 30 seconds long, located in the www/ root, and must be named `beep.wav`.
+- The iPhone does not feature a native beep API.
+ - Cordova implements beeps by playing an audio file via the media API.
+ - The app must provide a file with the desired beep tone.
+ - This file must be less than 30 seconds long, located in the `www` root directory, and must be named `beep.wav`.
Windows Phone 7 and 8 Quirks
-------------
-- Cordova lib includes a generic beep file that is used.
+- Relies on a generic beep file from the Cordova distribution.
Tizen Quirks
-------------
- - Tizen implements beep by playing an audio file via the media API.
- - This beep file must be short, named `beep.wav` and has to be located in a 'sounds' sub-directory of the application root directory.
+- 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`.
+
[06/46] docs commit: many copy edits; nonlinear search/destroy edits;
needs a more controlled pass
Posted by mw...@apache.org.
many copy edits; nonlinear search/destroy edits; needs a more controlled pass
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/726c9630
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/726c9630
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/726c9630
Branch: refs/heads/master
Commit: 726c9630c3665e6a608e240c1a5ca35bc268379e
Parents: d33b887
Author: Mike Sierra <le...@gmail.com>
Authored: Mon Apr 29 11:19:25 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon Apr 29 11:19:25 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/command-line/index.md | 41 ++---
docs/en/edge/guide/cordova-webview/android.md | 54 +++---
docs/en/edge/guide/cordova-webview/index.md | 4 +-
docs/en/edge/guide/cordova-webview/ios.md | 34 ++--
.../edge/guide/getting-started/android/index.md | 52 +++---
.../en/edge/guide/getting-started/bada/index.md | 32 ++--
.../guide/getting-started/blackberry/index.md | 30 ++--
docs/en/edge/guide/getting-started/index.md | 4 +-
docs/en/edge/guide/getting-started/ios/index.md | 166 ++++++++++---------
.../edge/guide/getting-started/symbian/index.md | 12 +-
.../edge/guide/getting-started/tizen/index.md | 4 +-
.../edge/guide/getting-started/webos/index.md | 13 +-
.../guide/getting-started/windows-8/index.md | 26 +--
.../getting-started/windows-phone-7/index.md | 54 +++---
.../getting-started/windows-phone-8/index.md | 78 +++++----
.../guide/plugin-development/android/index.md | 72 ++++----
.../edge/guide/plugin-development/bada/index.md | 14 +-
.../plugin-development/blackberry/index.md | 113 +++++++------
docs/en/edge/guide/plugin-development/index.md | 50 +++---
.../edge/guide/plugin-development/ios/index.md | 85 +++++++---
.../plugin-development/windows-phone/index.md | 35 ++--
.../edge/guide/project-settings/bada/index.md | 2 +-
.../guide/project-settings/blackberry/index.md | 8 +-
.../guide/project-settings/firefoxos/index.md | 2 +-
docs/en/edge/guide/project-settings/index.md | 19 ++-
.../en/edge/guide/project-settings/ios/index.md | 2 +-
.../edge/guide/project-settings/webos/index.md | 4 +-
.../guide/project-settings/windows8/index.md | 2 +-
.../en/edge/guide/project-settings/wp7/index.md | 4 +-
docs/en/edge/guide/upgrading/bada/index.md | 11 +-
docs/en/edge/guide/upgrading/ios/index.md | 72 ++++----
docs/en/edge/guide/upgrading/webos/index.md | 6 +-
docs/en/edge/guide/whitelist/index.md | 35 ++--
33 files changed, 631 insertions(+), 509 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/command-line/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/command-line/index.md b/docs/en/edge/guide/command-line/index.md
index b235cf2..29ee41d 100644
--- a/docs/en/edge/guide/command-line/index.md
+++ b/docs/en/edge/guide/command-line/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -37,7 +37,7 @@ Cordova projects.
## Windows Phone 8
-The Windows Phone 8 command line tools support creating new projects.
+The Windows Phone 8 command-line tools support creating new projects.
### Create a project
@@ -123,8 +123,9 @@ or, on **Windows**
$ /path/to/my_new_cordova_project/cordova/run.bat
-Make sure you have created at least one Android Virtual Device. If you did not it will ask you to create one with the `android` command.
-If you have multiple AVDs, it will prompt you to select an AVD.
+Make sure you create at least one Android Virtual Device, otherwise
+you're prompted to do so with the `android` command. If you have
+multiple AVDs, you're prompted to select one.
### Logging
@@ -171,18 +172,20 @@ or, on **Windows**
$ /path/to/cordova-blackberry-webworks/bin/create.bat /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
-Note: the package name placeholder (com.example.cordova_project_name) is ignored on the Blackberry platform, but is required for use of the crossplatform tools
+__NOTE:__ The Blackberry platform ignores the package name placeholder
+(`com.example.cordova_project_name`), but it's still required for use by
+cross-platform tools.
### Build a project
For BlackBerry projects, please make sure you customize the
-`project.properties` file in the root of your Cordova project folder.
-This is necessary for things like supplying your BlackBerry signing key
-password, location of the BlackBerry WebWorks SDK, and location of
-BlackBerry simulator executables.
+`project.properties` file in your Cordova project's root directory.
+You need to do so to supply your BlackBerry signing key password, and
+specify locations for the BlackBerry WebWorks SDK and BlackBerry
+simulator executables.
$ /path/to/my_new_cordova_project/cordova/build <platform>
-
+
or, on **Windows**
$ /path/to/my_new_cordova_project/cordova/build.bat <platform>
@@ -191,24 +194,24 @@ or, on **Windows**
For BlackBerry projects, please make sure you customize the
`project.properties` file in the root of your Cordova project folder.
-This is necessary for things like supplying your BlackBerry signing key
-password, location of the BlackBerry WebWorks SDK, and location of
-BlackBerry simulator executables.
+You need to do so to supply your BlackBerry signing key password, and
+specify locations for the BlackBerry WebWorks SDK and BlackBerry
+simulator executables.
$ /path/to/my_new_cordova_project/cordova/run <platform>
-
-and then choose 'no' when prompted with:
+
+and then choose 'no' when prompted with:
Do you have a BlackBerry device connected to your computer? (y/n)
-
+
or, on **Windows**
$ /path/to/my_new_cordova_project/cordova/run <platform>
-and then choose 'no' when prompted with:
+and then choose 'no' when prompted with:
Do you have a BlackBerry device connected to your computer? (y/n)
-
+
### Logging
Unfortunately streaming logs directly from the device is not
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/cordova-webview/android.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/android.md b/docs/en/edge/guide/cordova-webview/android.md
index 6dfeafe..dd94819 100644
--- a/docs/en/edge/guide/cordova-webview/android.md
+++ b/docs/en/edge/guide/cordova-webview/android.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -20,13 +20,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Embedding Cordova WebView on Android
====================================
-Beginning in Cordova 1.9, with the assistance of the `CordovaActivity`, you can use Cordova as a component in a larger native Android application. This component is known in Android
-as the `CordovaWebView`. New Cordova-based applications from 1.9 onwards will be using the `CordovaWebView` as its main view, whether the legacy `DroidGap` approach is
-used or not.
+Beginning in Cordova 1.9, with the assistance of the
+`CordovaActivity`, you can use Cordova as a component in a larger
+native Android application. Android refers to this component as the
+`CordovaWebView`. New Cordova-based applications from 1.9 onwards use
+the `CordovaWebView` as its main view, regardless of whether the
+legacy `DroidGap` approach is used.
-The prerequisites are the same as the prerequisites for Android application development. It is assumed that you are familiar with Android development. If not, please
-look at the Getting Started guide to developing a Cordova Application and start there before continuing with this approach. This is not the main approach used
-to author Android Cordova applications. Thus the instructions are currently manual. In the future, we may try to further automate project generation via this method.
+If you're unfamiliar with Android application development, please read
+the Getting Started guide to developing a Cordova Application before
+attempting to include a WebView. It's not the main way to author
+Android Cordova applications. These instructions are currently manual,
+but may be eventually be automated.
Prerequisites
-------------
@@ -37,19 +42,17 @@ Prerequisites
Guide to using CordovaWebView in an Android Project
---------------------------------------------------
-1. Use `bin/create` to fetch the commons-codec-1.6.jar
-2. `cd` into `/framework` and run `ant jar` to build the cordova jar (it
- will create the .jar file in the form `cordova-x.x.x.jar` in the
- `/framework` folder)
-3. Copy the cordova jar into your Android project's `/libs` directory
-4. Edit your application's `main.xml` file (under `/res/xml`) to look similar the following. The `layout_height`, `layout_width` and `id` can be modified to suit your application
+1. Use `bin/create` to fetch the `commons-codec-1.6.jar` file.
+2. `cd` into `/framework` and run `ant jar` to build the cordova jar. It creates the .jar file formed as `cordova-x.x.x.jar` in the `/framework` folder.
+3. Copy the cordova jar into your Android project's `/libs` directory.
+4. Edit your application's `main.xml` file (under `/res/xml`) to look like the following, with the `layout_height`, `layout_width` and `id` modified to suit your application:
<org.apache.cordova.CordovaWebView
android:id="@+id/tutorialView"
android:layout_width="match_parent"
android:layout_height="match_parent" />
-5. Modify your activity so that it implements the `CordovaInterface`. It is recommended that you implement the methods that are included. You may wish to copy the methods from `/framework/src/org/apache/cordova/DroidGap.java`, or you may wish to implement your own methods. Below is a fragment of code from a basic application that uses the interface (note how the view id referenced matches the `id` attribute specified in the above XML fragment from step 4):
+5. Modify your activity so that it implements the `CordovaInterface`. You should implement the included methods. You may wish to copy them from `/framework/src/org/apache/cordova/DroidGap.java`, or implement them on your own. The code fragment below shows a basic application that uses the interface. Note how the referenced view id matches the `id` attribute specified in the XML fragment shown above:
public class CordovaViewTestActivity extends Activity implements CordovaInterface {
CordovaWebView cwv;
@@ -63,15 +66,15 @@ Guide to using CordovaWebView in an Android Project
cwv.loadUrl(Config.getStartUrl());
}
-In addition to this, if you are using camera, you will want to implement this as well:
+ If you use the camera, you should also implement this:
@Override
public void setActivityResultCallback(CordovaPlugin plugin) {
- this.activityResultCallback = plugin;
+ this.activityResultCallback = plugin;
}
/**
- * Launch an activity for which you would like a result when it finished. When this activity exits,
- * your onActivityResult() method will be called.
+ * Launch an activity for which you would like a result when it finished. When this activity exits,
+ * your onActivityResult() method is called.
*
* @param command The command object
* @param intent The intent to start
@@ -80,16 +83,16 @@ In addition to this, if you are using camera, you will want to implement this as
public void startActivityForResult(CordovaPlugin command, Intent intent, int requestCode) {
this.activityResultCallback = command;
this.activityResultKeepRunning = this.keepRunning;
-
+
// If multitasking turned on, then disable it for activities that return results
if (command != null) {
this.keepRunning = false;
}
-
+
// Start activity
super.startActivityForResult(intent, requestCode);
}
-
+
@Override
/**
* Called when an activity you launched exits, giving you the requestCode you started it with,
@@ -108,13 +111,12 @@ In addition to this, if you are using camera, you will want to implement this as
}
}
-Finally, remember to add the thread pool, otherwise the plugins will have no threads to run on.
-
+ Finally, remember to add the thread pool, otherwise the plugins have no threads to run on:
@Override
public ExecutorService getThreadPool() {
return threadPool;
}
-6. Copy your application's HTML and JavaScript used to the `/assets/www` directory of your Android project
-7. Copy `cordova.xml` and `plugins.xml` from `/framework/res/xml` to the `/res/xml` folder in your project
+6. Copy your application's HTML and JavaScript files to your Android project's `/assets/www` directory.
+7. Copy `cordova.xml` and `plugins.xml` from `/framework/res/xml` to your project's `/res/xml` folder.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/cordova-webview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/index.md b/docs/en/edge/guide/cordova-webview/index.md
index d3e2e72..f7b58ba 100644
--- a/docs/en/edge/guide/cordova-webview/index.md
+++ b/docs/en/edge/guide/cordova-webview/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/cordova-webview/ios.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cordova-webview/ios.md b/docs/en/edge/guide/cordova-webview/ios.md
index 5d9ba71..a4ca2d5 100644
--- a/docs/en/edge/guide/cordova-webview/ios.md
+++ b/docs/en/edge/guide/cordova-webview/ios.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -20,11 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Embedding Cordova WebView on iOS
================================
-Beginning with Cordova 1.4, you can use Cordova as a component in your iOS applications. This component is code-named "Cleaver".
+Beginning with Cordova 1.4, you can use Cordova as a component in your
+iOS applications. This component is code-named "Cleaver".
-New Cordova-based applications created using the Xcode template provided in Cordova 1.4 or greater use Cleaver, and this template is considered the reference implementation for Cleaver.
+New Cordova-based applications created using the Xcode template
+provided in Cordova 1.4 or greater use Cleaver. (The template is
+Cleaver's reference implementation.)
-Beginning with Cordova 2.0.0 and greater, we only support the sub-project based Cleaver implementation from now on.
+Cordova 2.0.0 and subsequent versions only support the sub-project
+based Cleaver implementation.
Prerequisites
-------------
@@ -37,7 +41,7 @@ Prerequisites
Adding Cleaver to your Xcode project (CordovaLib sub-project)
-------------------------------------------------------------
-1. **Download and extract the Cordova source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova)
+1. **Download and extract the Cordova source** to a **permanent folder location** on your hard drive (say to `~/Documents/Cordova`)
2. **Quit Xcode** if it is running.
3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
4. **Copy** the `config.xml` file into your project folder on disk (see **Prerequisites** above)
@@ -45,12 +49,12 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
6. **Choose** the radio-button **"Create groups for any added folders"**, select the **Finish** button
7. **Drag and drop** the `CordovaLib.xcodeproj` file into the Project Navigator of Xcode (from the permanent folder location above, and it should be in the CordovaLib sub-folder)
8. Select `CordovaLib.xcodeproj` in the Project Navigator
-9. Press the key combination **Option-Command-1** to show the **File Inspector**
-10. Choose **"Relative to Group"** in the **File Inspector** for the drop-down menu for **Location**
+9. Type the **Option-Command-1** key combination to show the **File Inspector**
+10. Choose **"Relative to Group"** in the **File Inspector** for the drop-down menu for **Location**
11. Select the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Settings"** tab
12. Add `-all_load` and `-Obj-C` - for the **"Other Linker Flags"** value
13. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **"Build Phases"** tab
-14. Expand **"Link Binaries with Libraries"**
+14. Expand **"Link Binaries with Libraries"**
15. Select the **"+" button**, and add these **frameworks** (and optionally in the Project Navigator, **move** them under the Frameworks group):
AddressBook.framework
@@ -74,13 +78,13 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project)
22. Search for **"Header Search Paths"**. For that setting, add these three values below (with quotes):
"$(TARGET_BUILD_DIR)/usr/local/lib/include"
-
+
"$(OBJROOT)/UninstalledProducts/include"
-
+
"$(BUILT_PRODUCTS_DIR)"
- With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit -> Refactor -> Convert to Objective-C ARC…**, **de-select libCordova.a**, then run the wizard to completion.
-
+ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit -> Refactor -> Convert to Objective-C ARC…**, **de-select libCordova.a**, then run the wizard to completion.
+
Using CDVViewController in your code
------------------------------------
@@ -88,7 +92,7 @@ Using CDVViewController in your code
#import <Cordova/CDVViewController.h>
-2. Instantiate a **new** `CDVViewController`, and **retain it somewhere** (e.g. to a property in your class):
+2. Instantiate a **new** `CDVViewController`, and **retain it somewhere** (e.g. to a property in your class):
CDVViewController* viewController = [CDVViewController new];
@@ -127,7 +131,7 @@ Adding your HTML, CSS and JavaScript assets
/*
if you created a folder called 'myfolder' and
- you want the file 'mypage.html' in it to be
+ you want the file 'mypage.html' in it to be
the startPage
*/
viewController.wwwFolderName = @"myfolder";
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/android/index.md b/docs/en/edge/guide/getting-started/android/index.md
index ab34d8e..7298c48 100644
--- a/docs/en/edge/guide/getting-started/android/index.md
+++ b/docs/en/edge/guide/getting-started/android/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -34,36 +34,38 @@ This guide describes how to set up your development environment for Cordova and
- Android 3.x (Deprecated May 2013)
- Android 4.x
-We currently do not support Android 1.x, and we plan to deprecate platforms in the future as they are updated and dip below 5% on the [distribution dashboard](http://developer.android.com/about/dashboards/index.html) provided by Google.
+Android 1.x is currently not supported. In general, superseded
+platforms are deprecated as they dip below 5% on Google's
+[distribution dashboard](http://developer.android.com/about/dashboards/index.html).
2. Install SDK + Cordova
------------------------
- Download and install [Android SDK](http://developer.android.com/sdk/index.html)
-- Download the latest copy of [Cordova](http://cordova.apache.org/#download) and extract its contents. We will be working with the Android directory.
+- Download and extract the latest copy of [Cordova](http://cordova.apache.org/#download). You will be working in the `android` directory.
-3A. Setup your PATH environment variable on Mac OS
+
+3A. Set up your PATH environment variable on Mac OS
---------------------------------------
-- Open the Terminal program (this is in your Applications/Utilites folder by default).
-- Run the following command
+- Open the Terminal program, by default in your `Applications/Utilities` folder.
+- Run the following command to open the file with your default text editor:
`touch ~/.bash_profile; open ~/.bash_profile`
-- This will open the file in the your default text editor.
-- You need to add the path to your Android SDK platform-tools and tools directory. In my example I will use "/Development/android-sdk-macosx" as the directory the SDK is installed in. Add the following line:
+- You need to add the path to your Android SDK platform-tools and tools directory. This example uses "/Development/android-sdk-macosx" as the SDK's install directory. Add the following line:
-`export PATH=${PATH}:/Development/android-sdk-macosx/platform-tools:/Development/android-sdk-macosx/tools`
+`export PATH=${PATH}:/Development/android-sdk-macosx/platform-tools:/Development/android-sdk-macosx/tools`
- Save the file and quit the text editor.
-- Execute your .bash_profile to update your PATH.
+- Execute your .bash_profile to update your PATH.
`source ~/.bash_profile`
-- Now everytime you open the Terminal program you PATH will included the Android SDK.
+- Your PATH now includes the Android SDK, available each time open the Terminal program.
-3B. Setup your PATH environment variable on Windows
+3B. Set up your PATH environment variable on Windows
---------------------------------------
- From the Desktop, right-click My Computer and click Properties.
@@ -71,28 +73,28 @@ We currently do not support Android 1.x, and we plan to deprecate platforms in t
- In the System Properties window click the Environment Variables button.
- Select the PATH variable from the System variables section.
- Select the Edit button.
-- You need to add the path to your Android SDK platform-tools and tools directory. In my example I will use "C:\Development\android-sdk-windows" as the directory the SDK is installed in. Append the following text into the text box:
+- You need to add the path to your Android SDK platform-tools and tools directory. This example uses `C:\Development\android-sdk-windows` as the SDK's install directory. Append the following into the text box:
`;C:\Development\android-sdk-windows\platform-tools;C:\Development\android-sdk-windows\tools`
-- Save your edit. Close the Environment Variables dialog.
-- Additionally, you may need to include `%JAVA_HOME%\bin` to your PATH as well. To check to see if this is required, run a command prompt and type `java`. If the program can not be found add `%JAVA_HOME%\bin` to the PATH. You may need to specify the full path instead of using the `%JAVA_HOME%` environment variable.
-- Finally, you may need to include `%ANT_HOME%\bin` to your PATH as well. To check to see if this is required, run a command prompt and type `ant`. If the program can not be found add `%ANT_HOME%\bin` to the PATH. You may need to specify the full path instead of using the `%ANT_HOME%` environment variable.
+- Save your edit and close the Environment Variables dialog.
+- You may also need to include `%JAVA_HOME%\bin` to your PATH. To check if this is required, open a command prompt and type `java`. Add `%JAVA_HOME%\bin` to the PATH if the program can't be found. You may need to specify the full path instead of the `%JAVA_HOME%` environment variable.
+- Finally, you may also need to include `%ANT_HOME%\bin` to your PATH. To check if this is required, open a command prompt and type `ant`. Add `%ANT_HOME%\bin` to the PATH if the program can't be found. You may need to specify the full path instead of the `%ANT_HOME%` environment variable.
-4. Setup New Project
+4. Set up New Project
--------------------
-- In a terminal window, navigate to the `bin` directory within the `android` subfolder of the Cordova distribution.
-- Type in `./create <project_folder_path> <package_name> <project_name>` then press **"Enter"**
+- In a terminal window, navigate to the Cordova distribution `android/bin` directory.
+- Type `./create <project_folder_path> <package_name> <project_name>`, then press **Enter**
<project_folder_path> is the path to your new Cordova Android project
<package_name> is the package name, e.g. com.YourCompany.YourAppName
<project_name> is the project name, e.g. YourApp (Must not contain spaces and dashes)
-
+
- If you're getting an 'An unexpected error occurred" error, try the command again prefixed with `sudo`
-- Launch Eclipse, and select menu item **New Project**
+- Launch Eclipse, and select menu item **New Project**:
- Select the directory you used for `<project_folder_path>`
- Click Finish.
@@ -110,11 +112,11 @@ If your project has a red X indicating there is a problem follow these additiona
----------------------
- Right click the project and go to **Run As > Android Application**
-- Eclipse will ask you to select an appropriate AVD. If there isn't one, then you'll need to create it.
+- Eclipse asks you to select an appropriate AVD. If there isn't one, then you'll need to create it.
-**Note: For a faster experience, use an Intel-based emulator image:**
+__NOTE:__ For a faster experience, use an Intel-based emulator image.
-- Open the Android SDK Manager
+- Open the Android SDK Manager:
- Install one or more `Intel x86 Atom` System Images as well as the `Intel Hardware Accelerated Execution Manager` (under Extras).
- Run the Intel installer, which has been downloaded to: `extras/intel/Hardware_Accelerated_Execution_Manager` within your Android SDK
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/bada/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/bada/index.md b/docs/en/edge/guide/getting-started/bada/index.md
index d02291d..0a4934d 100644
--- a/docs/en/edge/guide/getting-started/bada/index.md
+++ b/docs/en/edge/guide/getting-started/bada/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -31,44 +31,44 @@ This guide describes how to set up your development environment for Cordova and
2. Install SDK + Cordova
-------------------------
-- Download and install the [Bada SDK](http://developer.bada.com) (Windows only).
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the bada directory.
+- Download and install the [Bada SDK](http://developer.bada.com) (Windows only).
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `bada` directory.
-3. Setup New Project
+3. Set up New Project
--------------------
-- In Bada IDE, select _File_ -> Import project -> Bada C++ / Flash Project.
- - Note: Bada 1.2 select "Bada Application Project"
-
+- In Bada IDE, select _File_ -> Import project -> Bada C++ / Flash Project.
+ - __NOTE:__ Bada 1.2 select "Bada Application Project"
+
-- Make sure "Select root directory is checked" and then click Browse
+- Make sure "Select root directory" is checked and then click Browse
- Browse to Cordova bada project folder (bada for 1.2 and bada-wac for 2.x) and select it. Make sure "Copy projects into workspace is checked"
-
+
- Click "Finish"
-
+
4. Hello World
--------------
-**Bada 2.x**: Your HTML/CSS/Javascript code lives under the Res/ folder. Make sure your index.html contains the following two lines in the <head> section.
+**Bada 2.x**: Your HTML/CSS/JavaScript code lives under the Res/ folder. Make sure your index.html contains the following two lines in the <head> section.
<link href="osp://webapp/css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="osp://webapp/js/webapp_core.js"></script>
-**Bada 1.2**: Your HTML/CSS/Javascript code lives under the Res/ folder. Make sure your index.html contains the following line.
+**Bada 1.2**: Your HTML/CSS/JavaScript code lives under the Res/ folder. Make sure your index.html contains the following line.
<script type="text/javascript" src="cordova/cordova.js"> </script>
5A. Deploy to Simulator
-----------------------
-- **Bada 2.x**: Right click on your project s folder and select Run As -> bada Emulator Web Application
-
+- **Bada 2.x**: Right click on your project s folder and select Run As -> bada Emulator Web Application
+
- **Bada 1.2**: Right click on your project' folder and select Build configurations -> Set Active -> Simulator-Debug
@@ -80,7 +80,7 @@ This guide describes how to set up your development environment for Cordova and
5B. Deploy to Device
--------------------
-- Make sure your device is properly configured
+- Make sure your device is properly configured
**Bada 2.x**: Right click on your project's folder and select Run As -> bada Target Web Application
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/blackberry/index.md b/docs/en/edge/guide/getting-started/blackberry/index.md
index 5d61bce..57840b6 100644
--- a/docs/en/edge/guide/getting-started/blackberry/index.md
+++ b/docs/en/edge/guide/getting-started/blackberry/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Getting Started with BlackBerry
============================
-Cordova for BlackBerry makes use of the [BlackBerry WebWorks framework](https://bdsc.webapps.blackberry.com/html5). BlackBerry WebWorks tooling is available for Windows or Mac environments.
+Cordova for BlackBerry makes use of the [BlackBerry WebWorks framework](https://bdsc.webapps.blackberry.com/html5). BlackBerry WebWorks tooling is available for Windows or Mac environments.
WebWorks applications can ONLY be deployed to the following BlackBerry platforms:
@@ -52,7 +52,7 @@ Download and install the appropriate WebWorks SDKs for your development. BlackBe
3. Register for Signing Keys
-------------------------
-If you wish to publish your application on BlackBerry App World, or deploy on an actual device you’ll need to register for a set of free Code Signing Keys.
+If you wish to publish your application on BlackBerry App World, or deploy on an actual device you’ll need to register for a set of free Code Signing Keys.
To register for Signing Keys visit, and complete the [BlackBerry Keys Order Form](https://www.blackberry.com/SignedKeys).
@@ -62,10 +62,10 @@ Once you receive your Signing Keys, they'll need to be setup. To learn how to se
4. Install Cordova
-------------------------
-Download the latest copy of [Cordova](http://cordova.apache.org/#download) and extract its contents to your local machine.
+Download and extract the latest copy of [Cordova](http://cordova.apache.org/#download).
-5. Setup New Project
+5. Set up New Project
--------------------
- Open up a command prompt/terminal and navigate to where you extracted Cordova.
@@ -110,21 +110,21 @@ For instructions on installing simulators, please visit the following link(s):
- [BlackBerry Smartphone](https://developer.blackberry.com/html5/documentation/run_your_app_on_smartphone_sim_1876976_11.html)
- Open the project.properties file with your favorite editor and customize the following properties.
-
+
BlackBerry 10
- `qnx.sim.ip`
- `qnx.sim.password`
-- Note: IP address of simulator obtained when placing the simulator in developer mode through simulator security settings. Simulator password can be set through simulator security settings.
+- __NOTE:__ IP address of simulator obtained when placing the simulator in developer mode through simulator security settings. Simulator password can be set through simulator security settings.
Playbook
-- `playbook.sim.ip` :
+- `playbook.sim.ip` :
- `playbook.sim.password`
-- Note: IP address of simulator obtained when placing the simulator in developer mode through simulator security settings. Simulator password can be set through simulator security settings.
+- __NOTE:__ IP address of simulator obtained when placing the simulator in developer mode through simulator security settings. Simulator password can be set through simulator security settings.
Smartphone (Optional)
-- `blackberry.sim.dir`
+- `blackberry.sim.dir`
- `blackberry.sim.bin`
-- Note: On windows file separator '\' must be escaped when specifying directories. For example `C:\\Program Files\\BlackBerry\\Simulator`.
+- __NOTE:__ On windows file separator '\' must be escaped when specifying directories. For example `C:\\Program Files\\BlackBerry\\Simulator`.
While in your project directory, in command prompt/terminal type `./cordova/run <target>`. Replace `<target>` with either `qnx`, `playbook`, or `blackberry`. Note, for BlackBerry 10 and PlayBook, the simulator virtual image must already be started. For example...
@@ -137,9 +137,9 @@ BlackBerry PlayBook
BlackBerry Smartphone (OS5-7)
- `./cordova/run blackberry`
-Answer 'n' when prompted "Do you have a BlackBerry device connected to your computer? (y/n)"
+Answer "n" when prompted "Do you have a BlackBerry device connected to your computer? (y/n)"
-The application will be installed to the home screen of the simulator. Note, on BlackBerry OS 5 the application is installed in the Downloads folder.
+The application is installed to the simulator's home screen. Note that on BlackBerry OS 5, it is installed in the `Downloads` folder.
7B. Deploy to Device (Windows and Mac)
@@ -177,7 +177,7 @@ BlackBerry Smartphone (OS5-7)
Answer "y" when prompted "Do you have a BlackBerry device connected to your computer? (y/n)"
-The application will be installed to the home screen of the device. Note, on BlackBerry OS 5 the application is installed in the Downloads folder.
+The application is installed to the device's home screen. Note, on BlackBerry OS 5 the application is installed in the Downloads folder.
Additional Information
----------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/index.md b/docs/en/edge/guide/getting-started/index.md
index d937608..e8906f7 100644
--- a/docs/en/edge/guide/getting-started/index.md
+++ b/docs/en/edge/guide/getting-started/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/ios/index.md b/docs/en/edge/guide/getting-started/ios/index.md
index f894b93..8241736 100644
--- a/docs/en/edge/guide/getting-started/ios/index.md
+++ b/docs/en/edge/guide/getting-started/ios/index.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -27,67 +27,66 @@ Apache Cordova is a library used to create native mobile applications using Web
### Requirements ###
-- **Intel-based Computer with Mac® OS X® Lion or greater (10.7.4+)**
- The Apple® tools required for building iOS applications run only on the OS X operating system. The version of the development environment required, Xcode® 4.5, runs only on Mac OS X version 10.7 (Lion) or greater.
+- **Intel-based Computer with Mac® OS X® Lion or greater (10.7.4+)**
+ The Apple® tools required for building iOS applications run only on the OS X operating system. The version of the development environment required, Xcode® 4.5, runs only on Mac OS X version 10.7 (Lion) or greater.
- **Xcode 4.5 and iOS 6 SDK**
-
To submit apps to the Apple App Store℠, you must be using the latest versions of the Apple tools. Currently the latest versions are Xcode 4.5.2 and the iOS 6 SDK (Software Development Kit). The download of Xcode 4.5.2 includes the iOS 6 SDK.
- - Download from the [App Store](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) (https://itunes.apple.com/us/app/xcode/id497799835?mt=12).
- - Download from [Apple Developer Downloads](https://developer.apple.com/downloads/index.action) (https://developer.apple.com/downloads/index.action). Note: This link requires Apple Developer registration.
+ To submit apps to the Apple App Store℠, you must use the latest versions of the Apple tools. Currently the latest versions are Xcode 4.5.2 and the iOS 6 SDK (Software Development Kit). The download of Xcode 4.5.2 includes the iOS 6 SDK.
+ - Download from the [App Store](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) (https://itunes.apple.com/us/app/xcode/id497799835?mt=12).
+ - Download from [Apple Developer Downloads](https://developer.apple.com/downloads/index.action) (https://developer.apple.com/downloads/index.action). __NOTE:__ This link requires Apple Developer registration.
- **Xcode Command Line Tools**
- Cordova uses the command line to create a new application project. To access the Xcode tools from the command line an additional download is required. The tools are downloaded from within Xcode.
+ Cordova uses the command line to create a new application project. To access the Xcode tools from the command line an additional download is required. The tools are downloaded from within Xcode.
1. Open Xcode
- 2. Select the following via the Xcode Menus: **Xcode Preferences> Downloads>Command Line Tools**. This will download and install copies of the core command line tools and system headers into system folders on your computer.
+ 2. Select the following via the Xcode Menus: **Xcode Preferences> Downloads>Command Line Tools**. This downloads and installs copies of the core command-line tools and system headers into your computer's system folders.
- **iOS Device**
- You can test many of the Cordova features using the iOS simulator that is installed with the iOS SDK and Xcode, but you will need an actual device to fully test all of the device features used in your applications before submitting to the App Store. The device must have at least iOS 5.x installed - this is the minimum iOS version supported as of Cordova 2.3. Devices that support at least iOS 5 include all iPad® models, iPhone® 3GS and above, and iPod® Touch 3rd Generation or later.
In addition, to install apps onto a device, you must be a member of the [iOS Developer Program](https://developer.apple.com/programs/ios/) from Apple. The program costs $99 per year. This Getting Started guide documents deploying the application to the iOS simulator so registration with the developer program is not required.
+ You can test many of the Cordova features using the iOS simulator installed with the iOS SDK and Xcode, but you need an actual device to fully test all of the device features your applications use before submitting to the App Store. The device must have at least iOS 5.x installed, the minimum iOS version supported as of Cordova 2.3. Devices that support at least iOS 5 include all iPad® models, iPhone® 3GS and above, and iPod® Touch 3rd Generation or later. To install apps onto a device, you must also be a member of Apple's [iOS Developer Program](https://developer.apple.com/programs/ios/). The program costs $99 per year. This Getting Started guide shows how to deploy the application to the iOS simulator, in which case developer program registration is not required.
## Install Cordova
### Download Cordova
-Download the latest version of [Apache Cordova](http://www.apache.org/dist/cordova/) from http://www.apache.org/dist/cordova/. Click on the Download icon and select cordova-X.Y.Z-src.zip to download to your machine. The X, Y and Z represent the version number of Cordova, for example x.x.x. The download includes the code for all of the Apache Cordova supported platforms.
+Download the latest version of [Apache Cordova](http://www.apache.org/dist/cordova/) from http://www.apache.org/dist/cordova/. Click on the Download icon and select cordova-X.Y.Z-src.zip to download to your machine. The X, Y and Z represent the version number of Cordova, for example x.x.x. The download includes the code for all of the Apache Cordova supported platforms.
### Extract Cordova
-To access the code it will need to be extracted from the archive (.zip) file.
-
+To access the code, it needs to be extracted from the archive (.zip) file:
-1. Navigate to the folder where you downloaded the code. Find the cordova-X.Y.Z-src.zip file.
- Note: The file names change with each new version of Cordova. The file name will be different if you are using an updated or newer version of Cordova.
+1. Navigate to the folder where you downloaded the code. Find the cordova-X.Y.Z-src.zip file.
+ __NOTE:__ The filenames change with each incremental version of Cordova.
-2. Using the Finder® app, double click the file to extract. This will create a directory named, cordova-X.Y.Z.
+2. Using the Finder® app, double-click the file to extract. This creates a directory named `cordova-X.Y.Z`.
-3. Expand this folder and locate the cordova-ios.zip file and double click to extract it.
+3. Expand this folder and locate the cordova-ios.zip file and double-click to extract it.
4. The code for iOS is within the cordova-ios directory structure.
## Project Creation
-Xcode projects for Cordova are created by invoking a script file via the command line. The following steps explain how to create the necessary directory structure, open and use the Terminal application to create a new project, and execute the create script.
+Xcode projects for Cordova are created by invoking a script file via the command line. The following steps explain how to create the necessary directory structure, open and use the Terminal application to create a new project, and execute the create script.
### Determine Project Location
-Determine where on your system you will locate the Xcode project files for your application. For this tutorial I created a CordovaXY directory under my Documents folder: ~/Documents/CordovaXY where the X and Y refer the to Cordova version #.
+Determine where on your system to place your application's Xcode
+project files. This tutorial uses `~/Documents/CordovaXY`, where the
+'X' and 'Y' refer the to Cordova version number.
-1. In Finder navigate to the Documents Directory.
+1. In the Finder, navigate to the `Documents` directory.
-2. Create a directory called CordovaXY within the Documents directory where the X and Y represent the Cordova version number (23, for example). You can use a different directory name or location if you wish but you will need to remember this directory location and name for subsequent steps.
+2. Create a subdirectory within `Documents` called `CordovaXY`, where the 'X' and 'Y' represent the Cordova version number (23, for example). You can use a different directory name or location if you wish, but you need to remember it for subsequent steps.
### Open Terminal
-1. In Finder, navigate to the Applications Folder. Find and expand the Utilities Folder.
+1. Open the Terminal application, located by default in the `Applications/Utilities` folder.
-2. Locate the Terminal app and double click to open it.
-
-3. In Finder, navigate to the cordova-ios directory from the downloaded and extracted Cordova code and expand it if necessary. Highlight the bin directory as shown:
+3. Use the Finder to navigate to the `cordova-ios` directory from the downloaded and extracted Cordova code. Highlight the `bin` subdirectory as shown:
- **Note:** This screen capture was from the Cordova-2.3.0 download, your listing will vary based on the actual Cordova version installed.
+ __NOTE:__ Your listing varies depending on Cordova's version number.
-4. Drag this directory to the open Terminal icon in the dock. This will open up a default terminal window with the path set to the bin directory.
+4. Drag this directory to the open the Terminal icon in the dock. This opens up a default terminal window with the path set to the `bin` directory.
### Create New Project
@@ -95,21 +94,23 @@ Determine where on your system you will locate the Xcode project files for your
1. Determine Required Parameters
- There are 3 ordered, required parameters for creating a Cordova project from the command line:
+ Three parameters are required to creating a Cordova project from the command line, in this order:
+
1. **project location**
- This is the directory where the Xcode project and files for the application will be located. This tutorial is using ~/Documents/CordovaXY as the base location and the application name as the project directory. Thus the location for our project will be
~/Documents/CordovaXY/HelloWorld, where HelloWorld is the project name (note that the X and Y represent the Cordova version, for example 22 for version 2.2). The final directory, HelloWorld in this example, must not already exist as it will be created during execution of the command.
+
+ This directory is where the Xcode project and application files are to be located. This tutorial uses `~/Documents/CordovaXY` as the base location (with 'X' and 'Y' representing the Cordova version number) and the `HelloWorld` application name as the project directory. Since the command creates the final `HelloWorld` directory, it must not already exist.
2. **package name**
- When submitting apps to the App Store, this must be the reverse domain name App ID that is created via the Apple Provisioning Portal (described in the Deploy to Device section). The Provisioning Portal is accessible once you have paid for and signed into your iOS Developer Account. Since you will not be submitting this sample app, this tutorial uses org.apache.Cordova plus the app name, HelloWorld:
org.apache.cordova.HelloWorld
+ When submitting apps to the App Store, this must be the reverse domain name App ID that is created via the Apple Provisioning Portal (described in the Deploy to Device section). The Provisioning Portal is accessible once you have paid for and signed into your iOS Developer Account. Since you don't need to submit this sample app, this tutorial uses `org.apache.Cordova` plus the `HelloWorld` app name: `org.apache.cordova.HelloWorld`
3. **project name**
- This is the name of the actual project. Most developers make the project name and the application name the same. In this example the project name is HelloWorld.
+ This is the name of the actual project. Most developers match the project name with the application name, so in this example it's `HelloWorld`.
2. Execute the Command
In the terminal app with bin as the current directory, enter the 3 pieces of information via the following command:
-
`./create ~/Documents/CordovaXY/HelloWorld org.apache.cordova.HelloWorld HelloWorld`
+ `./create ~/Documents/CordovaXY/HelloWorld org.apache.cordova.HelloWorld HelloWorld`
@@ -117,9 +118,9 @@ Determine where on your system you will locate the Xcode project files for your
**No Developer Directory Found**
- The “Error: No developer directory found at /Developer” message is displayed if the create script can not find the location of the command line tools within Xcode. This can occur if more than one version of Xcode is installed on the system or when upgrading from older versions of Xcode. The solution is to run the xcode-select command to set the location. If you have installed Xcode in the default location the command to execute is:
+ The “Error: No developer directory found at /Developer” message is displayed if the create script can not find the location of the command-line tools within Xcode. This can occur if more than one version of Xcode is installed on the system or when upgrading from older versions of Xcode. The solution is to run the xcode-select command to set the location. If you have installed Xcode in the default location the command to execute is:
- sudo /usr/bin/xcode-select -switch /Applications/Xcode.app/Contents/Developer
+ sudo /usr/bin/xcode-select -switch /Applications/Xcode.app/Contents/Developer
See [http://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/xcode-select.1.html](http://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/xcode-select.1.html) for more information on the xcode-select command if you have installed Xcode in a different location.
@@ -127,59 +128,59 @@ Determine where on your system you will locate the Xcode project files for your
- **Additional Parameters**
- The default create script copies the necessary common library files from the Cordova distribution directory into your Xcode project directory. These files will appear within the CordovaLib directory of your project structure. Some development organizations prefer to have developers reference the common Cordova library files from a fixed location. A common location helps to insure that all developers are using the exact same copy of the CordovaLib code. This is accomplished by adding the --shared parameter to the create command. The following command will create a project that references the CordovaLib directory from the iOS directory location where the create script is executed:
+ The default create script copies the necessary common library files from the Cordova distribution directory into your Xcode project directory. These files appear within the project's `CordovaLib` directory. Some development organizations prefer that developers reference the common Cordova library files from a fixed location, which helps ensure that all developers use the exact same copy of the CordovaLib code. To do this, add the `--shared` parameter to the `create` command. The following command creates a project that references the CordovaLib directory from the iOS directory location in which you run the `create` script:
- ./create --shared ~/Documents/CordovaXY/HelloWorld org.apache.cordova.HelloWorld HelloWorld
-
The Xcode project is still created in the ~/Documents/CordovaXY/HelloWorld directory, but it references the CordovaLib files from the fixed location of the Cordova distribution rather than a copy of these files within the project directory.
+ ./create --shared ~/Documents/CordovaXY/HelloWorld org.apache.cordova.HelloWorld HelloWorld
+ The Xcode project files are still in the `~/Documents/CordovaXY/HelloWorld` directory, but the CordovaLib files are referenced from the Cordova distribution directory.
- **Additional Scripts**
- Within the cordova-ios/bin directory there is an additional script that changes the location of the CordovaLib directory to refer to a shared location after the project has been created,
+ Within the cordova-ios/bin directory there is an additional script that changes the location of the CordovaLib directory to refer to a shared location after the project has been created,
- ./update_cordova_subproject path/to/your/project
+ ./update_cordova_subproject path/to/your/project
- Most users will be satisfied with the default project creation procedure and do not need this additional script. This script uses the location of CordovaLib directory at the same directory level as the bin directory from which it is run as the shared location for CordovaLib. To modify the newly created HelloWorld project to use a shared location for CordovaLib, execute the following command from the bin directory:
+ Most users are satisfied with the default project creation procedure and do not need this additional script. This script uses the location of CordovaLib directory at the same directory level as the bin directory from which it is run as the shared location for CordovaLib. To modify the newly created HelloWorld project to use a shared location for CordovaLib, execute the following command from the `bin` directory:
- ./update_cordova_subproject ~/Documents/CordovaXY/HelloWorld
+ ./update_cordova_subproject ~/Documents/CordovaXY/HelloWorld
## Running the Application
### Open the Project
- Using the Finder app, navigate to the location where you created the project. This guide uses ~/Documents/CordovaXY/HelloWorld. Double click the HelloWorld.xcodeproj file to open the project in Xcode.
+ Using the Finder app, navigate to the location where you created the project. This guide uses `~/Documents/CordovaXY/HelloWorld`. Double-click the `HelloWorld.xcodeproj` file to open the project in Xcode.
Your screen should look similar to:
- **Note:** this screen capture shows a project that was created with the name as HelloWorld23.
+ __NOTE:__ this screen capture shows a project that was created with the name as HelloWorld23.
### Deploy to the Simulator
- 1. In the upper left hand corner of Xcode, click on the Scheme drop down and select the project name, HelloWorld, as the target.
- 2. Click the device section and select an iOS Simulator such as iPhone 6.0 Simulator as shown:
+ 1. In the upper-left corner of Xcode, click on the Scheme drop-down list and select the project name, HelloWorld, as the target.
+ 2. Click the device section and select an iOS Simulator such as iPhone 6.0 Simulator as shown:
- 3. Click the **Run** button in your project window's toolbar to build, deploy and run the application in the simulator.
+ 3. Click the **Run** button in your project window's toolbar to build, deploy and run the application in the simulator.
### Deploy to the Device
#### Requirements
- There are several requirements to deploy to a device. Since this information is not related directly to Cordova, please refer to the Apple Configuring Development and Distribution Assets section of the [Tools Workflow Guide for iOS](http://developer.apple.com/library/ios/#documentation/Xcode/Conceptual/ios_development_workflow/00-About_the_iOS_Application_Development_Workflow/introduction.html#//apple_ref/doc/uid/TP40007959) documentation for complete details.
+ There are several requirements to deploy to a device. Since this information is not related directly to Cordova, please refer to the _Configuring Development and Distribution Assets_ section of Apple's [Tools Workflow Guide for iOS](http://developer.apple.com/library/ios/#documentation/Xcode/Conceptual/ios_development_workflow/00-About_the_iOS_Application_Development_Workflow/introduction.html#//apple_ref/doc/uid/TP40007959).
- - Join the Apple iOS Developer Program
+ - Join the Apple iOS Developer Program
- - Create a Provisioning Profile within the [iOS Provisioning Portal](https://developer.apple.com/ios/manage/overview/index.action). You can use the Development Provisioning Assistant within the Provisioning Portal to create and install the profile and certificate for use within Xcode.
+ - Create a Provisioning Profile within the [iOS Provisioning Portal](https://developer.apple.com/ios/manage/overview/index.action). You can use the Development Provisioning Assistant within the Provisioning Portal to create and install the profile and certificate for use within Xcode.
- - Verify that the Code Signing Identity in the Code Signing sections of the Hello World Xcode project settings has been set with your provisioning profile name.
+ - Verify that the Code Signing Identity in the Code Signing sections of the Hello World Xcode project settings has been set with your provisioning profile name.
#### Deployment Steps
- 1. Plug your device into your Mac via the USB Cable.
+ 1. Plug your device into your Mac via the USB Cable.
2. Select the Target and device
- 1. In the upper left hand corner of Xcode, click the Scheme drop down and select the project name, HelloWorld, as the target.
- 2. Click the device section and select your device from the list. If your device is plugged in via the USB but not visible in the device list, click the **Organizer** button to determine any errors.
+ 1. In the upper-left corner of the Xcode window, click the Scheme drop-down list and select the project name, HelloWorld, as the target.
+ 2. Click the device section and select your device from the list. If your device is plugged in via the USB but not visible in the device list, click the **Organizer** button to determine any errors.
- 3. Click the **run** button to build, deploy and run the application on your device.
+ 3. Click the **run** button to build, deploy and run the application on your device.
## Results
@@ -191,11 +192,22 @@ Determine where on your system you will locate the Xcode project files for your
### Deprecation Warnings
- When an application programming interface (API) has been changed or replaced by another API, it is marked as “deprecated.” The API will still work in the near term but will be removed in a future version of the code library. Apache Cordova contains some of these deprecated interfaces. When you build and deploy an application, Xcode will issue warnings about these deprecated APIs. The ‘invokeString’ method that Xcode is warning about represents functionality to invoke the app from a custom URL. The process for loading from a custom URL has changed but this code is included to provide backwards functionality for apps created with older versions of Cordova. The sample app does not use this functionality so the references to the items causing the warnings can be ignored.
-
- If you wish to remove the warnings you can remove the code that is referencing the invokeString deprecated API.
-
- 1. Navigate to the MainViewController.m file in the Classes folder.
+When an application programming interface (API) is changed or replaced
+by another API, it is marked as "deprecated." The API still works in
+the near term, but is eventually removed. Some of these deprecated
+interfaces are reflected in Apache Cordova, and Xcode issues warnings
+about them when you build and deploy an application. The Xcode
+warning about the ‘invokeString’ method concerns functionality that
+launches the app from a custom URL. While the mechanism to load from a
+custom URL has changed, this code is included to provide backwards
+functionality for apps created with older versions of Cordova. The
+sample app does not use this functionality, so these warnings can be
+ignored.
+
+If you wish to remove the warnings you can remove the code that
+references the deprecated invokeString API:
+
+ 1. Edit the `Classes/MainViewController.m` file.
2. Find and comment out the following code by surrounding it with the begin, /*, and end, */, comment characters as highlighted in the code snippet below.
(void)webViewDidFinishLoad:(UIWebView*)theWebView
@@ -211,27 +223,27 @@ Determine where on your system you will locate the Xcode project files for your
*/
// Black base color for background matches the native apps
theWebView.backgroundColor = [UIColor blackColor];
-
+
return [super webViewDidFinishLoad:theWebView];
}
-
- 3. Press Command s to save the file.
+
+ 3. Press Command s to save the file.
4. Navigate to the AppViewDelegate.m file in the Classes Folder.
- 5. Comment out the following line by placing a double slash at the beginning of line 73 as shown below:
+ 5. Comment out the following line by placing a double slash at the beginning of line 73 as shown below:
- //self.viewController.invokeString = invokeString;
+ //self.viewController.invokeString = invokeString;
6. Press Command-s to save the file.
- 7. Press Command-b to rebuild the project and eliminate the warnings.
+ 7. Press Command-b to rebuild the project and eliminate the warnings.
### Missing Headers
- Some users have encountered compilation errors relating to missing headers. This refers to a problem in the build location and is fixed via Xcode preferences.
+ Some users have encountered compilation errors relating to missing headers. This refers to a problem in the build location and is fixed via Xcode preferences.
- 1. Within the Xcode menus select **Xcode>Preferences>Locations**.
- 2. In the Derived Data section click the Advanced button and select Unique as the Build Location as shown:
+ 1. Within the Xcode menus select **Xcode>Preferences>Locations**.
+ 2. In the Derived Data section click the Advanced button and select Unique as the Build Location as shown:
This is the default setting for a new Xcode install but it may have been set differently if you upgraded from an older version of Xcode.
@@ -249,7 +261,7 @@ Determine where on your system you will locate the Xcode project files for your
<script type="text/javascript">
app.initialize();
</script>
-
+
**Wait for deviceReady Event**
When loading a page, Cordova’s deviceReady event must fire before you can access any of the platform features via the Cordova JavaScript APIs. Within the sample application this is set up within the app object found within the js/index.js file. The app.initialze() call at the bottom of the index.html file (visible in the previous code example) sets in motion the binding of events to receive and respond to the deviceReady event.
@@ -301,23 +313,23 @@ Determine where on your system you will locate the Xcode project files for your
### Apple
- Some of these references are within the Apple iOS Developer Reference and require an iOS Developer License.
+ Some of these references are within the Apple iOS Developer Reference and require an iOS Developer License.
- - [Start Developing iOS Apps Today](http://developer.apple.com/library/ios/#referencelibrary/GettingStarted/RoadMapiOS/index.html#//apple_ref/doc/uid/TP40011343) provides a quick overview of steps for developing iOS Apps.
- - [Member Center home page](https://developer.apple.com/membercenter/index.action) provides links to several iOS technical resources including technical resources, the provisioning portal, distribution guides and community forums.
- - [Tools Workflow Guide for iOS](http://developer.apple.com/library/ios/#documentation/Xcode/Conceptual/ios_development_workflow/00-About_the_iOS_Application_Development_Workflow/introduction.html#//apple_ref/doc/uid/TP40007959)
- - [Xcode 4 User Guide](http://developer.apple.com/library/ios/#documentation/ToolsLanguages/Conceptual/Xcode4UserGuide/000-About_Xcode/about.html#//apple_ref/doc/uid/TP40010215)
+ - [Start Developing iOS Apps Today](http://developer.apple.com/library/ios/#referencelibrary/GettingStarted/RoadMapiOS/index.html#//apple_ref/doc/uid/TP40011343) provides a quick overview of steps for developing iOS Apps.
+ - [Member Center home page](https://developer.apple.com/membercenter/index.action) provides links to several iOS technical resources including technical resources, the provisioning portal, distribution guides and community forums.
+ - [Tools Workflow Guide for iOS](http://developer.apple.com/library/ios/#documentation/Xcode/Conceptual/ios_development_workflow/00-About_the_iOS_Application_Development_Workflow/introduction.html#//apple_ref/doc/uid/TP40007959)
+ - [Xcode 4 User Guide](http://developer.apple.com/library/ios/#documentation/ToolsLanguages/Conceptual/Xcode4UserGuide/000-About_Xcode/about.html#//apple_ref/doc/uid/TP40010215)
- [Session Videos](https://developer.apple.com/videos/wwdc/2012/) from the Apple World Wide Developer Conference 2012 (WWDC2012)
### Apache Cordova
The [Apache Cordova home page](http://cordova.apache.org/) contains all of the links below and more.
- - Cordova API documentation is available at [http://docs.cordova.io](http://docs.cordova.io)
- - [PhoneGap google group](https://groups.google.com/forum/?fromgroups=%23!forum/phonegap) to discuss and ask questions about Cordova. This forum is monitored by Cordova developers as well as users. When posting please include the platform, device type, Cordova version and as many details as possible about the error or problem.
+ - Cordova API documentation is available at [http://docs.cordova.io](http://docs.cordova.io)
+ - [PhoneGap google group](https://groups.google.com/forum/?fromgroups=%23!forum/phonegap) to discuss and ask questions about Cordova. This forum is monitored by Cordova developers as well as users. When posting please include the platform, device type, Cordova version and as many details as possible about the error or problem.
- File Cordova bugs at [https://issues.apache.org/jira/browse/CB](https://issues.apache.org/jira/browse/CB)
### Credits
-
+
Mac®, OS X®, Apple®, Xcode®, App Store℠, iPad®, iPhone®, iPod® and Finder® are Trademarks of Apple Inc.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/symbian/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/symbian/index.md b/docs/en/edge/guide/getting-started/symbian/index.md
index d73ad92..525fb88 100644
--- a/docs/en/edge/guide/getting-started/symbian/index.md
+++ b/docs/en/edge/guide/getting-started/symbian/index.md
@@ -40,27 +40,27 @@ There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGa
-------------------------
- Download and install [cygwin](http://www.cygwin.com/setup.exe) (Windows only). Make sure you select "make" as it is not included by default
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the Android directory.
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the Android directory.
-3. Setup New Project
+3. Set up New Project
--------------------
- In cygwin, navigate to where you extracted Cordova and go into the Symbian directory</li>
-
+
4. Hello World
--------------
-- Open up index.html located in phonegap/symbian/framework/www with your favourite editor.
+- Open up index.html located in phonegap/symbian/framework/www with your favourite editor.
- In the `body` tag, remove the line `"Build your phonegap app here! Dude!"` and add the line `<h1>Hello World</h1>`
-- In cygwin/terminal, type make. This will produce phonegap-symbian.wrt/app.wgz.
+- In cygwin/terminal, type `make`. This produces a `phonegap-symbian.wrt/app.wgz` file.
5A. Deploy to Simulator
-----------------------
-- For Mac or Linux you should install [Aptana Studio](http://www.aptana.org/products/studio2/download) and [Nokia WRT Plug-in for Aptana Studio](http://www.forum.nokia.com/info/sw.nokia.com/id/00d62bd8-4214-4c86-b608-5f11b94dad54/Nokia_WRT_Plug_in_for_Aptana_Studio.html). This has a browser-based javascript emulator
+- For Mac or Linux you should install [Aptana Studio](http://www.aptana.org/products/studio2/download) and [Nokia WRT Plug-in for Aptana Studio](http://www.forum.nokia.com/info/sw.nokia.com/id/00d62bd8-4214-4c86-b608-5f11b94dad54/Nokia_WRT_Plug_in_for_Aptana_Studio.html). This has a browser-based JavaScript emulator
- For Windows you can download the [S60 SDK](http://www.forum.nokia.com/info/sw.nokia.com/id/ec866fab-4b76-49f6-b5a5-af0631419e9c/S60_All_in_One_SDKs.html) which includes the S60 Emulator
- Load the phonegap-symbian.wrt/app.wgz file into the emulator.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/tizen/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/tizen/index.md b/docs/en/edge/guide/getting-started/tizen/index.md
index a45895e..4271a3e 100644
--- a/docs/en/edge/guide/getting-started/tizen/index.md
+++ b/docs/en/edge/guide/getting-started/tizen/index.md
@@ -31,10 +31,10 @@ This guide describes how to set up your development environment for Cordova and
-------------------------
- Download and install the [Tizen SDK](https://developer.tizen.org/sdk).
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the tizen directory.
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `tizen` directory.
- (optional) Install Tizen Cordova template projects: copy the `/templates` directory content into you Tizen Eclipse IDE web templates directory (e.g: `/home/my_username/tizen-sdk/IDE/Templates/web`).
-3. Setup New Project
+3. Set up New Project
--------------------
- **Method #1: Import a Cordova Tizen project sample**
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/webos/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/webos/index.md b/docs/en/edge/guide/getting-started/webos/index.md
index 37ab244..7d5635c 100644
--- a/docs/en/edge/guide/getting-started/webos/index.md
+++ b/docs/en/edge/guide/getting-started/webos/index.md
@@ -41,12 +41,12 @@ Video Tutorials:
- Download and install [Virtual Box](http://www.virtualbox.org/)
- Download and install [WebOS SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321/)
- Download and install [cygwin SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321) (Windows only). Make sure you select "make" as it is not included by default
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the webOS directory.
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `webOS` directory.
- Download and install XCode from the [Mac App Store](http://itunes.apple.com/ca/app/xcode/id497799835?mt=12) (OSX only)
- Download and install Command Line Tools for XCode (OSX only); this can be done by going to XCode's Preferences -> Downloads -> Components and then click install on Command Line Tools
-
-3. Setup New Project
+
+3. Set up New Project
--------------------
- Open up terminal/cygwin and navigate to where you extracted your Cordova Download. Go into the webOS directory.
@@ -55,7 +55,7 @@ Video Tutorials:
4. Hello World
--------------
-In phonegap/webOS/framework/www, open up index.html with your favourite editor. After the body tag add `<h1>Hello World</h1>`
+Edit `phonegap/webOS/framework/www/index.html`, adding `<h1>Hello World</h1>` after the `<body>` tag.
5A. Deploy to Simulator
@@ -70,10 +70,11 @@ In phonegap/webOS/framework/www, open up index.html with your favourite editor.
- Make sure your device is in [Developer Mode and plug it in.](http://developer.palm.com/index.php?option=com_content&view=article&id=1552&Itemid=59#dev_mode)
- Type `make` in your terminal/cygwin while in the webOS directory.
-
+
Done!
-----
-You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/16494781/Getting-Started-with-PhoneGap-webOS).
+A more detailed version of this guide is available
+[here](http://wiki.phonegap.com/w/page/16494781/Getting-Started-with-PhoneGap-webOS).
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/726c9630/docs/en/edge/guide/getting-started/windows-8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/getting-started/windows-8/index.md b/docs/en/edge/guide/getting-started/windows-8/index.md
index bddc976..fad87a2 100644
--- a/docs/en/edge/guide/getting-started/windows-8/index.md
+++ b/docs/en/edge/guide/getting-started/windows-8/index.md
@@ -20,9 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Getting Started with Windows 8
==================================
-This guide describes how to set up your development environment for Cordova and run a sample application. Note that Cordova used to be called PhoneGap, so some of the sites still use the old PhoneGap name.
+This guide describes how to set up your Cordova development
+environment and run a sample application. Note that Cordova used to
+be called PhoneGap, so some of the sites still use the old PhoneGap
+name.
-During development of Windows 8 and Windows RT, Microsoft deprecated the name "Metro-style apps". On MSDN, this type of app is now called a "Windows Store" app. That's the name that we'll use in this guide. Also in this guide whenever we refer to Windows 8, you should take that to mean both Windows 8 and Windows RT.
+Microsoft deprecated the name "Metro-style apps" in Windows 8 and
+Windows RT. MSDN now refers to this type of app as a "Windows Store"
+app, and this guide follows that convention. Also, in this guide
+"Windows 8" signifies both Windows 8 and Windows RT.
1. Requirements
---------------
@@ -36,24 +42,24 @@ Follow the instructions [here](http://www.windowsstore.com/) to submit your apps
2. Install SDK + Cordova
----------------------------
-- Setup your preferred variant of Visual Studio 2012. All of the paid versions of the product (Professional, etc) let you build Windows Store apps. To build Windows Store apps using the [Express editions](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-products), you will need **Express for Windows 8**.
-- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the subfolder **lib\windows-8**.
+- Set up your preferred variant of Visual Studio 2012. All of the product's paid versions (Professional, etc.) let you build Windows Store apps. You need **Express for Windows 8** to build Windows Store apps using the [Express editions](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-products).
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-8` subfolder.
-3. Setup New Project
+3. Set up New Project
--------------------
You can already build Windows 8 apps using the "HTML/JavaScript track" available in Windows Store apps. The purpose of Cordova in Windows Store apps is to expose the same APIs used on all the other Cordova platforms.
- Open Visual Studio 2012 and choose **New Project**.
-- Select **Installed - Template - Other Languages - JavaScript - Windows Store** from the tree, and then **Blank App** from the projects list. Enter whatever project name you like. We're using **CordovaWin8Foo** in this guide.
+- Select **Installed - Template - Other Languages - JavaScript - Windows Store** from the tree, and then **Blank App** from the projects list. Enter whatever project name you like, such as **CordovaWin8Foo** in this example.
-- Microsoft continues to use **default.html** as the default page for use in websites, whereas most "open web" developers use **index.html**. (Plus it's likely that in the other platform variants of your project you are using **index.html** as the name of your default page.) To fix this, in Solution Explorer rename the **default.html** file to **index.html**. Then double-click the **package.appxmanifest** file and change the **Start page** value to **index.html**.
+- Microsoft continues to use `default.html` as the default home page, but most web developers use `index.html`. (Plus it's likely that in the other platform variants of your project you are using `index.html` as the name of your default page.) To fix this, in Solution Explorer rename the `default.html` file to `index.html`. Then double-click the **package.appxmanifest** file and change the **Start page** value to **index.html**.
-- To include **cordova.js** in your project, right-click on the **js** folder in Solution Explorer and select **Add - New Item**. Locate the **cordova.js** file in the **lib\windows-8** folder that we called out previously.
+- To include **cordova.js** in your project, right-click on the **js** folder in Solution Explorer and select **Add - New Item**. Locate the **cordova.js** file in the **lib\windows-8** folder noted above.
- Edit the code for **index.html**. Add a reference to **cordova.js**. You can do this manually, or by dragging the file from Solution Explorer.
@@ -70,7 +76,7 @@ You can already build Windows 8 apps using the "HTML/JavaScript track" available
<link href="/css/default.css" rel="stylesheet" />
<script src="/js/default.js"></script>
-- Next we want to add some code that will demonstrate that Cordova is working.
+- Next, add some code that demonstrates Cordova is working.
### Adding a 'deviceready' handler...
<body>
@@ -93,7 +99,7 @@ You can already build Windows 8 apps using the "HTML/JavaScript track" available
5. Test the Project
-------------------------------
-- Run the project from Visual Studio. You'll see the message box appear.
+- Run the project from Visual Studio. You'll see the message box appear:
[14/46] docs commit: removed links to empty pages
Posted by mw...@apache.org.
removed links to empty pages
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/918cf22f
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/918cf22f
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/918cf22f
Branch: refs/heads/master
Commit: 918cf22fe9287414bd33dda069858e85fd458f1d
Parents: 3986e79
Author: Mike Sierra <le...@gmail.com>
Authored: Mon May 13 14:26:57 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon May 13 14:26:57 2013 -0400
----------------------------------------------------------------------
docs/en/edge/guide/plugin-development/index.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/918cf22f/docs/en/edge/guide/plugin-development/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugin-development/index.md b/docs/en/edge/guide/plugin-development/index.md
index 5d43824..a978bfc 100644
--- a/docs/en/edge/guide/plugin-development/index.md
+++ b/docs/en/edge/guide/plugin-development/index.md
@@ -105,6 +105,6 @@ simple Echo Plugin example discussed above.
- Developing a Plugin on Bada
- Developing a Plugin on BlackBerry
- Developing a Plugin on iOS
-- Developing a Plugin on webOS
- Developing a Plugin on Windows Phone
-- Developing a Plugin on Tizen
+
+The webOS and Tizen platforms currently do not support plugins.
[37/46] docs commit: minor corrections
Posted by mw...@apache.org.
minor corrections
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/fbc5e1db
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/fbc5e1db
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/fbc5e1db
Branch: refs/heads/master
Commit: fbc5e1dbd5c4ab0f9f7d737f8fdc14dad8c6160a
Parents: 5f4e3d9
Author: Mike Sierra <le...@gmail.com>
Authored: Mon May 20 13:00:19 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Mon May 20 13:00:19 2013 -0400
----------------------------------------------------------------------
docs/en/edge/cordova/notification/notification.alert.md | 6 +++---
docs/en/edge/cordova/storage/sqlerror/sqlerror.md | 2 +-
2 files changed, 4 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fbc5e1db/docs/en/edge/cordova/notification/notification.alert.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/notification/notification.alert.md b/docs/en/edge/cordova/notification/notification.alert.md
index dbfafb5..2460ae4 100644
--- a/docs/en/edge/cordova/notification/notification.alert.md
+++ b/docs/en/edge/cordova/notification/notification.alert.md
@@ -111,12 +111,12 @@ Full Example
Windows Phone 7 and 8 Quirks
-------------
-- There is no built-in browser alert, so if you want to just write `alert('foo')`; you can assign:
+- There is no built-in browser alert, but you can bind one as follows to call `alert()` in the global scope:
window.alert = navigator.notification.alert;
-- `alert` and `confirm` calls are non-blocking, and the result is only available asynchronously.
+- Both `alert` and `confirm` are non-blocking calls, results of which are only available asynchronously.
Bada 2.x Quirks
---------------
-- Uses JavaScript's `alert`
+- Uses JavaScript's `alert` function.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fbc5e1db/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/sqlerror/sqlerror.md b/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
index c6bce00..5515103 100644
--- a/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
+++ b/docs/en/edge/cordova/storage/sqlerror/sqlerror.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
SQLError
========
-An `SQLError` object is thrown when an error occurs.
+A `SQLError` object is thrown when an error occurs.
Properties
----------
[41/46] sanitize code & trim xtra Cordova refs
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.endcallbutton.md b/docs/en/edge/cordova/events/events.endcallbutton.md
index 1372e25..764c04e 100644
--- a/docs/en/edge/cordova/events/events.endcallbutton.md
+++ b/docs/en/edge/cordova/events/events.endcallbutton.md
@@ -30,7 +30,7 @@ Details
The event overrides the default end call behavior.
Applications typically should use `document.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -53,22 +53,18 @@ Full Example
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova End Call Button Example</title>
+ <title>End Call Button Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
// Register the event listener
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.menubutton.md b/docs/en/edge/cordova/events/events.menubutton.md
index ae97e43..fc0da76 100644
--- a/docs/en/edge/cordova/events/events.menubutton.md
+++ b/docs/en/edge/cordova/events/events.menubutton.md
@@ -30,7 +30,7 @@ Details
Applying an event handler overrides the default menu button behavior.
Applications typically should use `document.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -54,22 +54,18 @@ Full Example
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova Menu Button Example</title>
+ <title>Menu Button Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
// Register the event listener
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.offline.md b/docs/en/edge/cordova/events/events.offline.md
index 0f2abe6..7eaeac1 100644
--- a/docs/en/edge/cordova/events/events.offline.md
+++ b/docs/en/edge/cordova/events/events.offline.md
@@ -35,7 +35,7 @@ and fires when the `connection.type` changes from `NONE` to any other
value.
Applications typically should use `document.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -62,25 +62,21 @@ Full Example
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Offline Example</title>
+ <title>Offline Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
- document.addEventListener("offline", onOffline, false);
+ document.addEventListener("offline", onOffline, false);
}
// Handle the offline event
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.online.md b/docs/en/edge/cordova/events/events.online.md
index 6230f95..fd6dcaf 100644
--- a/docs/en/edge/cordova/events/events.online.md
+++ b/docs/en/edge/cordova/events/events.online.md
@@ -20,8 +20,8 @@ license: Licensed to the Apache Software Foundation (ASF) under one
online
===========
-This event fires when a Cordova application goes online, and the
-device becomes connected to the Internet.
+This event fires when an application goes online, and the device
+becomes connected to the Internet.
document.addEventListener("online", yourCallbackFunction, false);
@@ -34,7 +34,7 @@ It relies on the same information as the Connection API, and fires
when the value of `connection.type` becomes `NONE`.
Applications typically should use `document.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -61,23 +61,19 @@ Full Example
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Online Example</title>
+ <title>Online Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("online", onOnline, false);
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.pause.md b/docs/en/edge/cordova/events/events.pause.md
index 3dc7a33..f7c23cc 100644
--- a/docs/en/edge/cordova/events/events.pause.md
+++ b/docs/en/edge/cordova/events/events.pause.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
pause
===========
-The event fires when a Cordova application is put into the background.
+The event fires when an application is put into the background.
document.addEventListener("pause", yourCallbackFunction, false);
@@ -32,7 +32,7 @@ into the background, typically when the user switches to a different
application.
Applications typically should use `document.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -58,25 +58,21 @@ Full Example
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Pause Example</title>
+ <title>Pause Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
- document.addEventListener("pause", onPause, false);
+ document.addEventListener("pause", onPause, false);
}
// Handle the pause event
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.resume.md b/docs/en/edge/cordova/events/events.resume.md
index d9c99d9..ac3a7b2 100644
--- a/docs/en/edge/cordova/events/events.resume.md
+++ b/docs/en/edge/cordova/events/events.resume.md
@@ -20,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
resume
===========
-The event fires when a Cordova application is retrieved from the background.
+The event fires when an application is retrieved from the background.
document.addEventListener("resume", yourCallbackFunction, false);
@@ -31,7 +31,7 @@ The `resume` event fires when the native platform pulls the
application out from the background.
Applications typically should use `document.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -57,22 +57,18 @@ Full Example
<!DOCTYPE html>
<html>
<head>
- <title>Cordova Resume Example</title>
+ <title>Resume Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
document.addEventListener("resume", onResume, false);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.searchbutton.md b/docs/en/edge/cordova/events/events.searchbutton.md
index da54bcd..68dc4d1 100644
--- a/docs/en/edge/cordova/events/events.searchbutton.md
+++ b/docs/en/edge/cordova/events/events.searchbutton.md
@@ -31,7 +31,7 @@ If you need to override the default search button behavior on Android
you can register an event listener for the 'searchbutton' event.
Applications typically should use `document.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -54,22 +54,18 @@ Full Example
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova Search Button Example</title>
+ <title>Search Button Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
// Register the event listener
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.startcallbutton.md b/docs/en/edge/cordova/events/events.startcallbutton.md
index 6720823..5f277ba 100644
--- a/docs/en/edge/cordova/events/events.startcallbutton.md
+++ b/docs/en/edge/cordova/events/events.startcallbutton.md
@@ -31,7 +31,7 @@ If you need to override the default start call behavior you can
register an event listener for the `startcallbutton` event.
Applications typically should use `document.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -54,22 +54,18 @@ Full Example
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova Start Call Button Example</title>
+ <title>Start Call Button Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
// Register the event listener
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumedownbutton.md b/docs/en/edge/cordova/events/events.volumedownbutton.md
index 0704318..f50020e 100644
--- a/docs/en/edge/cordova/events/events.volumedownbutton.md
+++ b/docs/en/edge/cordova/events/events.volumedownbutton.md
@@ -31,7 +31,7 @@ If you need to override the default volume down behavior you can
register an event listener for the `volumedownbutton` event.
Applications typically should use `document.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -54,22 +54,18 @@ Full Example
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova Volume Down Button Example</title>
+ <title>Volume Down Button Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
// Register the event listener
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumeupbutton.md b/docs/en/edge/cordova/events/events.volumeupbutton.md
index 73f64a9..d3db477 100644
--- a/docs/en/edge/cordova/events/events.volumeupbutton.md
+++ b/docs/en/edge/cordova/events/events.volumeupbutton.md
@@ -31,7 +31,7 @@ If you need to override the default volume up behavior you can
register an event listener for the `volumeupbutton` event.
Applications typically should use `document.addEventListener` to
-attach an event listener once the Cordova `deviceready` event fires.
+attach an event listener once the `deviceready` event fires.
Supported Platforms
-------------------
@@ -54,22 +54,18 @@ Full Example
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <title>Cordova Volume Up Button Example</title>
+ <title>Volume Up Button Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Call onDeviceReady when Cordova is loaded.
- //
- // At this point, the document has loaded but cordova-x.x.x.js has not.
- // When Cordova is loaded and talking with the native device,
- // it will call the event `deviceready`.
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is loaded and it is now safe to make calls Cordova methods
+ // device APIs are available
//
function onDeviceReady() {
// Register the event listener
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index a5b54e3..dd5142e 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -32,8 +32,8 @@ Properties
- __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 attributes are defined by the W3C
-specification, but are _not_ supported by Cordova:
+__NOTE:__ The following attribute is defined by the W3C specification,
+but is _not_ supported:
- __filesystem__: The file system on which the `DirectoryEntry` resides. _(FileSystem)_
@@ -119,34 +119,34 @@ __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);
+ setFolderMetadata(LocalFileSystem.PERSISTENT, "Backups", "com.apple.MobileBackup", 1);
moveTo
------
@@ -178,7 +178,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,
@@ -207,15 +207,15 @@ __Parameters:__
__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,
@@ -282,8 +282,8 @@ __Quick Example__
alert('Failed to get parent directory: ' + error.code);
}
- // Get the parent DirectoryEntry
- entry.getParent(success, fail);
+ // Get the parent DirectoryEntry
+ entry.getParent(success, fail);
createReader
------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryreader/directoryreader.md b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
index dcddd3a..b37edb9 100644
--- a/docs/en/edge/cordova/file/directoryreader/directoryreader.md
+++ b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
@@ -50,7 +50,7 @@ __Parameters:__
- __errorCallback__: A callback that executes if an error occurs when retrieving the directory listing. Invoked with a `FileError` object. _(Function)_
__Quick Example__
-
+
function success(entries) {
var i;
for (i=0; i<entries.length; i++) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileentry/fileentry.md b/docs/en/edge/cordova/file/fileentry/fileentry.md
index 4b6f651..f362833 100644
--- a/docs/en/edge/cordova/file/fileentry/fileentry.md
+++ b/docs/en/edge/cordova/file/fileentry/fileentry.md
@@ -32,8 +32,8 @@ Properties
- __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 attributes are defined by the W3C
-specification, but are _not_ supported by Cordova:
+__NOTE:__ The following attribute is defined by the W3C specification,
+but is _not_ supported:
- __filesystem__: The file system on which the `FileEntry` resides. _(FileSystem)_
@@ -117,34 +117,34 @@ __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);
+ setFileMetadata(LocalFileSystem.PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1);
moveTo
------
@@ -202,11 +202,11 @@ __Parameters:__
__Quick Example__
function win(entry) {
- console.log("New Path: " + entry.fullPath);
+ console.log("New Path: " + entry.fullPath);
}
function fail(error) {
- alert(error.code);
+ alert(error.code);
}
function copyFile(entry) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileobj/fileobj.md b/docs/en/edge/cordova/file/fileobj/fileobj.md
index c343383..ee5f1d4 100644
--- a/docs/en/edge/cordova/file/fileobj/fileobj.md
+++ b/docs/en/edge/cordova/file/fileobj/fileobj.md
@@ -73,7 +73,7 @@ __Full Example__
var slice1 = file.slice(100, 400);
var slice2 = slice1.slice(20, 35);
-
+
var slice3 = file.slice(120, 135);
// slice2 and slice3 are equivalent.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filereader/filereader.md b/docs/en/edge/cordova/file/filereader/filereader.md
index f7e9f98..d888999 100644
--- a/docs/en/edge/cordova/file/filereader/filereader.md
+++ b/docs/en/edge/cordova/file/filereader/filereader.md
@@ -74,19 +74,19 @@ __Parameters:__
Quick Example
-------------
- function win(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("read success");
+ function win(file) {
+ var reader = new FileReader();
+ reader.onloadend = function (evt) {
+ console.log("read success");
console.log(evt.target.result);
};
- reader.readAsDataURL(file);
- };
+ reader.readAsDataURL(file);
+ };
+
+ var fail = function (evt) {
+ console.log(error.code);
+ };
- var fail = function(evt) {
- console.log(error.code);
- };
-
entry.file(win, fail);
Read As Text
@@ -100,38 +100,38 @@ __Parameters:__
Quick Example
-------------
- function win(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("read success");
+ function win(file) {
+ var reader = new FileReader();
+ reader.onloadend = function (evt) {
+ console.log("read success");
console.log(evt.target.result);
};
- reader.readAsText(file);
- };
+ reader.readAsText(file);
+ };
+
+ var fail = function (evt) {
+ console.log(error.code);
+ };
- var fail = function(evt) {
- console.log(error.code);
- };
-
entry.file(win, fail);
Abort Quick Example
-------------------
- function win(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("read success");
+ function win(file) {
+ var reader = new FileReader();
+ reader.onloadend = function(evt) {
+ console.log("read success");
console.log(evt.target.result);
};
- reader.readAsText(file);
- reader.abort();
- };
+ reader.readAsText(file);
+ reader.abort();
+ };
function fail(error) {
- console.log(error.code);
+ console.log(error.code);
}
-
+
entry.file(win, fail);
Full Example
@@ -145,31 +145,31 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
function onLoad() {
document.addEventListener("deviceready", onDeviceReady, false);
}
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
+ }
+
+ function gotFS(fileSystem) {
+ fileSystem.root.getFile("readme.txt", null, gotFileEntry, fail);
}
-
- function gotFS(fileSystem) {
- fileSystem.root.getFile("readme.txt", null, gotFileEntry, fail);
- }
-
- function gotFileEntry(fileEntry) {
- fileEntry.file(gotFile, fail);
- }
-
+
+ function gotFileEntry(fileEntry) {
+ fileEntry.file(gotFile, fail);
+ }
+
function gotFile(file){
- readDataUrl(file);
- readAsText(file);
- }
-
+ readDataUrl(file);
+ readAsText(file);
+ }
+
function readDataUrl(file) {
var reader = new FileReader();
reader.onloadend = function(evt) {
@@ -178,7 +178,7 @@ Full Example
};
reader.readAsDataURL(file);
}
-
+
function readAsText(file) {
var reader = new FileReader();
reader.onloadend = function(evt) {
@@ -187,11 +187,11 @@ Full Example
};
reader.readAsText(file);
}
-
+
function fail(evt) {
console.log(evt.target.error.code);
}
-
+
</script>
</head>
<body>
@@ -216,20 +216,20 @@ __Parameters:__
Quick Example
-------------
- function win(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("read success");
+ function win(file) {
+ var reader = new FileReader();
+ reader.onloadend = function (evt) {
+ console.log("read success");
console.log(evt.target.result);
};
- reader.readAsBinaryString(file);
- };
+ reader.readAsBinaryString(file);
+ };
- var fail = function(evt) {
- console.log(error.code);
- };
-
- entry.file(win, fail);
+ var fail = function (evt) {
+ console.log(error.code);
+ };
+
+entry.file(win, fail);
Read As Array Buffer
--------------------
@@ -242,18 +242,17 @@ __Parameters:__
Quick Example
-------------
- function win(file) {
- var reader = new FileReader();
- reader.onloadend = function(evt) {
- console.log("read success");
+ function win(file) {
+ var reader = new FileReader();
+ reader.onloadend = function (evt) {
+ console.log("read success");
console.log(new Uint8Array(evt.target.result));
};
- reader.readAsArrayBuffer(file);
- };
+ reader.readAsArrayBuffer(file);
+ };
- var fail = function(evt) {
- console.log(error.code);
- };
-
- entry.file(win, fail);
+ var fail = function (evt) {
+ console.log(error.code);
+ };
+ entry.file(win, fail);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filesystem/filesystem.md b/docs/en/edge/cordova/file/filesystem/filesystem.md
index 4510d12..c8eaa2c 100644
--- a/docs/en/edge/cordova/file/filesystem/filesystem.md
+++ b/docs/en/edge/cordova/file/filesystem/filesystem.md
@@ -48,13 +48,13 @@ Supported Platforms
File System Quick Example
-------------------------
- function onSuccess(fileSystem) {
- console.log(fileSystem.name);
- console.log(fileSystem.root.name);
- }
-
- // request the persistent file system
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, null);
+ function onSuccess(fileSystem) {
+ console.log(fileSystem.name);
+ console.log(fileSystem.root.name);
+ }
+
+ // request the persistent file system
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, null);
Full Example
------------
@@ -67,25 +67,25 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
+ }
+
+ function onFileSystemSuccess(fileSystem) {
+ console.log(fileSystem.name);
+ console.log(fileSystem.root.name);
+ }
+
+ function fail(evt) {
+ console.log(evt.target.error.code);
}
- function onFileSystemSuccess(fileSystem) {
- console.log(fileSystem.name);
- console.log(fileSystem.root.name);
- }
-
- function fail(evt) {
- console.log(evt.target.error.code);
- }
-
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfer/filetransfer.md b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
index 46aca45..8230216 100644
--- a/docs/en/edge/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
@@ -70,33 +70,33 @@ __Parameters:__
- __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__
-
+
// !! Assumes variable fileURI contains a valid URI to a text file on the device
-
- var win = function(r) {
+
+ var win = function (r) {
console.log("Code = " + r.responseCode);
console.log("Response = " + r.response);
console.log("Sent = " + r.bytesSent);
- }
-
- var fail = function(error) {
+ }
+
+ var fail = function (error) {
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 ft = new FileTransfer();
+
+ 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 ft = new FileTransfer();
ft.upload(fileURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
__Full Example__
@@ -105,56 +105,57 @@ __Full Example__
<html>
<head>
<title>File Transfer Example</title>
-
+
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
+
+ // device APIs are available
//
function onDeviceReady() {
-
// Retrieve image file location from specified source
- navigator.camera.getPicture(uploadPhoto,
- function(message) { alert('get picture failed'); },
- { quality: 50,
- destinationType: navigator.camera.DestinationType.FILE_URI,
- sourceType: navigator.camera.PictureSourceType.PHOTOLIBRARY }
- );
-
+ navigator.camera.getPicture(
+ uploadPhoto,
+ function(message) { alert('get picture failed'); },
+ {
+ quality : 50,
+ destinationType : navigator.camera.DestinationType.FILE_URI,
+ sourceType : navigator.camera.PictureSourceType.PHOTOLIBRARY
+ }
+ );
}
-
+
function uploadPhoto(imageURI) {
var options = new FileUploadOptions();
options.fileKey="file";
options.fileName=imageURI.substr(imageURI.lastIndexOf('/')+1);
options.mimeType="image/jpeg";
-
+
var params = {};
params.value1 = "test";
params.value2 = "param";
-
+
options.params = params;
-
+
var ft = new FileTransfer();
ft.upload(imageURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
}
-
+
function win(r) {
console.log("Code = " + r.responseCode);
console.log("Response = " + r.response);
console.log("Sent = " + r.bytesSent);
}
-
+
function fail(error) {
alert("An error has occurred: Code = " + error.code);
console.log("upload error source " + error.source);
console.log("upload error target " + error.target);
}
-
+
</script>
</head>
<body>
@@ -172,24 +173,24 @@ Supported on Android and iOS
console.log("Response = " + r.response);
console.log("Sent = " + r.bytesSent);
}
-
+
function fail(error) {
alert("An error has occurred: Code = " + error.code);
console.log("upload error source " + error.source);
console.log("upload error target " + error.target);
}
-
+
var uri = encodeURI("http://some.server.com/upload.php");
-
+
var options = new FileUploadOptions();
options.fileKey="file";
options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
options.mimeType="text/plain";
-
+
var headers={'headerParam':'headerValue'};
-
+
options.headers = headers;
-
+
var ft = new FileTransfer();
ft.upload(fileURI, uri, win, fail, options);
@@ -201,7 +202,7 @@ to a Nginx server.
download
--------------
-__Parameters:__
+__Parameters:__
- __source__: URL of the server to download the file, as encoded by `encodeURI()`.
- __target__: Full path of the file on the device.
@@ -216,7 +217,7 @@ __Quick Example__
var fileTransfer = new FileTransfer();
var uri = encodeURI("http://some.server.com/download.php");
-
+
fileTransfer.download(
uri,
filePath,
@@ -247,33 +248,33 @@ __Supported Platforms__
- iOS
__Quick Example__
-
+
// !! Assumes variable fileURI contains a valid URI to a text file on the device
-
- var win = function(r) {
+
+ var win = function(r) {
console.log("Code = " + r.responseCode);
console.log("Response = " + r.response);
console.log("Sent = " + r.bytesSent);
- }
-
+ }
+
var fail = function(error) {
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 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 ft = new FileTransfer();
+ params.value1 = "test";
+ params.value2 = "param";
+
+ options.params = params;
+
+ var ft = new FileTransfer();
ft.upload(fileURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
ft.abort(win, fail);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filewriter/filewriter.md b/docs/en/edge/cordova/file/filewriter/filewriter.md
index d86ce86..75e275b 100644
--- a/docs/en/edge/cordova/file/filewriter/filewriter.md
+++ b/docs/en/edge/cordova/file/filewriter/filewriter.md
@@ -59,7 +59,7 @@ written many times. The `FileWriter` maintains the file's `position`
and `length` attributes, which allow the app to `seek` and `write`
anywhere in the file. By default, the `FileWriter` writes to the
beginning of the file, overwriting existing data. Set the optional
-`append` boolean to `true` in the `FileWriter`'s constructor to
+`append` boolean to `true` in the `FileWriter`'s constructor to
write to the end of the file.
Supported Platforms
@@ -74,78 +74,78 @@ Supported Platforms
Seek Quick Example
------------------------------
- function win(writer) {
- // fast forwards file pointer to end of file
- writer.seek(writer.length);
- };
+ function win(writer) {
+ // fast forwards file pointer to end of file
+ writer.seek(writer.length);
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
- var fail = function(evt) {
- console.log(error.code);
- };
-
entry.createWriter(win, fail);
Truncate Quick Example
--------------------------
- function win(writer) {
- writer.truncate(10);
- };
+ function win(writer) {
+ writer.truncate(10);
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
- var fail = function(evt) {
- console.log(error.code);
- };
-
entry.createWriter(win, fail);
Write Quick Example
--------------------
+-------------------
- function win(writer) {
- writer.onwrite = function(evt) {
- console.log("write success");
+ function win(writer) {
+ writer.onwrite = function(evt) {
+ console.log("write success");
};
- writer.write("some sample text");
- };
+ writer.write("some sample text");
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
- var fail = function(evt) {
- console.log(error.code);
- };
-
entry.createWriter(win, fail);
Append Quick Example
---------------------
+--------------------
- function win(writer) {
- writer.onwrite = function(evt) {
- console.log("write success");
- };
- writer.seek(writer.length);
- writer.write("appended text");
- };
+ function win(writer) {
+ writer.onwrite = function(evt) {
+ console.log("write success");
+ };
+ writer.seek(writer.length);
+ writer.write("appended text");
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
- var fail = function(evt) {
- console.log(error.code);
- };
-
entry.createWriter(win, fail);
-
+
Abort Quick Example
-------------------
- function win(writer) {
- writer.onwrite = function(evt) {
- console.log("write success");
+ function win(writer) {
+ writer.onwrite = function(evt) {
+ console.log("write success");
};
- writer.write("some sample text");
- writer.abort();
- };
-
- var fail = function(evt) {
- console.log(error.code);
- };
-
+ writer.write("some sample text");
+ writer.abort();
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
+
entry.createWriter(win, fail);
Full Example
@@ -154,28 +154,28 @@ Full Example
<html>
<head>
<title>FileWriter Example</title>
-
+
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
+
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
+
+ // device APIs are available
//
function onDeviceReady() {
window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
}
-
+
function gotFS(fileSystem) {
fileSystem.root.getFile("readme.txt", {create: true, exclusive: false}, gotFileEntry, fail);
}
-
+
function gotFileEntry(fileEntry) {
fileEntry.createWriter(gotFileWriter, fail);
}
-
+
function gotFileWriter(writer) {
writer.onwriteend = function(evt) {
console.log("contents of file now 'some sample text'");
@@ -191,11 +191,11 @@ Full Example
};
writer.write("some sample text");
}
-
+
function fail(error) {
console.log(error.code);
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
index 3578bb1..2b933c9 100644
--- a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
+++ b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
@@ -51,22 +51,22 @@ Supported Platforms
Request File System Quick Example
---------------------------------
- function onSuccess(fileSystem) {
- console.log(fileSystem.name);
- }
-
- // request the persistent file system
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);
+ function onSuccess(fileSystem) {
+ console.log(fileSystem.name);
+ }
+
+ // request the persistent file system
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);
Resolve Local File System URI Quick Example
-------------------------------------------
- function onSuccess(fileEntry) {
- console.log(fileEntry.name);
- }
+ function onSuccess(fileEntry) {
+ console.log(fileEntry.name);
+ }
+
+ window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
- window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
-
Full Example
------------
@@ -78,29 +78,29 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
- window.resolveLocalFileSystemURI("file:///example.txt", onResolveSuccess, fail);
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
+ window.resolveLocalFileSystemURI("file:///example.txt", onResolveSuccess, fail);
+ }
+
+ function onFileSystemSuccess(fileSystem) {
+ console.log(fileSystem.name);
+ }
+
+ function onResolveSuccess(fileEntry) {
+ console.log(fileEntry.name);
+ }
+
+ function fail(evt) {
+ console.log(evt.target.error.code);
}
- function onFileSystemSuccess(fileSystem) {
- console.log(fileSystem.name);
- }
-
- function onResolveSuccess(fileEntry) {
- console.log(fileEntry.name);
- }
-
- function fail(evt) {
- console.log(evt.target.error.code);
- }
-
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/metadata/metadata.md b/docs/en/edge/cordova/file/metadata/metadata.md
index 3c6ebdc..bfa3a46 100644
--- a/docs/en/edge/cordova/file/metadata/metadata.md
+++ b/docs/en/edge/cordova/file/metadata/metadata.md
@@ -46,9 +46,9 @@ Supported Platforms
Quick Example
-------------
- function win(metadata) {
- console.log("Last Modified: " + metadata.modificationTime);
- }
-
- // Request the metadata object for this entry
- entry.getMetadata(win, null);
+ function win(metadata) {
+ console.log("Last Modified: " + metadata.modificationTime);
+ }
+
+ // Request the metadata object for this entry
+ entry.getMetadata(win, null);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
index 201076a..b043130 100644
--- a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
+++ b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
@@ -85,30 +85,30 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Set an event to wait for Cordova to load
+ // wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is loaded and Ready
+ // device APIs are available
//
function onDeviceReady() {
navigator.geolocation.getCurrentPosition(onSuccess, onError);
}
-
+
// Display `Position` properties from the geolocation
//
function onSuccess(position) {
var div = document.getElementById('myDiv');
-
- div.innerHTML = 'Latitude: ' + position.coords.latitude + '<br/>' +
- 'Longitude: ' + position.coords.longitude + '<br/>' +
- 'Altitude: ' + position.coords.altitude + '<br/>' +
- 'Accuracy: ' + position.coords.accuracy + '<br/>' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br/>' +
- 'Heading: ' + position.coords.heading + '<br/>' +
- 'Speed: ' + position.coords.speed + '<br/>';
+
+ div.innerHTML = 'Latitude: ' + position.coords.latitude + '<br/>' +
+ 'Longitude: ' + position.coords.longitude + '<br/>' +
+ 'Altitude: ' + position.coords.altitude + '<br/>' +
+ 'Accuracy: ' + position.coords.accuracy + '<br/>' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br/>' +
+ 'Heading: ' + position.coords.heading + '<br/>' +
+ 'Speed: ' + position.coords.speed + '<br/>';
}
-
+
// Show an alert if there is a problem getting the geolocation
//
function onError() {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Position/position.md b/docs/en/edge/cordova/geolocation/Position/position.md
index e1db6ff..a69e8ca 100644
--- a/docs/en/edge/cordova/geolocation/Position/position.md
+++ b/docs/en/edge/cordova/geolocation/Position/position.md
@@ -81,36 +81,36 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
navigator.geolocation.getCurrentPosition(onSuccess, onError);
}
-
+
// onSuccess Geolocation
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
- element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
- 'Longitude: ' + position.coords.longitude + '<br />' +
- 'Altitude: ' + position.coords.altitude + '<br />' +
- 'Accuracy: ' + position.coords.accuracy + '<br />' +
- 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
- 'Heading: ' + position.coords.heading + '<br />' +
- 'Speed: ' + position.coords.speed + '<br />' +
- 'Timestamp: ' + position.timestamp + '<br />';
+ element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
+ 'Longitude: ' + position.coords.longitude + '<br />' +
+ 'Altitude: ' + position.coords.altitude + '<br />' +
+ 'Accuracy: ' + position.coords.accuracy + '<br />' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
+ 'Heading: ' + position.coords.heading + '<br />' +
+ 'Speed: ' + position.coords.speed + '<br />' +
+ 'Timestamp: ' + position.timestamp + '<br />';
}
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
</script>
</head>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md b/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
index a92da7c..a87d3a2 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
@@ -72,13 +72,13 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
var watchID = null;
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
// Get the most accurate position updates available on the
@@ -86,7 +86,7 @@ Full Example
var options = { enableHighAccuracy: true };
watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
}
-
+
// onSuccess Geolocation
//
function onSuccess(position) {
@@ -104,18 +104,18 @@ Full Example
watchID = null;
}
}
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
</script>
</head>
<body>
<p id="geolocation">Watching geolocation...</p>
- <button onclick="clearWatch();">Clear Watch</button>
+ <button onclick="clearWatch();">Clear Watch</button>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
index 51beb4a..5266c60 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -58,8 +58,8 @@ Quick Example
-------------
// onSuccess Callback
- // This method accepts a `Position` object, which contains
- // the current GPS coordinates
+ // This method accepts a Position object, which contains the
+ // current GPS coordinates
//
var onSuccess = function(position) {
alert('Latitude: ' + position.coords.latitude + '\n' +
@@ -92,16 +92,16 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
navigator.geolocation.getCurrentPosition(onSuccess, onError);
}
-
+
// onSuccess Geolocation
//
function onSuccess(position) {
@@ -115,12 +115,12 @@ Full Example
'Speed: ' + position.coords.speed + '<br />' +
'Timestamp: ' + position.timestamp + '<br />';
}
-
+
// onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
+ 'message: ' + error.message + '\n');
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
index 21877dc..a4c7053 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
@@ -96,20 +96,20 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- // Wait for Cordova to load
+ // Wait for device API libraries to load
//
document.addEventListener("deviceready", onDeviceReady, false);
var watchID = null;
- // Cordova is ready
+ // device APIs are available
//
function onDeviceReady() {
// Throw an error if no update is received every 30 seconds
var options = { timeout: 30000 };
watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
}
-
+
// onSuccess Geolocation
//
function onSuccess(position) {
@@ -118,13 +118,13 @@ Full Example
'Longitude: ' + position.coords.longitude + '<br />' +
'<hr />' + element.innerHTML;
}
-
- // onError Callback receives a PositionError object
- //
- function onError(error) {
- alert('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
- }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
</script>
</head>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
index 9916d7f..015510b 100644
--- a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
+++ b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -61,21 +61,21 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>GlobalizationError Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function successCallback(date) {
alert('month:' + date.month +
' day:' + date.day +
' year:' + date.year + '\n');
}
-
+
function errorCallback(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
};
-
+
function checkError() {
navigator.globalization.stringToDate(
'notADate',
@@ -84,7 +84,7 @@ Full Example
{selector:'foobar'}
);
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.dateToString.md b/docs/en/edge/cordova/globalization/globalization.dateToString.md
index 2a762c3..dceb57c 100644
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.md
@@ -59,10 +59,10 @@ dialog with text similar to `date: 9/25/2012 4:21PM` using the default
options:
navigator.globalization.dateToString(
- new Date(),
- function (date) {alert('date: ' + date.value + '\n');},
- function () {alert('Error getting dateString\n');},
- {formatLength:'short', selector:'date and time'}
+ new Date(),
+ function (date) { alert('date: ' + date.value + '\n'); },
+ function () { alert('Error getting dateString\n'); },
+ { formatLength: 'short', selector: 'date and time' }
);
Full Example
@@ -71,10 +71,10 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>dateToString Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkDateString() {
navigator.globalization.dateToString(
new Date(),
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
index 5b0cf93..f02f1e5 100644
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@ -60,14 +60,16 @@ currency is United States Dollars, this example displays a popup
dialog with text similar to the results that follow:
navigator.globalization.getCurrencyPattern(
- 'USD',
- function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
- 'code: ' + pattern.code + '\n' +
- 'fraction: ' + pattern.fraction + '\n' +
- 'rounding: ' + pattern.rounding + '\n' +
- 'decimal: ' + pattern.decimal + '\n' +
- 'grouping: ' + pattern.grouping);},
- function () {alert('Error getting pattern\n');}
+ 'USD',
+ function (pattern) {
+ alert('pattern: ' + pattern.pattern + '\n' +
+ 'code: ' + pattern.code + '\n' +
+ 'fraction: ' + pattern.fraction + '\n' +
+ 'rounding: ' + pattern.rounding + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
+ 'grouping: ' + pattern.grouping);
+ },
+ function () { alert('Error getting pattern\n'); }
);
Expected result:
@@ -85,23 +87,23 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>getCurrencyPattern Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkPattern() {
navigator.globalization.getCurrencyPattern(
'USD',
- function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
- 'code: ' + pattern.code + '\n' +
+ function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
+ 'code: ' + pattern.code + '\n' +
'fraction: ' + pattern.fraction + '\n' +
'rounding: ' + pattern.rounding + '\n' +
- 'decimal: ' + pattern.decimal + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
'grouping: ' + pattern.grouping);},
function () {alert('Error getting pattern\n');}
);
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDateNames.md b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
index 95a0abe..88d9a66 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -24,7 +24,7 @@ Returns an array of the names of the months or days of the week,
depending on the client's user preferences and calendar.
navigator.globalization.getDateNames(successCallback, errorCallback, options);
-
+
Description
-----------
@@ -61,13 +61,13 @@ a series of twelve popup dialogs, one per month, with text similar to
`month: January`:
navigator.globalization.getDateNames(
- function (names) {
- for (var i=0; i<names.value.length; i++) {
- alert('month: ' + names.value[i] + '\n');
- }
- },
- function () {alert('Error getting names\n');},
- {type:'wide', item:'months'}
+ function (names) {
+ for (var i = 0; i < names.value.length; i++) {
+ alert('month: ' + names.value[i] + '\n');
+ }
+ },
+ function () { alert('Error getting names\n'); },
+ { type: 'wide', item: 'months' }
);
Full Example
@@ -76,10 +76,10 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>getDateNames Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkDateNames() {
navigator.globalization.getDateNames(
function (names) {
@@ -91,7 +91,7 @@ Full Example
{type:'wide', item:'months'}
);
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
index 6e8da83..14ee0a6 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
@@ -24,7 +24,7 @@ Returns a pattern string to format and parse dates according to the
client's user preferences.
navigator.globalization.getDatePattern(successCallback, errorCallback, options);
-
+
Description
-----------
@@ -37,7 +37,7 @@ a parameter contains the following properties:
- __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`
-executes with a `GlobalizationError` object as a parameter. The
+executes with a `GlobalizationError` object as a parameter. The
error's expected code is `GlobalizationError.PATTERN\_ERROR`.
The `options` parameter is optional, and defaults to the following values:
@@ -63,11 +63,11 @@ When the browser is set to the `en\_US` locale, this example displays
a popup dialog with text such as `pattern: M/d/yyyy h:mm a`:
function checkDatePattern() {
- navigator.globalization.getDatePattern(
- function (date) {alert('pattern: ' + date.pattern + '\n');},
- function () {alert('Error getting pattern\n');},
- {formatLength:'short', selector:'date and time'}
- );
+ navigator.globalization.getDatePattern(
+ function (date) { alert('pattern: ' + date.pattern + '\n'); },
+ function () { alert('Error getting pattern\n'); },
+ { formatLength: 'short', selector: 'date and time' }
+ );
}
Full Example
@@ -76,10 +76,10 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>getDatePattern Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkDatePattern() {
navigator.globalization.getDatePattern(
function (date) {alert('pattern: ' + date.pattern + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
index 3e24523..cb095e9 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -24,7 +24,7 @@ Returns the first day of the week according to the client's user
preferences and calendar.
navigator.globalization.getFirstDayOfWeek(successCallback, errorCallback);
-
+
Description
-----------
@@ -52,8 +52,8 @@ When the browser is set to the `en\_US` locale, this displays a
popup dialog with text similar to `day: 1`.
navigator.globalization.getFirstDayOfWeek(
- function (day) {alert('day: ' + day.value + '\n');},
- function () {alert('Error getting day\n');}
+ function (day) {alert('day: ' + day.value + '\n');},
+ function () {alert('Error getting day\n');}
);
Full Example
@@ -62,17 +62,17 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>getFirstDayOfWeek Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkFirstDay() {
navigator.globalization.getFirstDayOfWeek(
function (day) {alert('day: ' + day.value + '\n');},
function () {alert('Error getting day\n');}
);
}
-
+
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
index 204a634..52a0226 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -24,7 +24,7 @@ Get the string identifier for the client's current locale setting.
navigator.globalization.getLocaleName(successCallback, errorCallback);
-
+
Description
-----------
@@ -51,8 +51,8 @@ When the browser is set to the `en\_US` locale, this displays a popup
dialog with the text `locale: en\_US`.
navigator.globalization.getLocaleName(
- function (locale) {alert('locale: ' + locale.value + '\n');},
- function () {alert('Error getting locale\n');}
+ function (locale) {alert('locale: ' + locale.value + '\n');},
+ function () {alert('Error getting locale\n');}
);
Full Example
@@ -61,10 +61,10 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>getLocaleName Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkLocale() {
navigator.globalization.getLocaleName(
function (locale) {alert('locale: ' + locale.value + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
index 0b59354..70f0027 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -23,7 +23,7 @@ globalization.getNumberPattern
Returns a pattern string to format and parse numbers according to the client's user preferences.
navigator.globalization.getNumberPattern(successCallback, errorCallback, options);
-
+
Description
-----------
@@ -64,16 +64,16 @@ When the browser is set to the `en\_US` locale, this should display a
popup dialog with text similar to the results that follow:
navigator.globalization.getNumberPattern(
- function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
- 'symbol: ' + pattern.symbol + '\n' +
- 'fraction: ' + pattern.fraction + '\n' +
- 'rounding: ' + pattern.rounding + '\n' +
- 'positive: ' + pattern.positive + '\n' +
- 'negative: ' + pattern.negative + '\n' +
- 'decimal: ' + pattern.decimal + '\n' +
- 'grouping: ' + pattern.grouping);},
- function () {alert('Error getting pattern\n');},
- {type:'decimal'}
+ function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
+ 'symbol: ' + pattern.symbol + '\n' +
+ 'fraction: ' + pattern.fraction + '\n' +
+ 'rounding: ' + pattern.rounding + '\n' +
+ 'positive: ' + pattern.positive + '\n' +
+ 'negative: ' + pattern.negative + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
+ 'grouping: ' + pattern.grouping);},
+ function () {alert('Error getting pattern\n');},
+ {type:'decimal'}
);
Results:
@@ -93,32 +93,32 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>getNumberPattern Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkPattern() {
navigator.globalization.getNumberPattern(
- function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
- 'symbol: ' + pattern.symbol + '\n' +
+ function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
+ 'symbol: ' + pattern.symbol + '\n' +
'fraction: ' + pattern.fraction + '\n' +
'rounding: ' + pattern.rounding + '\n' +
'positive: ' + pattern.positive + '\n' +
'negative: ' + pattern.negative + '\n' +
- 'decimal: ' + pattern.decimal + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
'grouping: ' + pattern.grouping);},
function () {alert('Error getting pattern\n');},
{type:'decimal'}
);
}
-
+
</script>
</head>
<body>
<button onclick="checkPattern()">Click for pattern</button>
</body>
</html>
-
+
Windows Phone 8 Quirks
----------------
- The `pattern` property is not supported, and retuens an empty string.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
index 64328f8..4e3b54b 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -24,7 +24,7 @@ Get the string identifier for the client's current language.
navigator.globalization.getPreferredLanguage(successCallback, errorCallback);
-
+
Description
-----------
@@ -51,8 +51,8 @@ When the browser is set to the `en\_US` locale, this should display a
popup dialog with the text `language: English`:
navigator.globalization.getPreferredLanguage(
- function (language) {alert('language: ' + language.value + '\n');},
- function () {alert('Error getting language\n');}
+ function (language) {alert('language: ' + language.value + '\n');},
+ function () {alert('Error getting language\n');}
);
Full Example
@@ -61,10 +61,10 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>getPreferredLanguage Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkLanguage() {
navigator.globalization.getPreferredLanguage(
function (language) {alert('language: ' + language.value + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
index 63156f0..e6d3f2f 100644
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -24,7 +24,7 @@ Indicates whether daylight savings time is in effect for a given date
using the client's time zone and calendar.
navigator.globalization.isDayLightSavingsTime(date, successCallback, errorCallback);
-
+
Description
-----------
@@ -55,9 +55,9 @@ timezone, this should display a popup dialog with text similar to
`dst: true`:
navigator.globalization.isDayLightSavingsTime(
- new Date(),
- function (date) {alert('dst: ' + date.dst + '\n');},
- function () {alert('Error getting names\n');}
+ new Date(),
+ function (date) {alert('dst: ' + date.dst + '\n');},
+ function () {alert('Error getting names\n');}
);
Full Example
@@ -66,10 +66,10 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>isDayLightSavingsTime Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkDayLightSavings() {
navigator.globalization.isDayLightSavingsTime(
new Date(),
@@ -77,11 +77,11 @@ Full Example
function () {alert('Error getting names\n');}
);
}
-
+
</script>
</head>
<body>
<button onclick="checkDayLightSavings()">Click for daylight savings</button>
</body>
</html>
-
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f98807e7/docs/en/edge/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.numberToString.md b/docs/en/edge/cordova/globalization/globalization.numberToString.md
index 070e42e..800955e 100644
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.numberToString.md
@@ -23,7 +23,7 @@ globalization.numberToString
Returns a number formatted as a string according to the client's user preferences.
navigator.globalization.numberToString(number, successCallback, errorCallback, options);
-
+
Description
-----------
@@ -56,10 +56,10 @@ When the browser is set to the `en\_US` locale, this displays a popup
dialog with text similar to `number: 3.142`:
navigator.globalization.numberToString(
- 3.1415926,
- function (number) {alert('number: ' + number.value + '\n');},
- function () {alert('Error getting number\n');},
- {type:'decimal'}
+ 3.1415926,
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
);
Full Example
@@ -68,10 +68,10 @@ Full Example
<!DOCTYPE HTML>
<html>
<head>
- <title>Cordova</title>
+ <title>numberToString Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
-
+
function checkNumber() {
navigator.globalization.numberToString(
3.1415926,
@@ -80,7 +80,7 @@ Full Example
{type:'decimal'}
);
}
-
+
</script>
</head>
<body>