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:53 UTC
[18/46] edits up to menu button event
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>