You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/09/11 06:40:51 UTC
[07/51] [partial] docs commit: Reverting autolinking change because
of inconsistencies.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/acceleration/acceleration.md b/www/docs/en/1.8.1/cordova/accelerometer/acceleration/acceleration.md
index fe40b82..75d3aad 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/acceleration/acceleration.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/acceleration/acceleration.md
@@ -21,7 +21,7 @@ license: >
Acceleration
============
-Contains `<a href="../accelerometer.html">Accelerometer</a>` data captured at a specific point in time.
+Contains `Accelerometer` data captured at a specific point in time.
Properties
----------
@@ -34,7 +34,7 @@ Properties
Description
-----------
-This object is created and populated by Cordova, and returned by an `<a href="../accelerometer.html">Accelerometer</a>` method. The x, y, z acceleration values include the effect of gravity (9.81 m/s^2), so at when a device is lying flat on a table facing up, the value returned should be x=0, y=0, z=9.81.
+This object is created and populated by Cordova, and returned by an `Accelerometer` method. The x, y, z acceleration values include the effect of gravity (9.81 m/s^2), so at when a device is lying flat on a table facing up, the value returned should be x=0, y=0, z=9.81.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(acceleration) {
@@ -60,27 +60,27 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
alert('onError!');
};
- navigator.<a href="../accelerometer.getCurrentAcceleration.html">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title>Acceleration <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Acceleration Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- navigator.<a href="../accelerometer.getCurrentAcceleration.html">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
+ function onDeviceReady() {
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
}
// onSuccess: Get a snapshot of the current acceleration
@@ -101,7 +101,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <h1>Example</h1>
<p>getCurrentAcceleration</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.clearWatch.md b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.clearWatch.md
index 0fb6817..e57c4aa 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.clearWatch.md
@@ -21,11 +21,11 @@ license: >
accelerometer.clearWatch
========================
-Stop watching the `<a href="acceleration/acceleration.html">Acceleration</a>` referenced by the watch ID parameter.
+Stop watching the `Acceleration` referenced by the watch ID parameter.
navigator.accelerometer.clearWatch(watchID);
-- __watchID__: The ID returned by `accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>`.
+- __watchID__: The ID returned by `accelerometer.watchAcceleration`.
Supported Platforms
-------------------
@@ -36,36 +36,36 @@ Supported Platforms
- Windows Phone 7 (Mango)
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
- var watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
+ var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
// ... later on ...
navigator.accelerometer.clearWatch(watchID);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Acceleration Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // The watch id references the current `watch<a href="acceleration/acceleration.html">Acceleration</a>`
+ // The watch id references the current `watchAcceleration`
var watchID = null;
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -76,7 +76,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
+ watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
}
// Stop watching the acceleration
@@ -92,9 +92,9 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = '<a href="acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '<br />' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '<br />' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '<br />' +
+ element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
+ 'Acceleration Y: ' + acceleration.y + '<br />' +
+ 'Acceleration Z: ' + acceleration.z + '<br />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index bdda006..57d2988 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -18,19 +18,19 @@ license: >
under the License.
---
-accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>
+accelerometer.getCurrentAcceleration
====================================
Get the current acceleration along the x, y, and z axis.
- navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>, <a href="parameters/accelerometerError.html">accelerometerError</a>);
+ navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
Description
-----------
The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation. The accelerometer can detect 3D movement along the x, y, and z axis.
-The acceleration is returned using the `<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>` callback function.
+The acceleration is returned using the `accelerometerSuccess` callback function.
Supported Platforms
-------------------
@@ -41,13 +41,13 @@ Supported Platforms
- Windows Phone 7 (Mango)
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(acceleration) {
- alert('<a href="acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
@@ -55,35 +55,35 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
alert('onError!');
};
- navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError);
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Acceleration Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
- navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError);
+ function onDeviceReady() {
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
}
// onSuccess: Get a snapshot of the current acceleration
//
function onSuccess(acceleration) {
- alert('<a href="acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
}
@@ -96,8 +96,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
- <p>getCurrent<a href="acceleration/acceleration.html">Acceleration</a></p>
+ <h1>Example</h1>
+ <p>getCurrentAcceleration</p>
</body>
</html>
@@ -106,4 +106,4 @@ iPhone Quirks
- iPhone doesn't have the concept of getting the current acceleration at any given point.
- You must watch the acceleration and capture the data at given time intervals.
-- Thus, the `getCurrent<a href="acceleration/acceleration.html">Acceleration</a>` function will give you the last value reported from a Cordova `watch<a href="accelerometer.html">Accelerometer</a>` call.
+- Thus, the `getCurrentAcceleration` function will give you the last value reported from a Cordova `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.md b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.md
index f7c4802..5aec54d 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.md
@@ -21,26 +21,26 @@ license: >
Accelerometer
=============
-> <a href="../media/capture/capture.html">Capture</a>s device motion in the x, y, and z direction.
+> Captures device motion in the x, y, and z direction.
Methods
-------
-- accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>
-- accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>
-- <a href="accelerometer.clearWatch.html">accelerometer.clearWatch</a>
+- accelerometer.getCurrentAcceleration
+- accelerometer.watchAcceleration
+- accelerometer.clearWatch
Arguments
---------
-- <a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>
-- <a href="parameters/accelerometerError.html">accelerometerError</a>
-- <a href="parameters/accelerometerOptions.html">accelerometerOptions</a>
+- accelerometerSuccess
+- accelerometerError
+- accelerometerOptions
Objects (Read-Only)
-------------------
-- <a href="acceleration/acceleration.html">Acceleration</a>
+- Acceleration
Permissions
-----------
@@ -68,7 +68,7 @@ Permissions
### iOS
-#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
+#### App/Supporting Files/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.watchAcceleration.md b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.watchAcceleration.md
index aa3a13c..dbf6fa3 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -18,23 +18,23 @@ license: >
under the License.
---
-accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>
+accelerometer.watchAcceleration
===============================
At a regular interval, get the acceleration along the x, y, and z axis.
- var watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>,
- <a href="parameters/accelerometerError.html">accelerometerError</a>,
- [<a href="parameters/accelerometerOptions.html">accelerometerOptions</a>]);
+ var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
+ accelerometerError,
+ [accelerometerOptions]);
Description
-----------
The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current position. The accelerometer can detect 3D movement along the x, y, and z axis.
-The `accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>` gets the device's current acceleration at a regular interval. Each time the `<a href="acceleration/acceleration.html">Acceleration</a>` is retrieved, the `<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object.
+The `accelerometer.watchAcceleration` gets the device's current acceleration at a regular interval. Each time the `Acceleration` is retrieved, the `accelerometerSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object.
-The returned watch ID references references the accelerometer watch interval. The watch ID can be used with `<a href="accelerometer.clearWatch.html">accelerometer.clearWatch</a>` to stop watching the accelerometer.
+The returned watch ID references references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer.
Supported Platforms
-------------------
@@ -46,13 +46,13 @@ Supported Platforms
- Bada 1.2 & 2.x
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(acceleration) {
- alert('<a href="acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
@@ -62,29 +62,29 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
var options = { frequency: 3000 }; // Update every 3 seconds
- var watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
+ var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Acceleration Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // The watch id references the current `watch<a href="acceleration/acceleration.html">Acceleration</a>`
+ // The watch id references the current `watchAcceleration`
var watchID = null;
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -95,14 +95,14 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
+ watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
}
// Stop watching the acceleration
//
function stopWatch() {
if (watchID) {
- navigator.<a href="accelerometer.clearWatch.html">accelerometer.clearWatch</a>(watchID);
+ navigator.accelerometer.clearWatch(watchID);
watchID = null;
}
}
@@ -111,9 +111,9 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = '<a href="acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '<br />' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '<br />' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '<br />' +
+ element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
+ 'Acceleration Y: ' + acceleration.y + '<br />' +
+ 'Acceleration Z: ' + acceleration.z + '<br />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerOptions.md b/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerOptions.md
index d105d2d..86fb292 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerOptions.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerOptions.md
@@ -26,4 +26,4 @@ An optional parameter to customize the retrieval of the accelerometer.
Options
-------
-- __frequency:__ How often to retrieve the `<a href="../acceleration/acceleration.html">Acceleration</a>` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
+- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerSuccess.md b/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerSuccess.md
index 5f448d2..67166dc 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerSuccess.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerSuccess.md
@@ -21,7 +21,7 @@ license: >
accelerometerSuccess
====================
-onSuccess callback function that provides the <a href="../acceleration/acceleration.html">Acceleration</a> information.
+onSuccess callback function that provides the Acceleration information.
function(acceleration) {
// Do something
@@ -30,14 +30,14 @@ onSuccess callback function that provides the <a href="../acceleration/accelerat
Parameters
----------
-- __acceleration:__ The acceleration at a single moment in time. (<a href="../acceleration/acceleration.html">Acceleration</a>)
+- __acceleration:__ The acceleration at a single moment in time. (Acceleration)
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
function onSuccess(acceleration) {
- alert('<a href="../acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="../acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="../acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/camera/camera.getPicture.md b/www/docs/en/1.8.1/cordova/camera/camera.getPicture.md
index 22f30c3..9e07e8d 100644
--- a/www/docs/en/1.8.1/cordova/camera/camera.getPicture.md
+++ b/www/docs/en/1.8.1/cordova/camera/camera.getPicture.md
@@ -23,16 +23,16 @@ camera.getPicture
Takes a photo using the camera or retrieves a photo from the device's album. The image is returned as a base64 encoded `String` or as the URI of an image file.
- navigator.camera.getPicture( <a href="parameter/cameraSuccess.html">cameraSuccess</a>, <a href="parameter/cameraError.html">cameraError</a>, [ <a href="parameter/cameraOptions.html">cameraOptions</a> ] );
+ navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] );
Description
-----------
-Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `<a href="camera.html">Camera</a>.sourceType = <a href="camera.html">Camera</a>.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
+Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `Camera.sourceType = Camera.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
-If `<a href="camera.html">Camera</a>.sourceType = <a href="camera.html">Camera</a>.PictureSourceType.PHOTOLIBRARY` or `<a href="camera.html">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected.
+If `Camera.sourceType = Camera.PictureSourceType.PHOTOLIBRARY` or `Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected.
-The return value will be sent to the `<a href="parameter/cameraSuccess.html">cameraSuccess</a>` function, in one of the following formats, depending on the `<a href="parameter/cameraOptions.html">cameraOptions</a>` you specify:
+The return value will be sent to the `cameraSuccess` function, in one of the following formats, depending on the `cameraOptions` you specify:
- A `String` containing the Base64 encoded photo image.
- A `String` representing the image file location on local storage (default).
@@ -40,10 +40,10 @@ The return value will be sent to the `<a href="parameter/cameraSuccess.html">cam
You can do whatever you want with the encoded image or URI, for example:
- Render the image in an `<img>` tag _(see example below)_
-- Save the data locally (`Local<a href="../storage/storage.html">Storage</a>`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
+- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
- Post the data to a remote server
-Note: The image quality of pictures taken using the camera on newer devices is quite good, and images from the Photo Album will not be downscaled to a lower quality, even if a quality parameter is specified. _Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800)._ Therefore, using FILE_URI as the '<a href="camera.html">Camera</a>.destinationType' is highly recommended.
+Note: The image quality of pictures taken using the camera on newer devices is quite good, and images from the Photo Album will not be downscaled to a lower quality, even if a quality parameter is specified. _Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800)._ Therefore, using FILE_URI as the 'Camera.destinationType' is highly recommended.
Supported Platforms
-------------------
@@ -66,13 +66,13 @@ Windows Phone 7 Quirks
Invoking the native camera application while your device is connected
via Zune will not work, and the error callback will be triggered.
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
Take photo and retrieve Base64-encoded image:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: <a href="camera.html">Camera</a>.DestinationType.DATA_URL
+ destinationType: Camera.DestinationType.DATA_URL
});
function onSuccess(imageData) {
@@ -87,7 +87,7 @@ Take photo and retrieve Base64-encoded image:
Take photo and retrieve image file location:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: <a href="camera.html">Camera</a>.DestinationType.FILE_URI });
+ destinationType: Camera.DestinationType.FILE_URI });
function onSuccess(imageURI) {
var image = document.getElementById('myImage');
@@ -99,13 +99,13 @@ Take photo and retrieve image file location:
}
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../media/capture/capture.html">Capture</a> Photo</title>
+ <title>Capture Photo</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -115,11 +115,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for Cordova to connect with the device
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>",on<a href="../device/device.html">Device</a>Ready,false);
+ document.addEventListener("deviceready",onDeviceReady,false);
// Cordova is ready to be used!
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
pictureSource=navigator.camera.PictureSourceType;
destinationType=navigator.camera.DestinationType;
}
@@ -198,8 +198,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <button onclick="capturePhoto();"><a href="../media/capture/capture.html">Capture</a> Photo</button> <br>
- <button onclick="capturePhotoEdit();"><a href="../media/capture/capture.html">Capture</a> Editable Photo</button> <br>
+ <button onclick="capturePhoto();">Capture Photo</button> <br>
+ <button onclick="capturePhotoEdit();">Capture Editable Photo</button> <br>
<button onclick="getPhoto(pictureSource.PHOTOLIBRARY);">From Photo Library</button><br>
<button onclick="getPhoto(pictureSource.SAVEDPHOTOALBUM);">From Photo Album</button><br>
<img style="display:none;width:60px;height:60px;" id="smallImage" src="" />
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/camera/camera.md b/www/docs/en/1.8.1/cordova/camera/camera.md
index fdafec0..db122ab 100644
--- a/www/docs/en/1.8.1/cordova/camera/camera.md
+++ b/www/docs/en/1.8.1/cordova/camera/camera.md
@@ -26,7 +26,7 @@ Camera
Methods
-------
-- <a href="camera.getPicture.html">camera.getPicture</a>
+- camera.getPicture
Permissions
-----------
@@ -68,7 +68,7 @@ Permissions
### iOS
-#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
+#### App/Supporting Files/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/camera/parameter/CameraPopoverOptions.md b/www/docs/en/1.8.1/cordova/camera/parameter/CameraPopoverOptions.md
index 2efd55b..06bfea9 100644
--- a/www/docs/en/1.8.1/cordova/camera/parameter/CameraPopoverOptions.md
+++ b/www/docs/en/1.8.1/cordova/camera/parameter/CameraPopoverOptions.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="../camera.html">Camera</a>PopoverOptions
+CameraPopoverOptions
====================
Parameters only used by iOS to specify the anchor element location and arrow direction of popover used on iPad when selecting images from the library or album.
@@ -27,10 +27,10 @@ Parameters only used by iOS to specify the anchor element location and arrow dir
y : 32,
width : 320,
height : 480,
- arrowDir : <a href="../camera.html">Camera</a>.PopoverArrowDirection.ARROW_ANY
+ arrowDir : Camera.PopoverArrowDirection.ARROW_ANY
};
-<a href="../camera.html">Camera</a>PopoverOptions
+CameraPopoverOptions
--------------------
- __x:__ x pixel coordinate of element on the screen to anchor popover onto. (`Number`)
@@ -41,9 +41,9 @@ Parameters only used by iOS to specify the anchor element location and arrow dir
- __height:__ height, in pixels, of the element on the screen to anchor popover onto. (`Number`)
-- __arrowDir:__ Direction the arrow on the popover should point. Defined in <a href="../camera.html">Camera</a>.PopoverArrowDirection (`Number`)
+- __arrowDir:__ Direction the arrow on the popover should point. Defined in Camera.PopoverArrowDirection (`Number`)
- <a href="../camera.html">Camera</a>.PopoverArrowDirection = {
+ Camera.PopoverArrowDirection = {
ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants
ARROW_DOWN : 2,
ARROW_LEFT : 4,
@@ -53,13 +53,13 @@ Parameters only used by iOS to specify the anchor element location and arrow dir
Note that the size of the popover may change to adjust to the direction of the arrow and orientation of the screen. Make sure to account for orientation changes when specifying the anchor element location.
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
- var popover = new <a href="../camera.html">Camera</a>PopoverOptions(300,300,100,100,<a href="../camera.html">Camera</a>.PopoverArrowDirection.ARROW_ANY);
- var options = { quality: 50, destinationType: <a href="../camera.html">Camera</a>.DestinationType.DATA_URL,sourceType: <a href="../camera.html">Camera</a>.PictureSource.SAVEDPHOTOALBUM, popoverOptions : popover };
+ var popover = new CameraPopoverOptions(300,300,100,100,Camera.PopoverArrowDirection.ARROW_ANY);
+ var options = { quality: 50, destinationType: Camera.DestinationType.DATA_URL,sourceType: Camera.PictureSource.SAVEDPHOTOALBUM, popoverOptions : popover };
- navigator.<a href="../camera.getPicture.html">camera.getPicture</a>(onSuccess, onFail, options);
+ navigator.camera.getPicture(onSuccess, onFail, options);
function onSuccess(imageData) {
var image = document.getElementById('myImage');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/camera/parameter/cameraOptions.md b/www/docs/en/1.8.1/cordova/camera/parameter/cameraOptions.md
index 0ddcfda..e216e7d 100644
--- a/www/docs/en/1.8.1/cordova/camera/parameter/cameraOptions.md
+++ b/www/docs/en/1.8.1/cordova/camera/parameter/cameraOptions.md
@@ -24,13 +24,13 @@ cameraOptions
Optional parameters to customize the camera settings.
{ quality : 75,
- destinationType : <a href="../camera.html">Camera</a>.DestinationType.DATA_URL,
- sourceType : <a href="../camera.html">Camera</a>.PictureSourceType.CAMERA,
+ destinationType : Camera.DestinationType.DATA_URL,
+ sourceType : Camera.PictureSourceType.CAMERA,
allowEdit : true,
- encodingType: <a href="../camera.html">Camera</a>.EncodingType.JPEG,
+ encodingType: Camera.EncodingType.JPEG,
targetWidth: 100,
targetHeight: 100,
- popoverOptions: <a href="../camera.html">Camera</a>PopoverOptions };
+ popoverOptions: CameraPopoverOptions };
Options
-------
@@ -39,14 +39,14 @@ Options
- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`)
- <a href="../camera.html">Camera</a>.DestinationType = {
+ Camera.DestinationType = {
DATA_URL : 0, // Return image as base64 encoded string
FILE_URI : 1 // Return image file URI
};
- __sourceType:__ Set the source of the picture. Defined in nagivator.camera.PictureSourceType (`Number`)
- <a href="../camera.html">Camera</a>.PictureSourceType = {
+ Camera.PictureSourceType = {
PHOTOLIBRARY : 0,
CAMERA : 1,
SAVEDPHOTOALBUM : 2
@@ -56,7 +56,7 @@ Options
- __encodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`)
- <a href="../camera.html">Camera</a>.EncodingType = {
+ Camera.EncodingType = {
JPEG : 0, // Return JPEG encoded image
PNG : 1 // Return PNG encoded image
};
@@ -64,9 +64,9 @@ Options
- __targetWidth:__ Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained. (`Number`)
- __targetHeight:__ Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (`Number`)
-- __mediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.<a href="../../media/media.html">Media</a>Type (`Number`)
+- __mediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (`Number`)
- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type = {
+ Camera.MediaType = {
PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
ALLMEDIA : 2 // allow selection from all media types
@@ -74,14 +74,14 @@ Options
- __correctOrientation:__ Rotate the image to correct for the orientation of the device during capture. (`Boolean`)
- __saveToPhotoAlbum:__ Save the image to the photo album on the device after capture. (`Boolean`)
-- __popoverOptions:__ iOS only options to specify popover location in iPad. Defined in <a href="../camera.html">Camera</a>PopoverOptions
+- __popoverOptions:__ iOS only options to specify popover location in iPad. Defined in CameraPopoverOptions
Android Quirks
--------------
- Ignores the `allowEdit` parameter.
-- <a href="../camera.html">Camera</a>.PictureSourceType.PHOTOLIBRARY and <a href="../camera.html">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
-- <a href="../camera.html">Camera</a>.EncodingType is not supported.
+- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
+- Camera.EncodingType is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
@@ -91,9 +91,9 @@ BlackBerry Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Application must have key injection permissions to close native <a href="../camera.html">Camera</a> application after photo is taken.
+- Application must have key injection permissions to close native Camera application after photo is taken.
- Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).
-- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
+- Camera.MediaType is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
@@ -103,7 +103,7 @@ webOS Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
+- Camera.MediaType is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/camera/parameter/cameraSuccess.md b/www/docs/en/1.8.1/cordova/camera/parameter/cameraSuccess.md
index 6083130..ec04795 100644
--- a/www/docs/en/1.8.1/cordova/camera/parameter/cameraSuccess.md
+++ b/www/docs/en/1.8.1/cordova/camera/parameter/cameraSuccess.md
@@ -30,9 +30,9 @@ onSuccess callback function that provides the image data.
Parameters
----------
-- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `<a href="cameraOptions.html">cameraOptions</a>` used. (`String`)
+- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `cameraOptions` used. (`String`)
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
// Show image
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.clearWatch.md b/www/docs/en/1.8.1/cordova/compass/compass.clearWatch.md
index bdc64fe..8cee616 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.clearWatch.md
+++ b/www/docs/en/1.8.1/cordova/compass/compass.clearWatch.md
@@ -25,7 +25,7 @@ Stop watching the compass referenced by the watch ID parameter.
navigator.compass.clearWatch(watchID);
-- __watchID__: The ID returned by `<a href="compass.watchHeading.html">compass.watchHeading</a>`.
+- __watchID__: The ID returned by `compass.watchHeading`.
Supported Platforms
-------------------
@@ -36,22 +36,22 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
- var watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
+ var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
// ... later on ...
navigator.compass.clearWatch(watchID);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Compass Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -61,11 +61,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -76,7 +76,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Update compass every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
+ watchID = navigator.compass.watchHeading(onSuccess, onError, options);
}
// Stop watching the compass
@@ -97,8 +97,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the heading
//
- function onError(<a href="parameters/compassError.html">compassError</a>) {
- alert('<a href="compass.html">Compass</a> error: ' + <a href="parameters/compassError.html">compassError</a>.code);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.clearWatchFilter.md b/www/docs/en/1.8.1/cordova/compass/compass.clearWatchFilter.md
index 9cf3e19..276c11f 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.clearWatchFilter.md
+++ b/www/docs/en/1.8.1/cordova/compass/compass.clearWatchFilter.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="compass.clearWatch.html">compass.clearWatch</a>Filter
+compass.clearWatchFilter
========================
-No longer supported as of 1.6. See `<a href="compass.clearWatch.html">compass.clearWatch</a>`.
\ No newline at end of file
+No longer supported as of 1.6. See `compass.clearWatch`.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.getCurrentHeading.md b/www/docs/en/1.8.1/cordova/compass/compass.getCurrentHeading.md
index 51c97ee..26e4f99 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.getCurrentHeading.md
+++ b/www/docs/en/1.8.1/cordova/compass/compass.getCurrentHeading.md
@@ -23,14 +23,14 @@ compass.getCurrentHeading
Get the current compass heading.
- navigator.compass.getCurrentHeading(<a href="parameters/compassSuccess.html">compassSuccess</a>, <a href="parameters/compassError.html">compassError</a>, <a href="parameters/compassOptions.html">compassOptions</a>);
+ navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
Description
-----------
The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
-The compass heading information is returned via a <a href="compass.html">Compass</a>Heading object using the `<a href="parameters/compassSuccess.html">compassSuccess</a>` callback function.
+The compass heading information is returned via a CompassHeading object using the `compassSuccess` callback function.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(heading) {
@@ -49,29 +49,29 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
};
function onError(error) {
- alert('<a href="<a href="parameters/compassError.html">compassError</a>/<a href="parameters/compassError.html">compassError</a>.html"><a href="compass.html">Compass</a>Error</a>: ' + error.code);
+ alert('CompassError: ' + error.code);
};
navigator.compass.getCurrentHeading(onSuccess, onError);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Compass Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
navigator.compass.getCurrentHeading(onSuccess, onError);
}
@@ -83,14 +83,14 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the heading
//
- function onError(<a href="parameters/compassError.html">compassError</a>) {
- alert('<a href="compass.html">Compass</a> Error: ' + <a href="parameters/compassError.html">compassError</a>.code);
+ function onError(compassError) {
+ alert('Compass Error: ' + compassError.code);
}
</script>
</head>
<body>
- <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
+ <h1>Example</h1>
<p>getCurrentHeading</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.md b/www/docs/en/1.8.1/cordova/compass/compass.md
index 3e0651e..c560ffd 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.md
+++ b/www/docs/en/1.8.1/cordova/compass/compass.md
@@ -26,19 +26,19 @@ Compass
Methods
-------
-- <a href="compass.getCurrentHeading.html">compass.getCurrentHeading</a>
-- <a href="compass.watchHeading.html">compass.watchHeading</a>
-- <a href="compass.clearWatch.html">compass.clearWatch</a>
-- <a href="<a href="compass.watchHeading.html">compass.watchHeading</a>Filter.html"><a href="compass.watchHeading.html">compass.watchHeading</a>Filter</a> (obsolete)
-- <a href="<a href="compass.clearWatch.html">compass.clearWatch</a>Filter.html"><a href="compass.clearWatch.html">compass.clearWatch</a>Filter</a> (obsolete)
+- compass.getCurrentHeading
+- compass.watchHeading
+- compass.clearWatch
+- compass.watchHeadingFilter (obsolete)
+- compass.clearWatchFilter (obsolete)
Arguments
---------
-- <a href="parameters/compassSuccess.html">compassSuccess</a>
-- <a href="parameters/compassError.html">compassError</a>
-- <a href="parameters/compassOptions.html">compassOptions</a>
-- <a href="parameters/compassHeading.html">compassHeading</a>
+- compassSuccess
+- compassError
+- compassOptions
+- compassHeading
Permissions
-----------
@@ -59,7 +59,7 @@ Permissions
### iOS
-#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
+#### App/Supporting Files/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.watchHeading.md b/www/docs/en/1.8.1/cordova/compass/compass.watchHeading.md
index 3014ab8..90b85c6 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.watchHeading.md
+++ b/www/docs/en/1.8.1/cordova/compass/compass.watchHeading.md
@@ -23,16 +23,16 @@ compass.watchHeading
At a regular interval, get the compass heading in degrees.
- var watchID = navigator.compass.watchHeading(<a href="parameters/compassSuccess.html">compassSuccess</a>, <a href="parameters/compassError.html">compassError</a>, [<a href="parameters/compassOptions.html">compassOptions</a>]);
+ var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
Description
-----------
The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
-The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `<a href="parameters/compassOptions.html">compassOptions</a>` object.
+The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `compassOptions` object.
-The returned watch ID references references the compass watch interval. The watch ID can be used with `<a href="compass.clearWatch.html">compass.clearWatch</a>` to stop watching the compass.
+The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- webOS
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(heading) {
@@ -52,21 +52,21 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
element.innerHTML = 'Heading: ' + heading.magneticHeading;
};
- function onError(<a href="parameters/compassError.html">compassError</a>) {
- alert('<a href="compass.html">Compass</a> error: ' + <a href="parameters/compassError.html">compassError</a>.code);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
};
var options = { frequency: 3000 }; // Update every 3 seconds
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Compass Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -76,11 +76,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -98,7 +98,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function stopWatch() {
if (watchID) {
- navigator.<a href="compass.clearWatch.html">compass.clearWatch</a>(watchID);
+ navigator.compass.clearWatch(watchID);
watchID = null;
}
}
@@ -112,8 +112,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the heading
//
- function onError(<a href="parameters/compassError.html">compassError</a>) {
- alert('<a href="compass.html">Compass</a> error: ' + <a href="parameters/compassError.html">compassError</a>.code);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
}
</script>
@@ -128,6 +128,6 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
iOS Quirks
--------------
-In iOS `compass.watchHeading` can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `<a href="parameters/compassOptions.html">compassOptions</a>` object. Clear the watch as normal by passing the returned watch ID to `<a href="compass.clearWatch.html">compass.clearWatch</a>`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
+In iOS `compass.watchHeading` can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `compassOptions` object. Clear the watch as normal by passing the returned watch ID to `compass.clearWatch`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
In iOS only one watchHeading can be in effect at one time. If a watchHeading via filter is in effect, calling getCurrentHeading or watchHeading will use the existing filter value for specifying heading changes. On iOS watching heading changes via a filter is more efficient than via time.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.watchHeadingFilter.md b/www/docs/en/1.8.1/cordova/compass/compass.watchHeadingFilter.md
index f05a774..991da30 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.watchHeadingFilter.md
+++ b/www/docs/en/1.8.1/cordova/compass/compass.watchHeadingFilter.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="compass.watchHeading.html">compass.watchHeading</a>Filter
+compass.watchHeadingFilter
==========================
-No longer supported as of 1.6, see `<a href="compass.watchHeading.html">compass.watchHeading</a>` for equivalent functionality.
+No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compassError/compassError.md b/www/docs/en/1.8.1/cordova/compass/compassError/compassError.md
index e356b45..20d01c5 100644
--- a/www/docs/en/1.8.1/cordova/compass/compassError/compassError.md
+++ b/www/docs/en/1.8.1/cordova/compass/compassError/compassError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../compass.html">Compass</a>Error
+CompassError
==========
-A `<a href="../compass.html">Compass</a>Error` object is returned to the `<a href="../parameters/compassError.html">compassError</a>` callback function when an error occurs.
+A `CompassError` object is returned to the `compassError` callback function when an error occurs.
Properties
----------
@@ -30,12 +30,12 @@ Properties
Constants
---------
-- `<a href="../compass.html">Compass</a>Error.COMPASS_INTERNAL_ERR`
-- `<a href="../compass.html">Compass</a>Error.COMPASS_NOT_SUPPORTED`
+- `CompassError.COMPASS_INTERNAL_ERR`
+- `CompassError.COMPASS_NOT_SUPPORTED`
Description
-----------
-The `<a href="../compass.html">Compass</a>Error` object is returned to the user through the `<a href="../parameters/compassError.html">compassError</a>` callback function when an error occurs.
+The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/parameters/compassError.md b/www/docs/en/1.8.1/cordova/compass/parameters/compassError.md
index 44700bc..3d2f523 100644
--- a/www/docs/en/1.8.1/cordova/compass/parameters/compassError.md
+++ b/www/docs/en/1.8.1/cordova/compass/parameters/compassError.md
@@ -23,9 +23,9 @@ compassError
onError callback function for compass functions.
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
-function(<a href="../compassError/compassError.html"><a href="../compass.html">Compass</a>Error</a>) {
+function(CompassError) {
// Handle the error
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/parameters/compassHeading.md b/www/docs/en/1.8.1/cordova/compass/parameters/compassHeading.md
index 8293202..adae2f6 100644
--- a/www/docs/en/1.8.1/cordova/compass/parameters/compassHeading.md
+++ b/www/docs/en/1.8.1/cordova/compass/parameters/compassHeading.md
@@ -21,7 +21,7 @@ license: >
compassHeading
==========
-A `<a href="../compass.html">Compass</a>Heading` object is returned to the `<a href="compassSuccess.html">compassSuccess</a>` callback function when an error occurs.
+A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs.
Properties
----------
@@ -33,7 +33,7 @@ Properties
Description
-----------
-The `<a href="../compass.html">Compass</a>Heading` object is returned to the user through the `<a href="compassSuccess.html">compassSuccess</a>` callback function.
+The `CompassHeading` object is returned to the user through the `compassSuccess` callback function.
Android Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/parameters/compassSuccess.md b/www/docs/en/1.8.1/cordova/compass/parameters/compassSuccess.md
index 015bb3f..a9bc5ff 100644
--- a/www/docs/en/1.8.1/cordova/compass/parameters/compassSuccess.md
+++ b/www/docs/en/1.8.1/cordova/compass/parameters/compassSuccess.md
@@ -21,7 +21,7 @@ license: >
compassSuccess
==============
-onSuccess callback function that provides the compass heading information via a <a href="compassHeading.html">compassHeading</a> object.
+onSuccess callback function that provides the compass heading information via a compassHeading object.
function(heading) {
// Do something
@@ -31,9 +31,9 @@ Parameters
----------
-- __heading:__ The heading information. _(<a href="compassHeading.html">compassHeading</a>)_
+- __heading:__ The heading information. _(compassHeading)_
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
function onSuccess(heading) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/connection/connection.md b/www/docs/en/1.8.1/cordova/connection/connection.md
index a39bb77..dd275b5 100644
--- a/www/docs/en/1.8.1/cordova/connection/connection.md
+++ b/www/docs/en/1.8.1/cordova/connection/connection.md
@@ -28,7 +28,7 @@ This object is accessed under the `navigator.network` interface.
Properties
----------
-- <a href="connection.type.html">connection.type</a>
+- connection.type
Constants
---------
@@ -70,7 +70,7 @@ Permissions
### iOS
-#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
+#### App/Supporting Files/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/connection/connection.type.md b/www/docs/en/1.8.1/cordova/connection/connection.type.md
index 54bfa6c..63b2643 100644
--- a/www/docs/en/1.8.1/cordova/connection/connection.type.md
+++ b/www/docs/en/1.8.1/cordova/connection/connection.type.md
@@ -38,60 +38,60 @@ Supported Platforms
- Bada 2.x
- webOS
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
- function check<a href="connection.html">Connection</a>() {
+ function checkConnection() {
var networkState = navigator.network.connection.type;
var states = {};
- states[<a href="connection.html">Connection</a>.UNKNOWN] = 'Unknown connection';
- states[<a href="connection.html">Connection</a>.ETHERNET] = 'Ethernet connection';
- states[<a href="connection.html">Connection</a>.WIFI] = 'WiFi connection';
- states[<a href="connection.html">Connection</a>.CELL_2G] = 'Cell 2G connection';
- states[<a href="connection.html">Connection</a>.CELL_3G] = 'Cell 3G connection';
- states[<a href="connection.html">Connection</a>.CELL_4G] = 'Cell 4G connection';
- states[<a href="connection.html">Connection</a>.NONE] = 'No network connection';
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.NONE] = 'No network connection';
- alert('<a href="connection.html">Connection</a> type: ' + states[networkState]);
+ alert('Connection type: ' + states[networkState]);
}
- check<a href="connection.html">Connection</a>();
+ checkConnection();
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title>navigator.network.connection.type <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>navigator.network.connection.type Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function on<a href="../device/device.html">Device</a>Ready() {
- check<a href="connection.html">Connection</a>();
+ function onDeviceReady() {
+ checkConnection();
}
- function check<a href="connection.html">Connection</a>() {
+ function checkConnection() {
var networkState = navigator.network.connection.type;
var states = {};
- states[<a href="connection.html">Connection</a>.UNKNOWN] = 'Unknown connection';
- states[<a href="connection.html">Connection</a>.ETHERNET] = 'Ethernet connection';
- states[<a href="connection.html">Connection</a>.WIFI] = 'WiFi connection';
- states[<a href="connection.html">Connection</a>.CELL_2G] = 'Cell 2G connection';
- states[<a href="connection.html">Connection</a>.CELL_3G] = 'Cell 3G connection';
- states[<a href="connection.html">Connection</a>.CELL_4G] = 'Cell 4G connection';
- states[<a href="connection.html">Connection</a>.NONE] = 'No network connection';
-
- alert('<a href="connection.html">Connection</a> type: ' + states[networkState]);
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.NONE] = 'No network connection';
+
+ alert('Connection type: ' + states[networkState]);
}
</script>
@@ -105,13 +105,13 @@ iOS Quirks
----------
- iOS cannot detect the type of cellular network connection.
- - `navigator.network.connection.type` is set to `<a href="connection.html">Connection</a>.CELL_2G` for all cellular data.
+ - `navigator.network.connection.type` is set to `Connection.CELL_2G` for all cellular data.
Bada Quirks
-----------
- Bada can only detect a WiFi or cellular connection.
- - `navigator.network.connection.type` is set to `<a href="connection.html">Connection</a>.CELL_2G` for all cellular data.
+ - `navigator.network.connection.type` is set to `Connection.CELL_2G` for all cellular data.
webOS Quirks
------------
@@ -121,4 +121,4 @@ webOS Quirks
Windows Phone Quirks
--------------------
-- Windows Phone Emulator always detects `navigator.network.connection.type` as `<a href="connection.html">Connection</a>.UNKNOWN`.
+- Windows Phone Emulator always detects `navigator.network.connection.type` as `Connection.UNKNOWN`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/contacts/Contact/contact.md b/www/docs/en/1.8.1/cordova/contacts/Contact/contact.md
index b7ea837..dc75106 100644
--- a/www/docs/en/1.8.1/cordova/contacts/Contact/contact.md
+++ b/www/docs/en/1.8.1/cordova/contacts/Contact/contact.md
@@ -28,31 +28,31 @@ 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. _(<a href="../ContactName/contactname.html">ContactName</a>)_
+- __name:__ An object containing all components of a persons name. _(ContactName)_
- __nickname:__ A casual name to address the contact by. _(DOMString)_
-- __phoneNumbers:__ An array of all the contact's phone numbers. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
-- __emails:__ An array of all the contact's email addresses. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
-- __addresses:__ An array of all the contact's addresses. _(<a href="../ContactAddress/contactaddress.html">ContactAddress</a>[])_
-- __ims:__ An array of all the contact's IM addresses. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
-- __organizations:__ An array of all the contact's organizations. _(<a href="../ContactOrganization/contactorganization.html">ContactOrganization</a>[])_
+- __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. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
-- __categories:__ An array of all the contacts user defined categories. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
-- __urls:__ An array of web pages associated to the contact. _(<a href="../ContactField/contactfield.html">ContactField</a>[])_
+- __photos:__ An array of the contact's photos. _(ContactField[])_
+- __categories:__ An array of all the contacts user defined categories. _(ContactField[])_
+- __urls:__ An array of web pages associated to the contact. _(ContactField[])_
Methods
-------
- __clone__: Returns a new Contact object that is a deep copy of the calling object, with the id property set to `null`.
-- __remove__: Removes the contact from the device contacts database. An error callback is called with a `<a href="../ContactError/<a href="../parameters/contactError.html">contactError</a>.html">ContactError</a>` object if the removal is unsuccessful.
+- __remove__: Removes the contact from the device contacts database. An error callback is called with a `ContactError` object if the removal is unsuccessful.
- __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists.
Details
-------
-The `Contact` object represents a user contact. <a href="../contacts.html">Contacts</a> can be created, saved to, or removed from the device contacts database. <a href="../contacts.html">Contacts</a> can also be retrieved (individually or in bulk) from the database by invoking the `<a href="../contacts.find.html">contacts.find</a>` method.
+The `Contact` object represents a user contact. Contacts can be created, saved to, or removed from the device contacts database. Contacts can also be retrieved (individually or in bulk) from the database by invoking the `contacts.find` method.
_Note: Not all of the above contact fields are supported on every device platform. Please check each platform's Quirks section for information about which fields are supported._
@@ -64,24 +64,24 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Save Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Save Quick Example
------------------
function onSuccess(contact) {
alert("Save Success");
};
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
- alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
+ function onError(contactError) {
+ alert("Error = " + contactError.code);
};
// create a new contact object
- var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
+ var contact = navigator.contacts.create();
contact.displayName = "Plumber";
contact.nickname = "Plumber"; //specify both to support all devices
// populate some fields
- var name = new <a href="../ContactName/contactname.html">ContactName</a>();
+ var name = new ContactName();
name.givenName = "Jane";
name.familyName = "Doe";
contact.name = name;
@@ -89,7 +89,7 @@ Save Quick <a href="../../storage/storage.opendatabase.html">Example</a>
// save to device
contact.save(onSuccess,onError);
-Clone Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Clone Quick Example
-------------------
// clone the contact object
@@ -98,43 +98,43 @@ Clone Quick <a href="../../storage/storage.opendatabase.html">Example</a>
console.log("Original contact name = " + contact.name.givenName);
console.log("Cloned contact name = " + clone.name.givenName);
-Remove Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Remove Quick Example
--------------------
function onSuccess() {
alert("Removal Success");
};
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
- alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
+ function onError(contactError) {
+ alert("Error = " + contactError.code);
};
// remove the contact from the device
contact.remove(onSuccess,onError);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Contact Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// create
- var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
+ var contact = navigator.contacts.create();
contact.displayName = "Plumber";
contact.nickname = "Plumber"; //specify both to support all devices
- var name = new <a href="../ContactName/contactname.html">ContactName</a>();
+ var name = new ContactName();
name.givenName = "Jane";
name.familyName = "Doe";
contact.name = name;
@@ -160,8 +160,8 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// onSaveError: Failed to get the contacts
//
- function onSaveError(<a href="../parameters/contactError.html">contactError</a>) {
- alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
+ function onSaveError(contactError) {
+ alert("Error = " + contactError.code);
}
// onRemoveSuccess: Get a snapshot of the current contacts
@@ -172,15 +172,15 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// onRemoveError: Failed to get the contacts
//
- function onRemoveError(<a href="../parameters/contactError.html">contactError</a>) {
- alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
+ function onRemoveError(contactError) {
+ alert("Error = " + contactError.code);
}
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Find <a href="../contacts.html">Contacts</a></p>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
</body>
</html>
@@ -217,9 +217,9 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
iOS Quirks
----------
-- __displayName:__ This property is not supported by iOS and will be returned as `null` unless there is no <a href="../ContactName/contactname.html">ContactName</a> specified. If there is no <a href="../ContactName/contactname.html">ContactName</a>, then composite name, __nickname__ or "" is returned for __displayName__, respectively.
+- __displayName:__ This property is not supported by iOS and will be returned as `null` unless there is no ContactName specified. If there is no ContactName, then composite name, __nickname__ or "" is returned for __displayName__, respectively.
- __birthday:__ For input, this property must be provided as a JavaScript Date object. It is returned as a JavaScript Date object.
-- __photos:__ Returned Photo is stored in the application's temporary directory and a <a href="../../file/fileobj/fileobj.html">File</a> URL to photo is returned. Contents of temporary folder is deleted when application exits.
+- __photos:__ Returned Photo is stored in the application's temporary directory and a File URL to photo is returned. Contents of temporary folder is deleted when application exits.
- __categories:__ This property is not currently supported and will always be returned as `null`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/contacts/ContactAddress/contactaddress.md b/www/docs/en/1.8.1/cordova/contacts/ContactAddress/contactaddress.md
index 1cba078..f557c48 100644
--- a/www/docs/en/1.8.1/cordova/contacts/ContactAddress/contactaddress.md
+++ b/www/docs/en/1.8.1/cordova/contacts/ContactAddress/contactaddress.md
@@ -18,14 +18,14 @@ license: >
under the License.
---
-<a href="../Contact/contact.html">Contact</a>Address
+ContactAddress
==============
-Contains address properties for a `<a href="../Contact/contact.html">Contact</a>` object.
+Contains address properties for a `Contact` object.
Properties
----------
-- __pref:__ Set to `true` if this `<a href="../Contact/contact.html">Contact</a>Address` contains the user's preferred value. _(boolean)_
+- __pref:__ Set to `true` if this `ContactAddress` contains the user's preferred value. _(boolean)_
- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)
- __formatted:__ The full address formatted for display. _(DOMString)_
- __streetAddress:__ The full street address. _(DOMString)_
@@ -37,7 +37,7 @@ Properties
Details
-------
-The `<a href="../Contact/contact.html">Contact</a>Address` object stores the properties of a single address of a contact. A `<a href="../Contact/contact.html">Contact</a>` object can have one or more addresses in a `<a href="../Contact/contact.html">Contact</a>Address[]` array.
+The `ContactAddress` object stores the properties of a single address of a contact. A `Contact` object can have one or more addresses in a `ContactAddress[]` array.
Supported Platforms
-------------------
@@ -47,7 +47,7 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
// display the address information for all contacts
@@ -66,39 +66,39 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
}
};
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ function onError(contactError) {
alert('onError!');
};
// find all contacts
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ var options = new ContactFindOptions();
options.filter="";
var filter = ["displayName","addresses"];
- navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
+ navigator.contacts.find(filter, onSuccess, onError, options);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Contact Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
// find all contacts
- var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
+ var options = new ContactFindOptions();
options.filter="";
var filter = ["displayName","addresses"];
- navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
+ navigator.contacts.find(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -121,15 +121,15 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the contacts
//
- function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ function onError(contactError) {
alert('onError!');
}
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
- <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.8.1/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/contacts/ContactError/contactError.md b/www/docs/en/1.8.1/cordova/contacts/ContactError/contactError.md
index ad3bc3d..b0f07c8 100644
--- a/www/docs/en/1.8.1/cordova/contacts/ContactError/contactError.md
+++ b/www/docs/en/1.8.1/cordova/contacts/ContactError/contactError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../Contact/contact.html">Contact</a>Error
+ContactError
========
-A `<a href="../Contact/contact.html">Contact</a>Error` object is returned to the `<a href="../parameters/contactError.html">contactError</a>` callback when an error occurs.
+A `ContactError` object is returned to the `contactError` callback when an error occurs.
Properties
----------
@@ -31,16 +31,16 @@ Properties
Constants
---------
-- `<a href="../Contact/contact.html">Contact</a>Error.UNKNOWN_ERROR`
-- `<a href="../Contact/contact.html">Contact</a>Error.INVALID_ARGUMENT_ERROR`
-- `<a href="../Contact/contact.html">Contact</a>Error.TIMEOUT_ERROR`
-- `<a href="../Contact/contact.html">Contact</a>Error.PENDING_OPERATION_ERROR`
-- `<a href="../Contact/contact.html">Contact</a>Error.IO_ERROR`
-- `<a href="../Contact/contact.html">Contact</a>Error.NOT_SUPPORTED_ERROR`
-- `<a href="../Contact/contact.html">Contact</a>Error.PERMISSION_DENIED_ERROR`
+- `ContactError.UNKNOWN_ERROR`
+- `ContactError.INVALID_ARGUMENT_ERROR`
+- `ContactError.TIMEOUT_ERROR`
+- `ContactError.PENDING_OPERATION_ERROR`
+- `ContactError.IO_ERROR`
+- `ContactError.NOT_SUPPORTED_ERROR`
+- `ContactError.PERMISSION_DENIED_ERROR`
Description
-----------
-The `<a href="../Contact/contact.html">Contact</a>Error` object is returned to the user through the `<a href="../parameters/contactError.html">contactError</a>` callback function when an error occurs.
+The `ContactError` object is returned to the user through the `contactError` callback function when an error occurs.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org