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:51:00 UTC
[25/46] docs commit: to end of geoloc
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
-------------------