You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/08/15 22:50:53 UTC
[3/3] docs commit: mark headings inline to make it easier to grep &
such
mark headings inline to make it easier to grep & such
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/76ef2fb7
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/76ef2fb7
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/76ef2fb7
Branch: refs/heads/master
Commit: 76ef2fb733d10997f9e6fef30286aee541a45418
Parents: d3ec7fe
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Aug 15 16:06:43 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Thu Aug 15 13:50:28 2013 -0700
----------------------------------------------------------------------
.../accelerometer/acceleration/acceleration.md | 18 ++--
.../accelerometer/accelerometer.clearWatch.md | 12 +--
.../accelerometer.getCurrentAcceleration.md | 18 ++--
.../edge/cordova/accelerometer/accelerometer.md | 12 +--
.../accelerometer.watchAcceleration.md | 18 ++--
.../parameters/accelerometerError.md | 3 +-
.../parameters/accelerometerOptions.md | 6 +-
.../parameters/accelerometerSuccess.md | 9 +-
docs/en/edge/cordova/camera/camera.cleanup.md | 12 +--
.../en/edge/cordova/camera/camera.getPicture.md | 28 +++----
docs/en/edge/cordova/camera/camera.md | 6 +-
.../camera/parameter/CameraPopoverHandle.md | 18 ++--
.../camera/parameter/CameraPopoverOptions.md | 9 +-
.../cordova/camera/parameter/cameraError.md | 6 +-
.../cordova/camera/parameter/cameraOptions.md | 21 ++---
.../cordova/camera/parameter/cameraSuccess.md | 9 +-
.../edge/cordova/compass/compass.clearWatch.md | 12 +--
.../cordova/compass/compass.clearWatchFilter.md | 3 +-
.../compass/compass.getCurrentHeading.md | 15 ++--
docs/en/edge/cordova/compass/compass.md | 9 +-
.../cordova/compass/compass.watchHeading.md | 18 ++--
.../compass/compass.watchHeadingFilter.md | 3 +-
.../compass/compassError/compassError.md | 13 ++-
.../cordova/compass/parameters/compassError.md | 6 +-
.../compass/parameters/compassHeading.md | 15 ++--
.../compass/parameters/compassOptions.md | 12 +--
.../compass/parameters/compassSuccess.md | 9 +-
docs/en/edge/cordova/connection/connection.md | 9 +-
.../edge/cordova/connection/connection.type.md | 27 ++----
.../en/edge/cordova/contacts/Contact/contact.md | 39 +++------
.../contacts/ContactAddress/contactaddress.md | 27 ++----
.../contacts/ContactError/contactError.md | 12 +--
.../contacts/ContactField/contactfield.md | 27 ++----
.../ContactFindOptions/contactfindoptions.md | 15 ++--
.../cordova/contacts/ContactName/contactname.md | 27 ++----
.../ContactOrganization/contactorganization.md | 27 ++----
.../en/edge/cordova/contacts/contacts.create.md | 15 ++--
docs/en/edge/cordova/contacts/contacts.find.md | 18 ++--
docs/en/edge/cordova/contacts/contacts.md | 12 +--
.../cordova/contacts/parameters/contactError.md | 3 +-
.../contacts/parameters/contactFields.md | 3 +-
.../contacts/parameters/contactFindOptions.md | 6 +-
.../contacts/parameters/contactSuccess.md | 9 +-
docs/en/edge/cordova/device/device.cordova.md | 15 ++--
docs/en/edge/cordova/device/device.md | 9 +-
docs/en/edge/cordova/device/device.model.md | 24 ++----
docs/en/edge/cordova/device/device.name.md | 24 ++----
docs/en/edge/cordova/device/device.platform.md | 21 ++---
docs/en/edge/cordova/device/device.uuid.md | 21 ++---
docs/en/edge/cordova/device/device.version.md | 12 +--
.../en/edge/cordova/events/events.backbutton.md | 15 ++--
.../cordova/events/events.batterycritical.md | 15 ++--
.../en/edge/cordova/events/events.batterylow.md | 15 ++--
.../edge/cordova/events/events.batterystatus.md | 18 ++--
.../edge/cordova/events/events.deviceready.md | 15 ++--
.../edge/cordova/events/events.endcallbutton.md | 15 ++--
docs/en/edge/cordova/events/events.md | 6 +-
.../en/edge/cordova/events/events.menubutton.md | 15 ++--
docs/en/edge/cordova/events/events.offline.md | 27 +++---
docs/en/edge/cordova/events/events.online.md | 26 +++---
docs/en/edge/cordova/events/events.pause.md | 18 ++--
docs/en/edge/cordova/events/events.resume.md | 18 ++--
.../edge/cordova/events/events.searchbutton.md | 15 ++--
.../cordova/events/events.startcallbutton.md | 15 ++--
.../cordova/events/events.volumedownbutton.md | 15 ++--
.../cordova/events/events.volumeupbutton.md | 15 ++--
.../file/directoryentry/directoryentry.md | 48 ++++-------
.../file/directoryreader/directoryreader.md | 12 +--
docs/en/edge/cordova/file/file.md | 6 +-
.../en/edge/cordova/file/fileentry/fileentry.md | 39 +++------
.../en/edge/cordova/file/fileerror/fileerror.md | 12 +--
docs/en/edge/cordova/file/fileobj/fileobj.md | 18 ++--
.../edge/cordova/file/filereader/filereader.md | 48 ++++-------
.../edge/cordova/file/filesystem/filesystem.md | 18 ++--
.../cordova/file/filetransfer/filetransfer.md | 27 ++----
.../file/filetransfererror/filetransfererror.md | 12 +--
.../file/fileuploadoptions/fileuploadoptions.md | 12 +--
.../file/fileuploadresult/fileuploadresult.md | 12 +--
.../edge/cordova/file/filewriter/filewriter.md | 37 +++------
docs/en/edge/cordova/file/flags/flags.md | 12 +--
.../file/localfilesystem/localfilesystem.md | 24 ++----
docs/en/edge/cordova/file/metadata/metadata.md | 15 ++--
.../geolocation/Coordinates/coordinates.md | 21 ++---
.../cordova/geolocation/Position/position.md | 18 ++--
.../geolocation/PositionError/positionError.md | 12 +--
.../geolocation/geolocation.clearWatch.md | 18 ++--
.../geolocation.getCurrentPosition.md | 18 ++--
docs/en/edge/cordova/geolocation/geolocation.md | 12 +--
.../geolocation/geolocation.watchPosition.md | 21 ++---
.../parameters/geolocation.options.md | 9 +-
.../geolocation/parameters/geolocationError.md | 6 +-
.../parameters/geolocationSuccess.md | 9 +-
.../GlobalizationError/globalizationerror.md | 18 ++--
.../globalization/globalization.dateToString.md | 18 ++--
.../globalization.getCurrencyPattern.md | 15 ++--
.../globalization/globalization.getDateNames.md | 15 ++--
.../globalization.getDatePattern.md | 18 ++--
.../globalization.getFirstDayOfWeek.md | 15 ++--
.../globalization.getLocaleName.md | 18 ++--
.../globalization.getNumberPattern.md | 18 ++--
.../globalization.getPreferredLanguage.md | 18 ++--
.../globalization.isDayLightSavingsTime.md | 15 ++--
.../edge/cordova/globalization/globalization.md | 12 +--
.../globalization.numberToString.md | 15 ++--
.../globalization/globalization.stringToDate.md | 18 ++--
.../globalization.stringToNumber.md | 15 ++--
.../edge/cordova/inappbrowser/inappbrowser.md | 87 +++++++-------------
.../en/edge/cordova/inappbrowser/window.open.md | 12 +--
.../edge/cordova/media/MediaError/mediaError.md | 12 +--
.../edge/cordova/media/Parameters/mediaError.md | 6 +-
docs/en/edge/cordova/media/capture/CaptureCB.md | 9 +-
.../edge/cordova/media/capture/CaptureError.md | 9 +-
.../cordova/media/capture/CaptureErrorCB.md | 9 +-
.../cordova/media/capture/ConfigurationData.md | 12 +--
.../media/capture/MediaFile.getFormatData.md | 18 ++--
docs/en/edge/cordova/media/capture/MediaFile.md | 9 +-
.../edge/cordova/media/capture/MediaFileData.md | 17 ++--
docs/en/edge/cordova/media/capture/capture.md | 21 ++---
.../edge/cordova/media/capture/captureAudio.md | 24 ++----
.../media/capture/captureAudioOptions.md | 18 ++--
.../edge/cordova/media/capture/captureImage.md | 18 ++--
.../media/capture/captureImageOptions.md | 12 +--
.../edge/cordova/media/capture/captureVideo.md | 18 ++--
.../media/capture/captureVideoOptions.md | 15 ++--
.../cordova/media/media.getCurrentPosition.md | 18 ++--
docs/en/edge/cordova/media/media.getDuration.md | 15 ++--
docs/en/edge/cordova/media/media.md | 18 ++--
docs/en/edge/cordova/media/media.pause.md | 15 ++--
docs/en/edge/cordova/media/media.play.md | 21 ++---
docs/en/edge/cordova/media/media.release.md | 15 ++--
docs/en/edge/cordova/media/media.seekTo.md | 21 ++---
docs/en/edge/cordova/media/media.setVolume.md | 18 ++--
docs/en/edge/cordova/media/media.startRecord.md | 27 ++----
docs/en/edge/cordova/media/media.stop.md | 15 ++--
docs/en/edge/cordova/media/media.stopRecord.md | 18 ++--
.../cordova/notification/notification.alert.md | 18 ++--
.../cordova/notification/notification.beep.md | 21 ++---
.../notification/notification.confirm.md | 21 ++---
.../edge/cordova/notification/notification.md | 6 +-
.../cordova/notification/notification.prompt.md | 21 ++---
.../notification/notification.vibrate.md | 15 ++--
.../cordova/splashscreen/splashscreen.hide.md | 18 ++--
.../edge/cordova/splashscreen/splashscreen.md | 9 +-
.../cordova/splashscreen/splashscreen.show.md | 15 ++--
.../edge/cordova/storage/database/database.md | 22 ++---
.../storage/localstorage/localstorage.md | 33 +++-----
.../cordova/storage/parameters/display_name.md | 3 +-
docs/en/edge/cordova/storage/parameters/name.md | 3 +-
docs/en/edge/cordova/storage/parameters/size.md | 3 +-
.../edge/cordova/storage/parameters/version.md | 3 +-
.../edge/cordova/storage/sqlerror/sqlerror.md | 12 +--
.../storage/sqlresultset/sqlresultset.md | 18 ++--
.../sqlresultsetrowlist/sqlresultsetrowlist.md | 21 ++---
.../storage/sqltransaction/sqltransaction.md | 18 ++--
docs/en/edge/cordova/storage/storage.md | 12 +--
.../cordova/storage/storage.opendatabase.md | 15 ++--
docs/en/edge/guide/platforms/win8/index.md | 2 +
157 files changed, 857 insertions(+), 1688 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 f5bbd6f..7717105 100644
--- a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
+++ b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
@@ -17,29 +17,25 @@
under the License.
---
-Acceleration
-============
+# Acceleration
Contains `Accelerometer` data captured at a specific point in time.
-Properties
-----------
+## 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)_
-Description
------------
+## Description
An `Acceleration` object is populated and returned by any of the API's
`Accelerometer` methods. Acceleration values include the effect of
gravity (9.81 m/s^2), so that when a device lies flat and facing up,
_x_, _y_, and _z_ values returned should be `0`, `0`, and `9.81`.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -48,8 +44,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
function onSuccess(acceleration) {
alert('Acceleration X: ' + acceleration.x + '\n' +
@@ -64,8 +59,7 @@ Quick Example
navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
index 638f894..10aa84a 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
@@ -17,8 +17,7 @@
under the License.
---
-accelerometer.clearWatch
-========================
+# accelerometer.clearWatch
Stop watching the `Acceleration` referenced by the `watchID` parameter.
@@ -26,8 +25,7 @@ Stop watching the `Acceleration` referenced by the `watchID` parameter.
- __watchID__: The ID returned by `accelerometer.watchAcceleration`.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -36,8 +34,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
@@ -45,8 +42,7 @@ Quick Example
navigator.accelerometer.clearWatch(watchID);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index c623b95..66055f3 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -17,15 +17,13 @@
under the License.
---
-accelerometer.getCurrentAcceleration
-====================================
+# accelerometer.getCurrentAcceleration
Get the current acceleration along the _x_, _y_, and _z_ axes.
navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
-Description
------------
+## Description
The accelerometer is a motion sensor that detects the change (_delta_)
in movement relative to the current device orientation, in three
@@ -34,8 +32,7 @@ dimensions along the _x_, _y_, and _z_ axis.
These acceleration values are returned to the `accelerometerSuccess`
callback function.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -44,8 +41,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
function onSuccess(acceleration) {
alert('Acceleration X: ' + acceleration.x + '\n' +
@@ -60,8 +56,7 @@ Quick Example
navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -104,8 +99,7 @@ Full Example
</body>
</html>
-iOS Quirks
--------------
+## iOS Quirks
- iOS doesn't recognize the concept of getting the current acceleration at any given point.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.md b/docs/en/edge/cordova/accelerometer/accelerometer.md
index 820a021..18363d1 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.md
@@ -17,27 +17,23 @@
under the License.
---
-Accelerometer
-=============
+# Accelerometer
> Captures device motion in the _x_, _y_, and _z_ direction.
-Methods
--------
+## Methods
- accelerometer.getCurrentAcceleration
- accelerometer.watchAcceleration
- accelerometer.clearWatch
-Arguments
----------
+## Arguments
- accelerometerSuccess
- accelerometerError
- accelerometerOptions
-Objects (Read-Only)
--------------------
+## Objects (Read-Only)
- Acceleration
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
index 102621b..e929828 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -17,8 +17,7 @@
under the License.
---
-accelerometer.watchAcceleration
-===============================
+# accelerometer.watchAcceleration
At a regular interval, get the acceleration along the _x_, _y_, and _z_ axis.
@@ -26,8 +25,7 @@ At a regular interval, get the acceleration along the _x_, _y_, and _z_ axis.
accelerometerError,
[accelerometerOptions]);
-Description
------------
+## Description
The accelerometer is a motion sensor that detects the change (delta)
in movement relative to the current position. The accelerometer can
@@ -43,8 +41,7 @@ The returned watch ID references the accelerometer's watch interval,
and can be used with `accelerometer.clearWatch` to stop watching the
accelerometer.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -53,8 +50,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
function onSuccess(acceleration) {
alert('Acceleration X: ' + acceleration.x + '\n' +
@@ -71,8 +67,7 @@ Quick Example
var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -137,8 +132,7 @@ Full Example
</body>
</html>
-iOS Quirks
--------------
+## iOS Quirks
The API calls the success callback function at the interval requested,
but restricts the range of requests to the device between 40ms and
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
index 5faf51e..6dda5c2 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
@@ -17,8 +17,7 @@
under the License.
---
-accelerometerError
-==================
+# accelerometerError
onError callback function for acceleration functions.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 303f73f..b9ebcb5 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
@@ -17,12 +17,10 @@
under the License.
---
-accelerometerOptions
-====================
+# accelerometerOptions
An optional parameter to customize the retrieval of accelerometer values.
-Options
--------
+## Options
- __frequency__: How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 d3542e9..c07a617 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
@@ -17,8 +17,7 @@
under the License.
---
-accelerometerSuccess
-====================
+# accelerometerSuccess
onSuccess callback function that provides the `Acceleration` information.
@@ -26,13 +25,11 @@ onSuccess callback function that provides the `Acceleration` information.
// Do something
}
-Parameters
-----------
+## Parameters
- __acceleration__: The acceleration at a single moment in time. (Acceleration)
-Example
--------
+## Example
function onSuccess(acceleration) {
alert('Acceleration X: ' + acceleration.x + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/camera/camera.cleanup.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.cleanup.md b/docs/en/edge/cordova/camera/camera.cleanup.md
index 00c299f..f195e70 100644
--- a/docs/en/edge/cordova/camera/camera.cleanup.md
+++ b/docs/en/edge/cordova/camera/camera.cleanup.md
@@ -17,29 +17,25 @@
under the License.
---
-camera.cleanup
-=================
+# camera.cleanup
Removes intermediate photos taken by the camera from temporary
storage.
navigator.camera.cleanup( cameraSuccess, cameraError );
-Description
------------
+## Description
Removes intermediate image files that are kept in temporary storage
after calling `camera.getPicture`. Applies only when the value of
`Camera.sourceType` equals `Camera.PictureSourceType.CAMERA` and the
`Camera.destinationType` equals `Camera.DestinationType.FILE_URI`.
-Supported Platforms
--------------------
+## Supported Platforms
- iOS
-Example
--------------
+## Example
navigator.camera.cleanup(onSuccess, onFail);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.getPicture.md b/docs/en/edge/cordova/camera/camera.getPicture.md
index 8e2f8cd..9cdc30c 100644
--- a/docs/en/edge/cordova/camera/camera.getPicture.md
+++ b/docs/en/edge/cordova/camera/camera.getPicture.md
@@ -17,8 +17,7 @@
under the License.
---
-camera.getPicture
-=================
+# camera.getPicture
Takes a photo using the camera, or retrieves a photo from the device's
image gallery. The image is passed to the success callback as a
@@ -28,8 +27,7 @@ reposition the file selection popover.
navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] );
-Description
------------
+## Description
The `camera.getPicture` function opens the device's default camera
application that allows users to snap pictures. This behavior occurs
@@ -67,8 +65,7 @@ quality, even if a `quality` parameter is specified. To avoid common
memory problems, set `Camera.destinationType` to `FILE_URI` rather
than `DATA_URL`.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -77,14 +74,13 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Android Quirks
------------------
+## Android Quirks
+
Android uses intents to launch the camera activity on the device to capture
images, and on phones with low memory, the Cordova activity may be killed. In this
scenario, the image may not appear when the cordova activity is restored.
-iOS Quirks
-----------
+## iOS Quirks
Including a JavaScript `alert()` in either of the callback functions
can cause problems. Wrap the alert within a `setTimeout()` to allow
@@ -95,21 +91,18 @@ displays:
// do your thing here!
}, 0);
-Windows Phone 7 Quirks
-----------------------
+## Windows Phone 7 Quirks
Invoking the native camera application while your device is connected
via Zune does not work, and triggers an error callback.
-Tizen Quirks
-----------------------
+## Tizen Quirks
Tizen only supports a `destinationType` of
`Camera.DestinationType.FILE_URI` and a `sourceType` of
`Camera.PictureSourceType.PHOTOLIBRARY`.
-Quick Example
--------------
+## Quick Example
Take a photo and retrieve it as a base64-encoded image:
@@ -140,8 +133,7 @@ Take a photo and retrieve the image's file location:
alert('Failed because: ' + message);
}
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.md b/docs/en/edge/cordova/camera/camera.md
index 6317d3d..908357b 100644
--- a/docs/en/edge/cordova/camera/camera.md
+++ b/docs/en/edge/cordova/camera/camera.md
@@ -17,8 +17,7 @@
under the License.
---
-Camera
-======
+# Camera
> The `camera` object provides access to the device's default camera application.
@@ -34,8 +33,7 @@ obtaining the user's permission (e.g., by presenting choices for
__OK__ and __No Thanks__). For more information, please see the
Privacy Guide.
-Methods
--------
+## Methods
- camera.getPicture
- camera.cleanup
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 c8e07d2..66ccbf6 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
@@ -17,23 +17,19 @@
under the License.
---
-CameraPopoverHandle
-===================
+# CameraPopoverHandle
A handle to the popover dialog created by `camera.getPicture`.
-Methods
--------
+## Methods
- __setPosition__: Set the position of the popover.
-Supported Platforms
--------------------
+## Supported Platforms
- iOS
-setPosition
------------
+## setPosition
Set the position of the popover.
@@ -41,14 +37,12 @@ __Parameters:__
- `cameraPopoverOptions`: the `CameraPopoverOptions` that specify the new position
-Quick Example
--------------
+## Quick Example
var cameraPopoverOptions = new CameraPopoverOptions(300, 300, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY);
cameraPopoverHandle.setPosition(cameraPopoverOptions);
-Full Example
-------------
+## Full Example
function onSuccess(imageData) {
// Do stuff with the image!
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 1f7893f..e5d2902 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
@@ -17,8 +17,7 @@
under the License.
---
-CameraPopoverOptions
-====================
+# CameraPopoverOptions
iOS-only parameters that specify the anchor element location and arrow
direction of the popover when selecting images from an iPad's library
@@ -31,8 +30,7 @@ or album.
arrowDir : Camera.PopoverArrowDirection.ARROW_ANY
};
-CameraPopoverOptions
---------------------
+## CameraPopoverOptions
- __x__: x pixel coordinate of screen element onto which to anchor the popover. _(Number)_
@@ -57,8 +55,7 @@ direction of the arrow and orientation of the screen. Make sure to
account for orientation changes when specifying the anchor element
location.
-Quick Example
--------------
+## Quick Example
var popover = new CameraPopoverOptions(300, 300, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY);
var options = {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 ddb5e01..33d1e32 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraError.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraError.md
@@ -17,8 +17,7 @@
under the License.
---
-cameraError
-===========
+# cameraError
onError callback function that provides an error message.
@@ -26,7 +25,6 @@ onError callback function that provides an error message.
// Show a helpful message
}
-Parameters
-----------
+## Parameters
- __message__: The message is provided by the device's native code. _(String)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 778bd8a..cbc593d 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
@@ -17,8 +17,7 @@
under the License.
---
-cameraOptions
-=============
+# cameraOptions
Optional parameters to customize the camera settings.
@@ -32,8 +31,7 @@ Optional parameters to customize the camera settings.
popoverOptions: CameraPopoverOptions,
saveToPhotoAlbum: false };
-Options
--------
+## Options
- __quality__: Quality of the saved image, expressed as a range of 0-100, where 100 is typically full resolution with no loss from file compression. _(Number)_ (Note that information about the camera's resolution is unavailable.)
@@ -87,15 +85,13 @@ Options
FRONT : 1 // Use the front-facing camera
};
-Android Quirks
---------------
+## Android Quirks
- Ignores the `allowEdit` parameter.
- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
-BlackBerry Quirks
------------------
+## BlackBerry Quirks
- Ignores the `quality` parameter.
@@ -113,22 +109,19 @@ BlackBerry Quirks
- Ignores the `cameraDirection` parameter.
-iOS Quirks
---------------
+## iOS Quirks
- Set `quality` below 50 to avoid memory errors on some devices.
- When using `destinationType.FILE_URI`, photos are saved in the application's temporary directory. You may delete the contents of this directory using the `navigator.fileMgr` APIs if storage space is a concern.
-Tizen Quirks
---------------
+## Tizen Quirks
- options not supported
- always returns a FILE URI
-Windows Phone 7 and 8 Quirks
---------------
+## Windows Phone 7 and 8 Quirks
- Ignores the `allowEdit` parameter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 995c019..89d7ece 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
@@ -17,8 +17,7 @@
under the License.
---
-cameraSuccess
-=============
+# cameraSuccess
onSuccess callback function that provides the image data.
@@ -26,13 +25,11 @@ onSuccess callback function that provides the image data.
// Do something with the image
}
-Parameters
-----------
+## Parameters
- __imageData__: Base64 encoding of the image data, _or_ the image file URI, depending on `cameraOptions` in effect. _(String)_
-Example
--------
+## Example
// Show image
//
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.clearWatch.md b/docs/en/edge/cordova/compass/compass.clearWatch.md
index 831ca87..cdb9310 100755
--- a/docs/en/edge/cordova/compass/compass.clearWatch.md
+++ b/docs/en/edge/cordova/compass/compass.clearWatch.md
@@ -17,8 +17,7 @@
under the License.
---
-compass.clearWatch
-========================
+# compass.clearWatch
Stop watching the compass referenced by the watch ID parameter.
@@ -26,8 +25,7 @@ Stop watching the compass referenced by the watch ID parameter.
- __watchID__: The ID returned by `compass.watchHeading`.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry 10
@@ -36,8 +34,7 @@ Supported Platforms
- Windows Phone 7 and 8 (if available in hardware)
- Windows 8
-Quick Example
--------------
+## Quick Example
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
@@ -45,8 +42,7 @@ Quick Example
navigator.compass.clearWatch(watchID);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.clearWatchFilter.md b/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
index 92b7c9c..3a0e58e 100644
--- a/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
+++ b/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
@@ -17,7 +17,6 @@
under the License.
---
-compass.clearWatchFilter
-========================
+# compass.clearWatchFilter
No longer supported as of 1.6. See `compass.clearWatch`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
index 9678c66..83ec36b 100755
--- a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
+++ b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
@@ -17,15 +17,13 @@
under the License.
---
-compass.getCurrentHeading
-=========================
+# compass.getCurrentHeading
Get the current compass heading.
navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
-Description
------------
+## Description
The compass is a sensor that detects the direction or heading that the
device is pointed, typically from the top of the device. It measures
@@ -34,8 +32,7 @@ the heading in degrees from 0 to 359.99, where 0 is north.
The compass heading information is returned via a `CompassHeading`
object using the `compassSuccess` callback function.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry 10
@@ -44,8 +41,7 @@ Supported Platforms
- Windows Phone 7 and 8 (if available in hardware)
- Windows 8
-Quick Example
--------------
+## Quick Example
function onSuccess(heading) {
alert('Heading: ' + heading.magneticHeading);
@@ -57,8 +53,7 @@ Quick Example
navigator.compass.getCurrentHeading(onSuccess, onError);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.md b/docs/en/edge/cordova/compass/compass.md
index fd59c2e..2b69c57 100755
--- a/docs/en/edge/cordova/compass/compass.md
+++ b/docs/en/edge/cordova/compass/compass.md
@@ -17,13 +17,11 @@
under the License.
---
-Compass
-=======
+# Compass
> Obtains the direction that the device is pointing.
-Methods
--------
+## Methods
- compass.getCurrentHeading
- compass.watchHeading
@@ -31,8 +29,7 @@ Methods
- compass.watchHeadingFilter (obsolete)
- compass.clearWatchFilter (obsolete)
-Arguments
----------
+## Arguments
- compassSuccess
- compassError
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeading.md b/docs/en/edge/cordova/compass/compass.watchHeading.md
index f88c82d..804dda3 100755
--- a/docs/en/edge/cordova/compass/compass.watchHeading.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeading.md
@@ -17,15 +17,13 @@
under the License.
---
-compass.watchHeading
-====================
+# compass.watchHeading
At a regular interval, get the compass heading in degrees.
var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
-Description
------------
+## Description
The compass is a sensor that detects the direction or heading that the
device is pointed. It measures the heading in degrees from 0 to
@@ -40,8 +38,7 @@ object.
The returned watch ID references the compass watch interval. The watch
ID can be used with `compass.clearWatch` to stop watching the compass.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry 10
@@ -50,8 +47,7 @@ Supported Platforms
- Windows Phone 7 and 8 (if available in hardware)
- Windows 8
-Quick Example
--------------
+## Quick Example
function onSuccess(heading) {
var element = document.getElementById('heading');
@@ -68,8 +64,7 @@ Quick Example
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -133,8 +128,7 @@ Full Example
</body>
</html>
-iOS Quirks
---------------
+## iOS Quirks
In iOS `compass.watchHeading` can also get the device's current
heading when it changes by a specified number of degrees. Each time
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md b/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
index f64c2c7..62483f3 100644
--- a/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
@@ -17,7 +17,6 @@
under the License.
---
-compass.watchHeadingFilter
-==========================
+# compass.watchHeadingFilter
No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 8e99d9f..c405431 100644
--- a/docs/en/edge/cordova/compass/compassError/compassError.md
+++ b/docs/en/edge/cordova/compass/compassError/compassError.md
@@ -17,23 +17,20 @@
under the License.
---
-CompassError
-==========
+# CompassError
A `CompassError` object is returned to the `compassError` callback function when an error occurs.
-Properties
-----------
+## Properties
- __code__: One of the predefined error codes listed below.
-Constants
----------
+## Constants
+
- `CompassError.COMPASS_INTERNAL_ERR`
- `CompassError.COMPASS_NOT_SUPPORTED`
-Description
------------
+## Description
When an error occurs, the `CompassError` object is passed as a
parameter to a `compassError` callback function.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassError.md b/docs/en/edge/cordova/compass/parameters/compassError.md
index 7a8fe49..59d68b7 100755
--- a/docs/en/edge/cordova/compass/parameters/compassError.md
+++ b/docs/en/edge/cordova/compass/parameters/compassError.md
@@ -17,13 +17,11 @@
under the License.
---
-compassError
-==========
+# compassError
onError callback function for compass functions.
-Example
--------
+## Example
function(CompassError) {
// Handle the error
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 bcf1c25..dc6be03 100644
--- a/docs/en/edge/cordova/compass/parameters/compassHeading.md
+++ b/docs/en/edge/cordova/compass/parameters/compassHeading.md
@@ -17,13 +17,11 @@
under the License.
---
-compassHeading
-==========
+# compassHeading
A `CompassHeading` object is returned to the `compassSuccess` callback function.
-Properties
-----------
+## Properties
- __magneticHeading__: The heading in degrees from 0-359.99 at a single moment in time. _(Number)_
@@ -33,20 +31,17 @@ Properties
- __timestamp__: The time at which this heading was determined. _(milliseconds)_
-Description
------------
+## Description
The `CompassHeading` object is returned to the `compassSuccess` callback function.
-Android Quirks
---------------
+## Android Quirks
- `trueHeading` is not supported, but reports the same value as `magneticHeading`
- `headingAccuracy` is always 0 because there is no difference between the `magneticHeading` and `trueHeading`.
-iOS Quirks
-----------
+## iOS Quirks
- `trueHeading` is only returned when location services are enabled via `navigator.geolocation.watchLocation()`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 75f4922..fe68c69 100755
--- a/docs/en/edge/cordova/compass/parameters/compassOptions.md
+++ b/docs/en/edge/cordova/compass/parameters/compassOptions.md
@@ -17,13 +17,11 @@
under the License.
---
-compassOptions
-==============
+# compassOptions
An optional parameter to customize the retrieval of the compass.
-Options
--------
+## Options
- __frequency__: How often to retrieve the compass heading in milliseconds. _(Number)_ (Default: 100)
@@ -34,12 +32,10 @@ ______________
- `filter` is not supported.
-Tizen Quirks
------------
+## Tizen Quirks
- `filter` is not supported.
-Windows Phone 7 and 8 Quirks
---------------
+## Windows Phone 7 and 8 Quirks
- `filter` is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 2e56f69..e814959 100644
--- a/docs/en/edge/cordova/compass/parameters/compassSuccess.md
+++ b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
@@ -17,8 +17,7 @@
under the License.
---
-compassSuccess
-==============
+# compassSuccess
onSuccess callback function that provides the compass heading information via a `compassHeading` object.
@@ -26,13 +25,11 @@ onSuccess callback function that provides the compass heading information via a
// Do something
}
-Parameters
-----------
+## Parameters
- __heading__: The heading information. _(compassHeading)_
-Example
--------
+## Example
function onSuccess(heading) {
alert('Heading: ' + heading.magneticHeading);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.md b/docs/en/edge/cordova/connection/connection.md
index f259d83..0d2d45c 100644
--- a/docs/en/edge/cordova/connection/connection.md
+++ b/docs/en/edge/cordova/connection/connection.md
@@ -17,18 +17,15 @@
under the License.
---
-Connection
-==========
+# Connection
> The `connection` object, exposed via `navigator.connection`, provides information about the device's cellular and wifi connection.
-Properties
-----------
+## Properties
- connection.type
-Constants
----------
+## Constants
- Connection.UNKNOWN
- Connection.ETHERNET
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.type.md b/docs/en/edge/cordova/connection/connection.type.md
index c6de634..166e95c 100644
--- a/docs/en/edge/cordova/connection/connection.type.md
+++ b/docs/en/edge/cordova/connection/connection.type.md
@@ -17,19 +17,16 @@
under the License.
---
-connection.type
-===================
+# connection.type
Checks the currently active network connection.
-Description
------------
+## Description
This property offers a fast way to determine the device's network
connection state, and type of connection.
-Supported Platforms
--------------------
+## Supported Platforms
- iOS
- Android
@@ -38,8 +35,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
function checkConnection() {
var networkState = navigator.connection.type;
@@ -59,8 +55,7 @@ Quick Example
checkConnection();
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -103,8 +98,7 @@ Full Example
</body>
</html>
-API Change
-----------
+## API Change
Until Cordova 2.3.0, the `Connection` object was accessed via
`navigator.network.connection`, after which it was changed to
@@ -112,22 +106,19 @@ Until Cordova 2.3.0, the `Connection` object was accessed via
available at its original location, but is deprecated and will
eventually be removed.
-iOS Quirks
-----------
+## iOS Quirks
- iOS cannot detect the type of cellular network connection.
- `navigator.connection.type` is set to `Connection.CELL` for all cellular data.
-Windows Phone Quirks
---------------------
+## Windows Phone Quirks
- When running in the emulator, always detects `navigator.connection.type` as `Connection.UNKNOWN`.
- Windows Phone cannot detect the type of cellular network connection.
- `navigator.connection.type` is set to `Connection.CELL` for all cellular data.
-Tizen Quirks
---------------------
+## Tizen Quirks
- Tizen can only detect a WiFi or cellular connection.
- `navigator.connection.type` is set to `Connection.CELL_2G` for all cellular data.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 9e953f4..e4ffa9e 100644
--- a/docs/en/edge/cordova/contacts/Contact/contact.md
+++ b/docs/en/edge/cordova/contacts/Contact/contact.md
@@ -17,13 +17,11 @@
under the License.
---
-Contact
-=======
+# Contact
Contains properties that describe a contact, such as a user's personal or business contact.
-Properties
-----------
+## Properties
- __id__: A globally unique identifier. _(DOMString)_
@@ -53,8 +51,7 @@ Properties
- __urls__: An array of web pages associated with the contact. _(ContactField[])_
-Methods
--------
+## Methods
- __clone__: Returns a new `Contact` object that is a deep copy of the calling object, with the `id` property set to `null`.
@@ -62,8 +59,7 @@ Methods
- __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists.
-Details
--------
+## Details
The `Contact` object represents a user's contact. Contacts can be
created, stored, or removed from the device contacts database.
@@ -74,8 +70,7 @@ __NOTE:__ Not all of the contact fields listed above are supported on
every device platform. Please check each platform's _Quirks_ section
for details.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -83,8 +78,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Save Quick Example
-------------------
+## Save Quick Example
function onSuccess(contact) {
alert("Save Success");
@@ -108,8 +102,7 @@ Save Quick Example
// save to device
contact.save(onSuccess,onError);
-Clone Quick Example
--------------------
+## Clone Quick Example
// clone the contact object
var clone = contact.clone();
@@ -117,8 +110,7 @@ Clone Quick Example
console.log("Original contact name = " + contact.name.givenName);
console.log("Cloned contact name = " + clone.name.givenName);
-Remove Quick Example
---------------------
+## Remove Quick Example
function onSuccess() {
alert("Removal Success");
@@ -131,8 +123,7 @@ Remove Quick Example
// remove the contact from the device
contact.remove(onSuccess,onError);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -203,13 +194,11 @@ Full Example
</body>
</html>
-Android 2.X Quirks
-------------------
+## Android 2.X Quirks
- __categories__: Not supported on Android 2.X devices, returning `null`.
-BlackBerry WebWorks (OS 5.0 and higher) Quirks
----------------------------------------------
+## BlackBerry WebWorks (OS 5.0 and higher) Quirks
- __id__: Supported. Assigned by the device when saving the contact.
@@ -233,8 +222,7 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
- __urls__: Partially supported. The first URL is stored in BlackBerry __webpage__ field.
-iOS Quirks
-----------
+## 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.
@@ -244,8 +232,7 @@ iOS Quirks
- __categories__: This property is currently not supported, returning `null`.
-Windows Phone 7 and 8 Quirks
------------
+## 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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 f60ae07..3a6ed6f 100644
--- a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
+++ b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
@@ -17,13 +17,11 @@
under the License.
---
-ContactAddress
-==============
+# ContactAddress
Contains address properties for a `Contact` object.
-Properties
-----------
+## Properties
- __pref__: Set to `true` if this `ContactAddress` contains the user's preferred value. _(boolean)_
@@ -41,15 +39,13 @@ Properties
- __country__: The country name. _(DOMString)_
-Details
--------
+## Details
The `ContactAddress` object stores the properties of a single address
of a contact. A `Contact` object may include more than one address in
a `ContactAddress[]` array.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -57,8 +53,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// display the address information for all contacts
@@ -87,8 +82,7 @@ Quick Example
var filter = ["displayName", "addresses"];
navigator.contacts.find(filter, onSuccess, onError, options);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -144,13 +138,11 @@ Full Example
</body>
</html>
-Android 2.X Quirks
-------------------
+## Android 2.X Quirks
- __pref__: Not supported, returning `false` on Android 2.X devices.
-BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
+## BlackBerry WebWorks (OS 5.0 and higher) Quirks
- __pref__: Not supported on BlackBerry devices, returning `false`.
@@ -168,8 +160,7 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
- __country__: Supported.
-iOS Quirks
-----------
+## iOS Quirks
- __pref__: Not supported on iOS devices, returning `false`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 8f17362..e6bc46b 100644
--- a/docs/en/edge/cordova/contacts/ContactError/contactError.md
+++ b/docs/en/edge/cordova/contacts/ContactError/contactError.md
@@ -17,18 +17,15 @@
under the License.
---
-ContactError
-========
+# ContactError
A `ContactError` object is passed to the `contactError` callback when an error occurs.
-Properties
-----------
+## Properties
- __code__: One of the predefined error codes listed below.
-Constants
----------
+## Constants
- `ContactError.UNKNOWN_ERROR`
- `ContactError.INVALID_ARGUMENT_ERROR`
@@ -38,8 +35,7 @@ Constants
- `ContactError.NOT_SUPPORTED_ERROR`
- `ContactError.PERMISSION_DENIED_ERROR`
-Description
------------
+## Description
The `ContactError` object is returned to the user through the
`contactError` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 6507146..b424f96 100644
--- a/docs/en/edge/cordova/contacts/ContactField/contactfield.md
+++ b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
@@ -17,15 +17,13 @@
under the License.
---
-ContactField
-============
+# ContactField
Supports generic fields in a `Contact` object. Some properties stored
as `ContactField` objects include email addresses, phone numbers, and
URLs.
-Properties
-----------
+## Properties
- __type__: A string that indicates what type of field this is, _home_ for example. _(DOMString)_
@@ -33,8 +31,7 @@ Properties
- __pref__: Set to `true` if this `ContactField` contains the user's preferred value. _(boolean)_
-Details
--------
+## Details
The `ContactField` object is a reusable component that represents
contact fields generically. Each `ContactField` object contains a
@@ -52,8 +49,7 @@ __url__ when the __value__ attribute contains a URL to the photo
image, or _base64_ when the __value__ contains a base64-encoded image
string.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -61,8 +57,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// create a new contact
var contact = navigator.contacts.create();
@@ -77,8 +72,7 @@ Quick Example
// save the contact
contact.save();
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -143,13 +137,11 @@ Full Example
</body>
</html>
-Android Quirks
---------------
+## Android Quirks
- __pref__: Not supported, returning `false`.
-BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
+## BlackBerry WebWorks (OS 5.0 and higher) Quirks
- __type__: Partially supported. Used for phone numbers.
@@ -157,8 +149,7 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
- __pref__: Not supported, returning `false`.
-iOS Quirks
------------
+## iOS Quirks
- __pref__: Not supported, returning `false`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 4ea4a24..6593092 100644
--- a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -17,20 +17,17 @@
under the License.
---
-ContactFindOptions
-==================
+# ContactFindOptions
Contains properties that can be used to filter the results of a `contacts.find` operation.
-Properties
-----------
+## Properties
- __filter__: The search string used to find contacts. _(DOMString)_ (Default: `""`)
- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: `false`)
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -38,8 +35,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// success callback
function onSuccess(contacts) {
@@ -62,8 +58,7 @@ Quick Example
// find contacts
navigator.contacts.find(filter, onSuccess, onError, options);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 9dc6c70..131abc9 100644
--- a/docs/en/edge/cordova/contacts/ContactName/contactname.md
+++ b/docs/en/edge/cordova/contacts/ContactName/contactname.md
@@ -17,13 +17,11 @@
under the License.
---
-ContactName
-===========
+# ContactName
Contains different kinds of information about a `Contact` object's name.
-Properties
-----------
+## Properties
- __formatted__: The complete name of the contact. _(DOMString)_
@@ -37,13 +35,11 @@ Properties
- __honorificSuffix__: The contact's suffix (example _Esq._). _(DOMString)_
-Details
--------
+## Details
The `ContactName` object stores a contact's name properties.
-Supported Platforms
--------------------
+## Supported Platforms
- Android 2.X
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -51,8 +47,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
function onSuccess(contacts) {
for (var i = 0; i < contacts.length; i++) {
@@ -74,8 +69,7 @@ Quick Example
filter = ["displayName", "name"];
navigator.contacts.find(filter, onSuccess, onError, options);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -125,13 +119,11 @@ Full Example
</body>
</html>
-Android Quirks
-------------
+## Android Quirks
- __formatted__: Partially supported, and read-only. Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
-BlackBerry WebWorks (OS 5.0 and higher) Quirks
----------------------------------------------
+## BlackBerry WebWorks (OS 5.0 and higher) Quirks
- __formatted__: Partially supported. Returns a concatenation of BlackBerry __firstName__ and __lastName__ fields.
@@ -145,8 +137,7 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
- __honorificSuffix__: Not supported, returning `null`.
-iOS Quirks
-------------
+## iOS Quirks
- __formatted__: Partially supported. Returns iOS Composite Name, but is read-only.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 76f7b86..4e9b4a5 100644
--- a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
+++ b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
@@ -17,13 +17,11 @@
under the License.
---
-ContactOrganization
-===================
+# ContactOrganization
Contains a `Contact` object's organization properties.
-Properties
-----------
+## Properties
- __pref__: Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_
@@ -35,15 +33,13 @@ Properties
- __title__: The contact's title at the organization. _(DOMString)_
-Details
--------
+## Details
The `ContactOrganization` object stores a contact's organization
properties. A `Contact` object stores one or more
`ContactOrganization` objects in an array.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -51,8 +47,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
function onSuccess(contacts) {
for (var i = 0; i < contacts.length; i++) {
@@ -75,8 +70,7 @@ Quick Example
filter = ["displayName", "organizations"];
navigator.contacts.find(filter, onSuccess, onError, options);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -127,13 +121,11 @@ Full Example
</body>
</html>
-Android 2.X Quirks
-------------------
+## Android 2.X Quirks
- __pref__: Not supported by Android 2.X devices, returning `false`.
-BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
+## BlackBerry WebWorks (OS 5.0 and higher) Quirks
- __pref__: Not supported by BlackBerry devices, returning `false`.
@@ -145,8 +137,7 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
- __title__: Partially supported. The first organization title is stored in the BlackBerry __jobTitle__ field.
-iOS Quirks
------------
+## iOS Quirks
- __pref__: Not supported on iOS devices, returning `false`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.create.md b/docs/en/edge/cordova/contacts/contacts.create.md
index aab67d3..e9eb766 100644
--- a/docs/en/edge/cordova/contacts/contacts.create.md
+++ b/docs/en/edge/cordova/contacts/contacts.create.md
@@ -17,36 +17,31 @@
under the License.
---
-contacts.create
-===============
+# contacts.create
Returns a new Contact object.
var contact = navigator.contacts.create(properties);
-Description
------------
+## Description
The `contacts.create` method is synchronous, and returns a new `Contact` object.
This method does not retain the Contact object in the device contacts
database, for which you need to invoke the `Contact.save` method.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
- Windows Phone 7 and 8
-Quick Example
--------------
+## Quick Example
var myContact = navigator.contacts.create({"displayName": "Test User"});
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 ed0129e..c115070 100644
--- a/docs/en/edge/cordova/contacts/contacts.find.md
+++ b/docs/en/edge/cordova/contacts/contacts.find.md
@@ -17,16 +17,14 @@
under the License.
---
-contacts.find
-=============
+# contacts.find
Queries the device contacts database and returns one or more `Contact`
objects, each containing the fields specified.
navigator.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions);
-Description
------------
+## Description
The `contacts.find` method executes asynchronously, querying the
device contacts database and returning an array of `Contact` objects.
@@ -46,8 +44,7 @@ case-insensitive, partial value match is applied to each field
specified in the __contactFields__ parameter. If there's a match for
_any_ of the specified fields, the contact is returned.
-Parameters
-----------
+## Parameters
- __contactFields__: Contact fields to use as a search qualifier. The resulting `Contact` object only features values for these fields. _(DOMString[])_ [Required]
@@ -57,8 +54,7 @@ Parameters
- __contactFindOptions__: Search options to filter contacts. [Optional]
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -66,8 +62,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
function onSuccess(contacts) {
alert('Found ' + contacts.length + ' contacts.');
@@ -84,8 +79,7 @@ Quick Example
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.md b/docs/en/edge/cordova/contacts/contacts.md
index 578e577..bdb471b 100644
--- a/docs/en/edge/cordova/contacts/contacts.md
+++ b/docs/en/edge/cordova/contacts/contacts.md
@@ -17,8 +17,7 @@
under the License.
---
-Contacts
-========
+# Contacts
> The `contacts` object provides access to the device contacts database.
@@ -39,22 +38,19 @@ clear and easy-to-understand user experience surrounding the use of
contact data will help avoid user confusion and perceived misuse of
contact data. For more information, please see the Privacy Guide.
-Methods
--------
+## Methods
- contacts.create
- contacts.find
-Arguments
----------
+## Arguments
- contactFields
- contactSuccess
- contactError
- contactFindOptions
-Objects
--------
+## Objects
- Contact
- ContactName
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/contacts/parameters/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactError.md b/docs/en/edge/cordova/contacts/parameters/contactError.md
index 5c451b1..11ee57d 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactError.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactError.md
@@ -17,8 +17,7 @@
under the License.
---
-contactError
-============
+# contactError
Error callback function for contact functions.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactFields.md b/docs/en/edge/cordova/contacts/parameters/contactFields.md
index d3b5988..e2da390 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactFields.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactFields.md
@@ -17,8 +17,7 @@
under the License.
---
-contactFields
-=============
+# contactFields
Required parameter for the `contacts.find` method, used to specify which fields should be included in the `Contact` objects resulting from a find operation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 65ef9d7..fb7e79c 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
@@ -17,8 +17,7 @@
under the License.
---
-contactFindOptions
-==================
+# contactFindOptions
Optional parameter of the `contacts.find` method, used to filter the
contacts returned from the contacts database.
@@ -28,8 +27,7 @@ contacts returned from the contacts database.
multiple: true,
};
-Options
--------
+## Options
- __filter__: The search string used to filter contacts. _(DOMString)_ (Default: `""`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 694bb8b..543f5e3 100644
--- a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
+++ b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
@@ -17,8 +17,7 @@
under the License.
---
-contactSuccess
-==============
+# contactSuccess
Success callback function that provides the `Contact` array resulting from a `contacts.find` operation.
@@ -26,13 +25,11 @@ Success callback function that provides the `Contact` array resulting from a `co
// Do something
}
-Parameters
-----------
+## Parameters
- __contacts__: The contact array resulting from a find operation. _(Contact)_
-Example
--------
+## Example
function contactSuccess(contacts) {
for (var i=0; i<contacts.length; i++) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.cordova.md b/docs/en/edge/cordova/device/device.cordova.md
index 81fc2d4..4c367da 100644
--- a/docs/en/edge/cordova/device/device.cordova.md
+++ b/docs/en/edge/cordova/device/device.cordova.md
@@ -17,20 +17,17 @@
under the License.
---
-device.cordova
-===============
+# device.cordova
Get the version of Cordova running on the device.
var string = device.cordova;
-Description
------------
+## Description
`device.cordova` returns the version of Cordova running on the device.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -39,13 +36,11 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
var name = device.cordova;
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/device/device.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.md b/docs/en/edge/cordova/device/device.md
index 0c9e5f0..603f03e 100644
--- a/docs/en/edge/cordova/device/device.md
+++ b/docs/en/edge/cordova/device/device.md
@@ -17,13 +17,11 @@
under the License.
---
-Device
-======
+# Device
> The `device` object describes the device's hardware and software.
-Properties
-----------
+## Properties
- device.name
- device.cordova
@@ -32,8 +30,7 @@ Properties
- device.version
- device.model
-Variable Scope
---------------
+## Variable Scope
Since `device` is assigned to the `window` object, it is implicitly in the global scope.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/device/device.model.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.model.md b/docs/en/edge/cordova/device/device.model.md
index 6073fa4..8d0564d 100644
--- a/docs/en/edge/cordova/device/device.model.md
+++ b/docs/en/edge/cordova/device/device.model.md
@@ -17,22 +17,19 @@
under the License.
---
-device.model
-===========
+# device.model
Get the device's model name.
var string = device.model;
-Description
------------
+## Description
The `device.model` returns the name of the device's model or
product. The value is set by the device manufacturer and may be
different across versions of the same product.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -41,8 +38,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// Android: Nexus One returns "Passion" (Nexus One code name)
// Motorola Droid returns "voles"
@@ -51,8 +47,7 @@ Quick Example
//
var model = device.model;
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -85,17 +80,14 @@ Full Example
</body>
</html>
-Android Quirks
---------------
+## Android Quirks
- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL), which is often the production code name. For example, the Nexus One returns `Passion`, and Motorola Droid returns `voles`.
-Tizen Quirks
------------
+## Tizen Quirks
- Returns the device model assigned by the vendor, for example, `TIZEN`
-Windows Phone 7 and 8 Quirks
--------------
+## Windows Phone 7 and 8 Quirks
- Returns the device model specified by the manufacturer. For example, the Samsung Focus returns `SGH-i917`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.name.md b/docs/en/edge/cordova/device/device.name.md
index 73a9fe4..0b475ea 100644
--- a/docs/en/edge/cordova/device/device.name.md
+++ b/docs/en/edge/cordova/device/device.name.md
@@ -17,8 +17,7 @@
under the License.
---
-device.name
-===========
+# device.name
__WARNING:__ `device.name` is deprecated as of version 2.3.0. Use `device.model` instead.
@@ -26,15 +25,13 @@ Get the device's model name.
var string = device.name;
-Description
------------
+## Description
`device.name` returns the name of the device's model or product. This
value is set by the device manufacturer and may be different across
versions of the same product.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -43,8 +40,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// Android: Nexus One returns "Passion" (Nexus One code name)
// Motorola Droid returns "voles"
@@ -53,8 +49,7 @@ Quick Example
//
var name = device.name;
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -87,17 +82,14 @@ Full Example
</body>
</html>
-Android Quirks
---------------
+## Android Quirks
- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL), which is often the production code name. For example, the Nexus One returns `Passion`, and Motorola Droid returns `voles`.
-Windows Phone 7 and 8 Quirks
--------------
+## Windows Phone 7 and 8 Quirks
- Returns the device model specified by the manufacturer. For example, the Samsung Focus returns `SGH-i917`.
-Tizen Quirks
------------
+## Tizen Quirks
- Returns the device model assigned by the vendor, for example, `TIZEN`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.platform.md b/docs/en/edge/cordova/device/device.platform.md
index 6fa44b0..7e1da43 100644
--- a/docs/en/edge/cordova/device/device.platform.md
+++ b/docs/en/edge/cordova/device/device.platform.md
@@ -17,15 +17,13 @@
under the License.
---
-device.platform
-===============
+# device.platform
Get the device's operating system name.
var string = device.platform;
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -34,8 +32,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// Depending on the device, a few examples are:
// - "Android"
@@ -45,8 +42,7 @@ Quick Example
// - "Tizen"
var devicePlatform = device.platform;
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -78,19 +74,16 @@ Full Example
</body>
</html>
-BlackBerry Quirks
------------------
+## BlackBerry Quirks
Devices may return the device platform version number instead of the
platform name. For example, the Storm2 9550 returns a value such as
`2.13.0.95`.
-Windows Phone 7 Quirks
------------------
+## Windows Phone 7 Quirks
Windows Phone 7 devices report the platform as `WinCE`.
-Windows Phone 8 Quirks
------------------
+## Windows Phone 8 Quirks
Windows Phone 8 devices report the platform as `Win32NT`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 ab56ac6..c4e87bf 100644
--- a/docs/en/edge/cordova/device/device.uuid.md
+++ b/docs/en/edge/cordova/device/device.uuid.md
@@ -17,20 +17,17 @@
under the License.
---
-device.uuid
-===========
+# device.uuid
Get the device's Universally Unique Identifier ([UUID](http://en.wikipedia.org/wiki/Universally_Unique_Identifier)).
var string = device.uuid;
-Description
------------
+## Description
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
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -39,8 +36,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// Android: Returns a random 64-bit integer (as a string, again!)
// The integer is generated on the device's first boot
@@ -58,8 +54,7 @@ Quick Example
// unique to every GSM and UMTS mobile phone.
var deviceID = device.uuid;
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -91,8 +86,7 @@ Full Example
</body>
</html>
-iOS Quirk
--------------
+## iOS Quirk
The `uuid` on iOS is not unique to a device, but varies for each
application, for each installation. It changes if you delete and
@@ -100,8 +94,7 @@ 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
--------------
+## Windows Phone 7 and 8 Quirks
The `uuid` for Windows Phone 7 requires the permission
`ID_CAP_IDENTITY_DEVICE`. Microsoft will likely deprecate this
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 ab2db88..bac629d 100644
--- a/docs/en/edge/cordova/device/device.version.md
+++ b/docs/en/edge/cordova/device/device.version.md
@@ -17,15 +17,13 @@
under the License.
---
-device.version
-==============
+# device.version
Get the operating system version.
var string = device.version;
-Supported Platforms
--------------------
+## Supported Platforms
- Android 2.1+
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -34,8 +32,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// Android: Froyo OS would return "2.2"
// Eclair OS would return "2.1", "2.0.1", or "2.0"
@@ -49,8 +46,7 @@ Quick Example
// Tizen: returns "TIZEN_20120425_2"
var deviceVersion = device.version;
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 346ef95..b2e0fc3 100644
--- a/docs/en/edge/cordova/events/events.backbutton.md
+++ b/docs/en/edge/cordova/events/events.backbutton.md
@@ -17,15 +17,13 @@
under the License.
---
-backbutton
-===========
+# backbutton
The event fires when the user presses the back button.
document.addEventListener("backbutton", yourCallbackFunction, false);
-Details
--------
+## Details
To override the default back-button behavior, register an event
listener for the `backbutton` event, typically by calling
@@ -33,15 +31,13 @@ listener for the `backbutton` event, typically by calling
It is no longer necessary to call any other method to override the
back-button behavior.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- Windows Phone 7 and 8
-Quick Example
--------------
+## Quick Example
document.addEventListener("backbutton", onBackKeyDown, false);
@@ -49,8 +45,7 @@ Quick Example
// Handle the back button
}
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 c229ec0..150e9b9 100644
--- a/docs/en/edge/cordova/events/events.batterycritical.md
+++ b/docs/en/edge/cordova/events/events.batterycritical.md
@@ -17,16 +17,14 @@
under the License.
---
-batterycritical
-===========
+# batterycritical
The event fires when the battery has reached the critical level
threshold.
window.addEventListener("batterycritical", yourCallbackFunction, false);
-Details
--------
+## Details
The event fires when the percentage of battery charge has reached the
critical battery threshold. The value is device-specific.
@@ -41,16 +39,14 @@ properties:
Applications typically should use `window.addEventListener` to attach
an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- iOS
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- Tizen
-Quick Example
--------------
+## Quick Example
window.addEventListener("batterycritical", onBatteryCritical, false);
@@ -59,8 +55,7 @@ Quick Example
alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
}
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 24af3b6..5e16ea9 100644
--- a/docs/en/edge/cordova/events/events.batterylow.md
+++ b/docs/en/edge/cordova/events/events.batterylow.md
@@ -17,15 +17,13 @@
under the License.
---
-batterylow
-===========
+# batterylow
The event fires when the battery has reached the low level threshold.
window.addEventListener("batterylow", yourCallbackFunction, false);
-Details
--------
+## Details
The event fires when the percentage of battery charge has reached the
low battery threshold, device-specific value.
@@ -40,16 +38,14 @@ properties:
Applications typically should use `document.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- iOS
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- Tizen
-Quick Example
--------------
+## Quick Example
window.addEventListener("batterylow", onBatteryLow, false);
@@ -58,8 +54,7 @@ Quick Example
alert("Battery Level Low " + info.level + "%");
}
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 2d38a20..8b7c4ef 100644
--- a/docs/en/edge/cordova/events/events.batterystatus.md
+++ b/docs/en/edge/cordova/events/events.batterystatus.md
@@ -17,15 +17,13 @@
under the License.
---
-batterystatus
-===========
+# batterystatus
The event fires when there is a change in the battery status.
window.addEventListener("batterystatus", yourCallbackFunction, false);
-Details
--------
+## Details
This event fires when the percentage of battery charge changes by at
least 1 percent, or if the device is plugged in or unplugged.
@@ -40,8 +38,7 @@ properties:
Applications typically should use `window.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- iOS
- Android
@@ -49,15 +46,13 @@ Supported Platforms
- Windows Phone 7 and 8
- Tizen
-Windows Phone 7 and 8 Quirks
-----------------------
+## Windows Phone 7 and 8 Quirks
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
--------------
+## Quick Example
window.addEventListener("batterystatus", onBatteryStatus, false);
@@ -66,8 +61,7 @@ Quick Example
console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
}
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>