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/10 23:28:18 UTC
[18/51] [partial] docs commit: Solidifying 'automatic' links.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.clearWatch.md b/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.clearWatch.md
index 1a3da3e..f7655c3 100644
--- a/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.clearWatch.md
@@ -21,11 +21,11 @@ license: >
accelerometer.clearWatch
========================
-Stop watching the `Acceleration` referenced by the watch ID parameter.
+Stop watching the `<a href="acceleration/acceleration.html">Acceleration</a>` referenced by the watch ID parameter.
navigator.accelerometer.clearWatch(watchID);
-- __watchID__: The ID returned by `accelerometer.watchAcceleration`.
+- __watchID__: The ID returned by `accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>`.
Supported Platforms
-------------------
@@ -36,36 +36,36 @@ Supported Platforms
- Windows Phone 7 (Mango)
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
- var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ var watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
// ... later on ...
navigator.accelerometer.clearWatch(watchID);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Acceleration Example</title>
+ <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // The watch id references the current `watchAcceleration`
+ // The watch id references the current `watch<a href="acceleration/acceleration.html">Acceleration</a>`
var watchID = null;
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
startWatch();
}
@@ -76,7 +76,7 @@ Full Example
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
}
// Stop watching the acceleration
@@ -92,9 +92,9 @@ Full Example
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
- 'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
+ element.innerHTML = '<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 />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index 0d47435..93bc36d 100644
--- a/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -18,19 +18,19 @@ license: >
under the License.
---
-accelerometer.getCurrentAcceleration
+accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>
====================================
Get the current acceleration along the x, y, and z axis.
- navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
+ navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>, <a href="parameters/accelerometerError.html">accelerometerError</a>);
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 `accelerometerSuccess` callback function.
+The acceleration is returned using the `<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>` callback function.
Supported Platforms
-------------------
@@ -41,13 +41,13 @@ Supported Platforms
- Windows Phone 7 (Mango)
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
+ 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' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
@@ -55,35 +55,35 @@ Quick Example
alert('onError!');
};
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+ navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Acceleration Example</title>
+ <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+ function on<a href="../device/device.html">Device</a>Ready() {
+ navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError);
}
// onSuccess: Get a snapshot of the current acceleration
//
function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
+ 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' +
'Timestamp: ' + acceleration.timestamp + '\n');
}
@@ -96,8 +96,8 @@ Full Example
</script>
</head>
<body>
- <h1>Example</h1>
- <p>getCurrentAcceleration</p>
+ <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
+ <p>getCurrent<a href="acceleration/acceleration.html">Acceleration</a></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 `getCurrentAcceleration` function will give you the last value reported from a Cordova `watchAccelerometer` call.
+- 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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.md b/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.md
index 7607cd0..afb5e45 100644
--- a/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.md
+++ b/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.md
@@ -21,23 +21,23 @@ license: >
Accelerometer
=============
-> Captures device motion in the x, y, and z direction.
+> <a href="../media/capture/capture.html">Capture</a>s device motion in the x, y, and z direction.
Methods
-------
-- accelerometer.getCurrentAcceleration
-- accelerometer.watchAcceleration
-- accelerometer.clearWatch
+- 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>
Arguments
---------
-- accelerometerSuccess
-- accelerometerError
-- accelerometerOptions
+- <a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>
+- <a href="parameters/accelerometerError.html">accelerometerError</a>
+- <a href="parameters/accelerometerOptions.html">accelerometerOptions</a>
Objects (Read-Only)
-------------------
-- Acceleration
\ No newline at end of file
+- <a href="acceleration/acceleration.html">Acceleration</a>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.watchAcceleration.md b/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.watchAcceleration.md
index f2d600b..91523a8 100644
--- a/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/www/docs/en/1.7.0/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -18,23 +18,23 @@ license: >
under the License.
---
-accelerometer.watchAcceleration
+accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>
===============================
At a regular interval, get the acceleration along the x, y, and z axis.
- var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
- accelerometerError,
- [accelerometerOptions]);
+ 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>]);
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.watchAcceleration` gets the device's current acceleration at a regular interval. Each time the `Acceleration` is retrieved, the `accelerometerSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object.
+The `accelerometer.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 returned watch ID references references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer.
+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.
Supported Platforms
-------------------
@@ -46,13 +46,13 @@ Supported Platforms
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
+ 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' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
@@ -62,29 +62,29 @@ Quick Example
var options = { frequency: 3000 }; // Update every 3 seconds
- var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ var watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Acceleration Example</title>
+ <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // The watch id references the current `watchAcceleration`
+ // The watch id references the current `watch<a href="acceleration/acceleration.html">Acceleration</a>`
var watchID = null;
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
startWatch();
}
@@ -95,14 +95,14 @@ Full Example
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
}
// Stop watching the acceleration
//
function stopWatch() {
if (watchID) {
- navigator.accelerometer.clearWatch(watchID);
+ navigator.<a href="accelerometer.clearWatch.html">accelerometer.clearWatch</a>(watchID);
watchID = null;
}
}
@@ -111,9 +111,9 @@ Full Example
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
- 'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
+ element.innerHTML = '<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 />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/accelerometer/parameters/accelerometerOptions.md b/www/docs/en/1.7.0/cordova/accelerometer/parameters/accelerometerOptions.md
index 86fb292..d105d2d 100644
--- a/www/docs/en/1.7.0/cordova/accelerometer/parameters/accelerometerOptions.md
+++ b/www/docs/en/1.7.0/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 `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
+- __frequency:__ How often to retrieve the `<a href="../acceleration/acceleration.html">Acceleration</a>` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/accelerometer/parameters/accelerometerSuccess.md b/www/docs/en/1.7.0/cordova/accelerometer/parameters/accelerometerSuccess.md
index 67166dc..5f448d2 100644
--- a/www/docs/en/1.7.0/cordova/accelerometer/parameters/accelerometerSuccess.md
+++ b/www/docs/en/1.7.0/cordova/accelerometer/parameters/accelerometerSuccess.md
@@ -21,7 +21,7 @@ license: >
accelerometerSuccess
====================
-onSuccess callback function that provides the Acceleration information.
+onSuccess callback function that provides the <a href="../acceleration/acceleration.html">Acceleration</a> information.
function(acceleration) {
// Do something
@@ -30,14 +30,14 @@ onSuccess callback function that provides the Acceleration information.
Parameters
----------
-- __acceleration:__ The acceleration at a single moment in time. (Acceleration)
+- __acceleration:__ The acceleration at a single moment in time. (<a href="../acceleration/acceleration.html">Acceleration</a>)
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
+ 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' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/camera/camera.getPicture.md b/www/docs/en/1.7.0/cordova/camera/camera.getPicture.md
index f2fee0f..3e4403f 100644
--- a/www/docs/en/1.7.0/cordova/camera/camera.getPicture.md
+++ b/www/docs/en/1.7.0/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( cameraSuccess, cameraError, [ cameraOptions ] );
+ navigator.camera.getPicture( <a href="parameter/cameraSuccess.html">cameraSuccess</a>, <a href="parameter/cameraError.html">cameraError</a>, [ <a href="parameter/cameraOptions.html">cameraOptions</a> ] );
Description
-----------
-Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `Camera.sourceType = Camera.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
+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.
-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.
+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.
-The return value will be sent to the `cameraSuccess` function, in one of the following formats, depending on the `cameraOptions` you specify:
+The return value 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:
- 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 `cameraSuccess` function, in one of the fol
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 (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
+- Save the data locally (`Local<a href="../storage/storage.html">Storage</a>`, [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 'Camera.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 '<a href="camera.html">Camera</a>.destinationType' is highly recommended.
Supported Platforms
-------------------
@@ -62,13 +62,13 @@ Invoking the native camera application while your device is connected
via Zune will not work, and the error callback will be triggered.
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
Take photo and retrieve Base64-encoded image:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: Camera.DestinationType.DATA_URL
+ destinationType: <a href="camera.html">Camera</a>.DestinationType.DATA_URL
});
function onSuccess(imageData) {
@@ -83,7 +83,7 @@ Take photo and retrieve Base64-encoded image:
Take photo and retrieve image file location:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: Camera.DestinationType.FILE_URI });
+ destinationType: <a href="camera.html">Camera</a>.DestinationType.FILE_URI });
function onSuccess(imageURI) {
var image = document.getElementById('myImage');
@@ -95,13 +95,13 @@ Take photo and retrieve image file location:
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Capture Photo</title>
+ <title><a href="../media/capture/capture.html">Capture</a> Photo</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -111,11 +111,11 @@ Full Example
// Wait for Cordova to connect with the device
//
- document.addEventListener("deviceready",onDeviceReady,false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>",on<a href="../device/device.html">Device</a>Ready,false);
// Cordova is ready to be used!
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
pictureSource=navigator.camera.PictureSourceType;
destinationType=navigator.camera.DestinationType;
}
@@ -194,8 +194,8 @@ Full Example
</script>
</head>
<body>
- <button onclick="capturePhoto();">Capture Photo</button> <br>
- <button onclick="capturePhotoEdit();">Capture Editable Photo</button> <br>
+ <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="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/89392fa8/www/docs/en/1.7.0/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/camera/camera.md b/www/docs/en/1.7.0/cordova/camera/camera.md
index 611035d..4608c34 100644
--- a/www/docs/en/1.7.0/cordova/camera/camera.md
+++ b/www/docs/en/1.7.0/cordova/camera/camera.md
@@ -26,4 +26,4 @@ Camera
Methods
-------
-- camera.getPicture
\ No newline at end of file
+- <a href="camera.getPicture.html">camera.getPicture</a>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/camera/parameter/cameraOptions.md b/www/docs/en/1.7.0/cordova/camera/parameter/cameraOptions.md
index 498dc01..d8ed3d0 100644
--- a/www/docs/en/1.7.0/cordova/camera/parameter/cameraOptions.md
+++ b/www/docs/en/1.7.0/cordova/camera/parameter/cameraOptions.md
@@ -24,10 +24,10 @@ cameraOptions
Optional parameters to customize the camera settings.
{ quality : 75,
- destinationType : Camera.DestinationType.DATA_URL,
- sourceType : Camera.PictureSourceType.CAMERA,
+ destinationType : <a href="../camera.html">Camera</a>.DestinationType.DATA_URL,
+ sourceType : <a href="../camera.html">Camera</a>.PictureSourceType.CAMERA,
allowEdit : true,
- encodingType: Camera.EncodingType.JPEG,
+ encodingType: <a href="../camera.html">Camera</a>.EncodingType.JPEG,
targetWidth: 100,
targetHeight: 100 };
@@ -38,14 +38,14 @@ Options
- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`)
- Camera.DestinationType = {
+ <a href="../camera.html">Camera</a>.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`)
- Camera.PictureSourceType = {
+ <a href="../camera.html">Camera</a>.PictureSourceType = {
PHOTOLIBRARY : 0,
CAMERA : 1,
SAVEDPHOTOALBUM : 2
@@ -55,7 +55,7 @@ Options
- __encodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`)
- Camera.EncodingType = {
+ <a href="../camera.html">Camera</a>.EncodingType = {
JPEG : 0, // Return JPEG encoded image
PNG : 1 // Return PNG encoded image
};
@@ -63,9 +63,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.MediaType (`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`)
- Camera.MediaType = {
+ <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type = {
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
@@ -78,8 +78,8 @@ Android Quirks
--------------
- Ignores the `allowEdit` parameter.
-- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
-- Camera.EncodingType is not supported.
+- <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.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
@@ -89,9 +89,9 @@ BlackBerry Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Application must have key injection permissions to close native Camera application after photo is taken.
+- Application must have key injection permissions to close native <a href="../camera.html">Camera</a> application after photo is taken.
- Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).
-- Camera.MediaType is not supported.
+- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
@@ -101,7 +101,7 @@ Palm Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Camera.MediaType is not supported.
+- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/camera/parameter/cameraSuccess.md b/www/docs/en/1.7.0/cordova/camera/parameter/cameraSuccess.md
index ec04795..6083130 100644
--- a/www/docs/en/1.7.0/cordova/camera/parameter/cameraSuccess.md
+++ b/www/docs/en/1.7.0/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 `cameraOptions` used. (`String`)
+- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `<a href="cameraOptions.html">cameraOptions</a>` used. (`String`)
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
// Show image
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/compass.clearWatch.md b/www/docs/en/1.7.0/cordova/compass/compass.clearWatch.md
index e892acd..cee5ee9 100644
--- a/www/docs/en/1.7.0/cordova/compass/compass.clearWatch.md
+++ b/www/docs/en/1.7.0/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 `compass.watchHeading`.
+- __watchID__: The ID returned by `<a href="compass.watchHeading.html">compass.watchHeading</a>`.
Supported Platforms
-------------------
@@ -35,22 +35,22 @@ Supported Platforms
- Windows Phone 7 ( Mango ) if available in hardware
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
- var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+ var watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
// ... later on ...
navigator.compass.clearWatch(watchID);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Compass Example</title>
+ <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -60,11 +60,11 @@ Full Example
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
startWatch();
}
@@ -75,7 +75,7 @@ Full Example
// Update compass every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+ watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
}
// Stop watching the compass
@@ -96,8 +96,8 @@ Full Example
// onError: Failed to get the heading
//
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
+ 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);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/compass.clearWatchFilter.md b/www/docs/en/1.7.0/cordova/compass/compass.clearWatchFilter.md
index 276c11f..9cf3e19 100644
--- a/www/docs/en/1.7.0/cordova/compass/compass.clearWatchFilter.md
+++ b/www/docs/en/1.7.0/cordova/compass/compass.clearWatchFilter.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-compass.clearWatchFilter
+<a href="compass.clearWatch.html">compass.clearWatch</a>Filter
========================
-No longer supported as of 1.6. See `compass.clearWatch`.
\ No newline at end of file
+No longer supported as of 1.6. See `<a href="compass.clearWatch.html">compass.clearWatch</a>`.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/compass.getCurrentHeading.md b/www/docs/en/1.7.0/cordova/compass/compass.getCurrentHeading.md
index 28cfc0f..fb86e71 100644
--- a/www/docs/en/1.7.0/cordova/compass/compass.getCurrentHeading.md
+++ b/www/docs/en/1.7.0/cordova/compass/compass.getCurrentHeading.md
@@ -23,14 +23,14 @@ compass.getCurrentHeading
Get the current compass heading.
- navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
+ navigator.compass.getCurrentHeading(<a href="parameters/compassSuccess.html">compassSuccess</a>, <a href="parameters/compassError.html">compassError</a>, <a href="parameters/compassOptions.html">compassOptions</a>);
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 CompassHeading object using the `compassSuccess` callback function.
+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.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- Windows Phone 7 ( Mango ) if available in hardware
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(heading) {
@@ -48,29 +48,29 @@ Quick Example
};
function onError(error) {
- alert('CompassError: ' + error.code);
+ 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);
};
navigator.compass.getCurrentHeading(onSuccess, onError);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Compass Example</title>
+ <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
navigator.compass.getCurrentHeading(onSuccess, onError);
}
@@ -82,14 +82,14 @@ Full Example
// onError: Failed to get the heading
//
- function onError(compassError) {
- alert('Compass Error: ' + compassError.code);
+ 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);
}
</script>
</head>
<body>
- <h1>Example</h1>
+ <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
<p>getCurrentHeading</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/compass.md b/www/docs/en/1.7.0/cordova/compass/compass.md
index beb83e2..febba7c 100644
--- a/www/docs/en/1.7.0/cordova/compass/compass.md
+++ b/www/docs/en/1.7.0/cordova/compass/compass.md
@@ -26,16 +26,16 @@ Compass
Methods
-------
-- compass.getCurrentHeading
-- compass.watchHeading
-- compass.clearWatch
-- compass.watchHeadingFilter (obsolete)
-- compass.clearWatchFilter (obsolete)
+- <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)
Arguments
---------
-- compassSuccess
-- compassError
-- compassOptions
-- compassHeading
+- <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>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/compass.watchHeading.md b/www/docs/en/1.7.0/cordova/compass/compass.watchHeading.md
index 07403fd..8727f2e 100644
--- a/www/docs/en/1.7.0/cordova/compass/compass.watchHeading.md
+++ b/www/docs/en/1.7.0/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(compassSuccess, compassError, [compassOptions]);
+ 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>]);
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 `compassOptions` object.
+The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `<a href="parameters/compassOptions.html">compassOptions</a>` object.
-The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass.
+The returned watch ID references 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.
Supported Platforms
-------------------
@@ -43,7 +43,7 @@ Supported Platforms
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(heading) {
@@ -51,21 +51,21 @@ Quick Example
element.innerHTML = 'Heading: ' + heading.magneticHeading;
};
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
+ 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);
};
var options = { frequency: 3000 }; // Update every 3 seconds
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Compass Example</title>
+ <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -75,11 +75,11 @@ Full Example
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
startWatch();
}
@@ -97,7 +97,7 @@ Full Example
//
function stopWatch() {
if (watchID) {
- navigator.compass.clearWatch(watchID);
+ navigator.<a href="compass.clearWatch.html">compass.clearWatch</a>(watchID);
watchID = null;
}
}
@@ -111,8 +111,8 @@ Full Example
// onError: Failed to get the heading
//
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
+ 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);
}
</script>
@@ -127,6 +127,6 @@ Full Example
iOS Quirks
--------------
-In iOS `compass.watchHeading` can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `compassOptions` object. Clear the watch as normal by passing the returned watch ID to `compass.clearWatch`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
+In iOS `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 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/89392fa8/www/docs/en/1.7.0/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/compass.watchHeadingFilter.md b/www/docs/en/1.7.0/cordova/compass/compass.watchHeadingFilter.md
index 991da30..f05a774 100644
--- a/www/docs/en/1.7.0/cordova/compass/compass.watchHeadingFilter.md
+++ b/www/docs/en/1.7.0/cordova/compass/compass.watchHeadingFilter.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-compass.watchHeadingFilter
+<a href="compass.watchHeading.html">compass.watchHeading</a>Filter
==========================
-No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality.
+No longer supported as of 1.6, see `<a href="compass.watchHeading.html">compass.watchHeading</a>` for equivalent functionality.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/compassError/compassError.md b/www/docs/en/1.7.0/cordova/compass/compassError/compassError.md
index 20d01c5..e356b45 100644
--- a/www/docs/en/1.7.0/cordova/compass/compassError/compassError.md
+++ b/www/docs/en/1.7.0/cordova/compass/compassError/compassError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-CompassError
+<a href="../compass.html">Compass</a>Error
==========
-A `CompassError` object is returned to the `compassError` callback function when an error occurs.
+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.
Properties
----------
@@ -30,12 +30,12 @@ Properties
Constants
---------
-- `CompassError.COMPASS_INTERNAL_ERR`
-- `CompassError.COMPASS_NOT_SUPPORTED`
+- `<a href="../compass.html">Compass</a>Error.COMPASS_INTERNAL_ERR`
+- `<a href="../compass.html">Compass</a>Error.COMPASS_NOT_SUPPORTED`
Description
-----------
-The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
+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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/parameters/compassError.md b/www/docs/en/1.7.0/cordova/compass/parameters/compassError.md
index 3d2f523..44700bc 100644
--- a/www/docs/en/1.7.0/cordova/compass/parameters/compassError.md
+++ b/www/docs/en/1.7.0/cordova/compass/parameters/compassError.md
@@ -23,9 +23,9 @@ compassError
onError callback function for compass functions.
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
-function(CompassError) {
+function(<a href="../compassError/compassError.html"><a href="../compass.html">Compass</a>Error</a>) {
// Handle the error
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/parameters/compassHeading.md b/www/docs/en/1.7.0/cordova/compass/parameters/compassHeading.md
index adae2f6..8293202 100644
--- a/www/docs/en/1.7.0/cordova/compass/parameters/compassHeading.md
+++ b/www/docs/en/1.7.0/cordova/compass/parameters/compassHeading.md
@@ -21,7 +21,7 @@ license: >
compassHeading
==========
-A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs.
+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.
Properties
----------
@@ -33,7 +33,7 @@ Properties
Description
-----------
-The `CompassHeading` object is returned to the user through the `compassSuccess` callback function.
+The `<a href="../compass.html">Compass</a>Heading` object is returned to the user through the `<a href="compassSuccess.html">compassSuccess</a>` callback function.
Android Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/compass/parameters/compassSuccess.md b/www/docs/en/1.7.0/cordova/compass/parameters/compassSuccess.md
index a9bc5ff..015bb3f 100644
--- a/www/docs/en/1.7.0/cordova/compass/parameters/compassSuccess.md
+++ b/www/docs/en/1.7.0/cordova/compass/parameters/compassSuccess.md
@@ -21,7 +21,7 @@ license: >
compassSuccess
==============
-onSuccess callback function that provides the compass heading information via a compassHeading object.
+onSuccess callback function that provides the compass heading information via a <a href="compassHeading.html">compassHeading</a> object.
function(heading) {
// Do something
@@ -31,9 +31,9 @@ Parameters
----------
-- __heading:__ The heading information. _(compassHeading)_
+- __heading:__ The heading information. _(<a href="compassHeading.html">compassHeading</a>)_
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
function onSuccess(heading) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/connection/connection.md b/www/docs/en/1.7.0/cordova/connection/connection.md
index 7d9def8..d09f9e8 100644
--- a/www/docs/en/1.7.0/cordova/connection/connection.md
+++ b/www/docs/en/1.7.0/cordova/connection/connection.md
@@ -28,7 +28,7 @@ This object is accessed under the `navigator.network` interface.
Properties
----------
-- connection.type
+- <a href="connection.type.html">connection.type</a>
Constants
---------
@@ -45,7 +45,7 @@ WP7 Quirk
---------
- __type:__
-Windows Phone Emulator always reports navigator.network.connection.type is Connection.UNKNOWN
+Windows Phone Emulator always reports navigator.network.<a href="connection.type.html">connection.type</a> is Connection.UNKNOWN
iOS Quirk
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/connection/connection.type.md b/www/docs/en/1.7.0/cordova/connection/connection.type.md
index 82238c8..8d00149 100644
--- a/www/docs/en/1.7.0/cordova/connection/connection.type.md
+++ b/www/docs/en/1.7.0/cordova/connection/connection.type.md
@@ -38,61 +38,61 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
- function checkConnection() {
+ function check<a href="connection.html">Connection</a>() {
var networkState = navigator.network.connection.type;
var states = {};
- states[Connection.UNKNOWN] = 'Unknown connection';
- states[Connection.ETHERNET] = 'Ethernet connection';
- states[Connection.WIFI] = 'WiFi connection';
- states[Connection.CELL_2G] = 'Cell 2G connection';
- states[Connection.CELL_3G] = 'Cell 3G connection';
- states[Connection.CELL_4G] = 'Cell 4G connection';
- states[Connection.NONE] = 'No network connection';
+ 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('Connection type: ' + states[networkState]);
+ alert('<a href="connection.html">Connection</a> type: ' + states[networkState]);
}
- checkConnection();
+ check<a href="connection.html">Connection</a>();
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>navigator.network.connection.type Example</title>
+ <title>navigator.network.connection.type <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function onDeviceReady() {
- checkConnection();
+ function on<a href="../device/device.html">Device</a>Ready() {
+ check<a href="connection.html">Connection</a>();
}
- function checkConnection() {
+ function check<a href="connection.html">Connection</a>() {
var networkState = navigator.network.connection.type;
var states = {};
- states[Connection.UNKNOWN] = 'Unknown connection';
- states[Connection.ETHERNET] = 'Ethernet connection';
- states[Connection.WIFI] = 'WiFi connection';
- states[Connection.CELL_2G] = 'Cell 2G connection';
- states[Connection.CELL_3G] = 'Cell 3G connection';
- states[Connection.CELL_4G] = 'Cell 4G connection';
- states[Connection.NONE] = 'No network connection';
-
- alert('Connection type: ' + states[networkState]);
+ 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]);
}
</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/Contact/contact.md b/www/docs/en/1.7.0/cordova/contacts/Contact/contact.md
index 4297c35..87053a7 100644
--- a/www/docs/en/1.7.0/cordova/contacts/Contact/contact.md
+++ b/www/docs/en/1.7.0/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. _(ContactName)_
+- __name:__ An object containing all components of a persons name. _(<a href="../ContactName/contactname.html">ContactName</a>)_
- __nickname:__ A casual name to address the contact by. _(DOMString)_
-- __phoneNumbers:__ An array of all the contact's phone numbers. _(ContactField[])_
-- __emails:__ An array of all the contact's email addresses. _(ContactField[])_
-- __addresses:__ An array of all the contact's addresses. _(ContactAddresses[])_
-- __ims:__ An array of all the contact's IM addresses. _(ContactField[])_
-- __organizations:__ An array of all the contact's organizations. _(ContactOrganization[])_
+- __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>es[])_
+- __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>[])_
- __birthday:__ The birthday of the contact. _(Date)_
- __note:__ A note about the contact. _(DOMString)_
-- __photos:__ An array of the contact's photos. _(ContactField[])_
-- __categories:__ An array of all the contacts user defined categories. _(ContactField[])_
-- __urls:__ An array of web pages associated to the contact. _(ContactField[])_
+- __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>[])_
Methods
-------
- __clone__: Returns a new Contact object that is a deep copy of the calling object, with the id property set to `null`.
-- __remove__: Removes the contact from the device contacts database. An error callback is called with a `ContactError` object if the removal is unsuccessful.
+- __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.
- __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists.
Details
-------
-The `Contact` object represents a user contact. Contacts can be created, saved to, or removed from the device contacts database. Contacts can also be retrieved (individually or in bulk) from the database by invoking the `contacts.find` method.
+The `Contact` object represents a user contact. <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.
_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
-Save Quick Example
+Save Quick <a href="../../storage/storage.opendatabase.html">Example</a>
------------------
function onSuccess(contact) {
alert("Save Success");
};
- function onError(contactError) {
- alert("Error = " + contactError.code);
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
};
// create a new contact object
- var contact = navigator.contacts.create();
+ var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
contact.displayName = "Plumber";
contact.nickname = "Plumber"; //specify both to support all devices
// populate some fields
- var name = new ContactName();
+ var name = new <a href="../ContactName/contactname.html">ContactName</a>();
name.givenName = "Jane";
name.familyName = "Doe";
contact.name = name;
@@ -89,7 +89,7 @@ Save Quick Example
// save to device
contact.save(onSuccess,onError);
-Clone Quick Example
+Clone Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------------
// clone the contact object
@@ -98,43 +98,43 @@ Clone Quick Example
console.log("Original contact name = " + contact.name.givenName);
console.log("Cloned contact name = " + clone.name.givenName);
-Remove Quick Example
+Remove Quick <a href="../../storage/storage.opendatabase.html">Example</a>
--------------------
function onSuccess() {
alert("Removal Success");
};
- function onError(contactError) {
- alert("Error = " + contactError.code);
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
+ alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
};
// remove the contact from the device
contact.remove(onSuccess,onError);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title>Contact <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../../device/device.html">Device</a>Ready() {
// create
- var contact = navigator.contacts.create();
+ var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
contact.displayName = "Plumber";
contact.nickname = "Plumber"; //specify both to support all devices
- var name = new ContactName();
+ var name = new <a href="../ContactName/contactname.html">ContactName</a>();
name.givenName = "Jane";
name.familyName = "Doe";
contact.name = name;
@@ -160,8 +160,8 @@ Full Example
// onSaveError: Failed to get the contacts
//
- function onSaveError(contactError) {
- alert("Error = " + contactError.code);
+ function onSaveError(<a href="../parameters/contactError.html">contactError</a>) {
+ alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
}
// onRemoveSuccess: Get a snapshot of the current contacts
@@ -172,15 +172,15 @@ Full Example
// onRemoveError: Failed to get the contacts
//
- function onRemoveError(contactError) {
- alert("Error = " + contactError.code);
+ function onRemoveError(<a href="../parameters/contactError.html">contactError</a>) {
+ alert("Error = " + <a href="../parameters/contactError.html">contactError</a>.code);
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../contacts.html">Contacts</a></p>
</body>
</html>
@@ -217,7 +217,7 @@ 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 ContactName specified. If there is no ContactName, 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 <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.
- __birthday:__ For input, this property must be provided as a JavaScript Date object. It is returned as a JavaScript Date object.
-- __photos:__ Returned Photo is stored in the application's temporary directory and a File URL to photo is returned. Contents of temporary folder is deleted when application exits.
+- __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.
- __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/89392fa8/www/docs/en/1.7.0/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/ContactAddress/contactaddress.md b/www/docs/en/1.7.0/cordova/contacts/ContactAddress/contactaddress.md
index 95c734e..6ff5e7b 100644
--- a/www/docs/en/1.7.0/cordova/contacts/ContactAddress/contactaddress.md
+++ b/www/docs/en/1.7.0/cordova/contacts/ContactAddress/contactaddress.md
@@ -18,14 +18,14 @@ license: >
under the License.
---
-ContactAddress
+<a href="../Contact/contact.html">Contact</a>Address
==============
-Contains address properties for a `Contact` object.
+Contains address properties for a `<a href="../Contact/contact.html">Contact</a>` object.
Properties
----------
-- __pref:__ Set to `true` if this `ContactAddress` contains the user's preferred value. _(boolean)_
+- __pref:__ Set to `true` if this `<a href="../Contact/contact.html">Contact</a>Address` 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 `ContactAddress` object stores the properties of a single address of a contact. A `Contact` object can have one or more addresses in a `ContactAddress[]` array.
+The `<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.
Supported Platforms
-------------------
@@ -47,7 +47,7 @@ Supported Platforms
- iOS
- Bada 1.2
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// display the address information for all contacts
@@ -66,39 +66,39 @@ Quick Example
}
};
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
};
// find all contacts
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
var filter = ["displayName","addresses"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../../device/device.html">Device</a>Ready() {
// find all contacts
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
var filter = ["displayName","addresses"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -121,15 +121,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/ContactError/contactError.md b/www/docs/en/1.7.0/cordova/contacts/ContactError/contactError.md
index b0f07c8..ad3bc3d 100644
--- a/www/docs/en/1.7.0/cordova/contacts/ContactError/contactError.md
+++ b/www/docs/en/1.7.0/cordova/contacts/ContactError/contactError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-ContactError
+<a href="../Contact/contact.html">Contact</a>Error
========
-A `ContactError` object is returned to the `contactError` callback when an error occurs.
+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.
Properties
----------
@@ -31,16 +31,16 @@ Properties
Constants
---------
-- `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`
+- `<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`
Description
-----------
-The `ContactError` object is returned to the user through the `contactError` callback function when an error occurs.
+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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/ContactField/contactfield.md b/www/docs/en/1.7.0/cordova/contacts/ContactField/contactfield.md
index 261b4b1..4f6b781 100644
--- a/www/docs/en/1.7.0/cordova/contacts/ContactField/contactfield.md
+++ b/www/docs/en/1.7.0/cordova/contacts/ContactField/contactfield.md
@@ -18,24 +18,24 @@ license: >
under the License.
---
-ContactField
+<a href="../Contact/contact.html">Contact</a>Field
============
-Supports generic fields in a `Contact` object. Some properties that are stored as `ContactField` objects include email addresses, phone numbers, and urls.
+Supports generic fields in a `<a href="../Contact/contact.html">Contact</a>` object. Some properties that are stored as `<a href="../Contact/contact.html">Contact</a>Field` objects include email addresses, phone numbers, and urls.
Properties
----------
- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)_
- __value:__ The value of the field (such as a phone number or email address). _(DOMString)_
-- __pref:__ Set to `true` if this `ContactField` contains the user's preferred value. _(boolean)_
+- __pref:__ Set to `true` if this `<a href="../Contact/contact.html">Contact</a>Field` contains the user's preferred value. _(boolean)_
Details
-------
-The `ContactField` object is a reusable component that is used to support contact fields in a generic fashion. Each `ContactField` object contains a value property, a type property, and a pref property. A `Contact` object stores several properties in `ContactField[]` arrays, such as phone numbers and email addresses.
+The `<a href="../Contact/contact.html">Contact</a>Field` object is a reusable component that is used to support contact fields in a generic fashion. Each `<a href="../Contact/contact.html">Contact</a>Field` object contains a value property, a type property, and a pref property. A `<a href="../Contact/contact.html">Contact</a>` object stores several properties in `<a href="../Contact/contact.html">Contact</a>Field[]` arrays, such as phone numbers and email addresses.
-In most instances, there are no pre-determined values for the __type__ attribute of a `ContactField` object. For example, a phone number can have __type__ values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular device platform. However, in the case of the `Contact` __photos__ field, Cordova makes use of the __type__ field to indicate the format of the returned image. Cordova will return __type: 'url'__ when the __value__ attribute contains a URL to the photo image, or __type: 'base64'__ when the returned __value__ attribute contains a Base64 encoded image string.
+In most instances, there are no pre-determined values for the __type__ attribute of a `<a href="../Contact/contact.html">Contact</a>Field` object. For example, a phone number can have __type__ values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular device platform. However, in the case of the `<a href="../Contact/contact.html">Contact</a>` __photos__ field, Cordova makes use of the __type__ field to indicate the format of the returned image. Cordova will return __type: 'url'__ when the __value__ attribute contains a URL to the photo image, or __type: 'base64'__ when the returned __value__ attribute contains a Base64 encoded image string.
Supported Platforms
-------------------
@@ -45,58 +45,58 @@ Supported Platforms
- iOS
- Bada 1.2
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// create a new contact
- var contact = navigator.contacts.create();
+ var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
- // store contact phone numbers in ContactField[]
+ // store contact phone numbers in <a href="../Contact/contact.html">Contact</a>Field[]
var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
+ phoneNumbers[0] = new <a href="../Contact/contact.html">Contact</a>Field('work', '212-555-1234', false);
+ phoneNumbers[1] = new <a href="../Contact/contact.html">Contact</a>Field('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new <a href="../Contact/contact.html">Contact</a>Field('home', '203-555-7890', false);
contact.phoneNumbers = phoneNumbers;
// save the contact
contact.save();
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../../device/device.html">Device</a>Ready() {
// create a new contact
- var contact = navigator.contacts.create();
+ var contact = navigator.<a href="../contacts.create.html">contacts.create</a>();
- // store contact phone numbers in ContactField[]
+ // store contact phone numbers in <a href="../Contact/contact.html">Contact</a>Field[]
var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
+ phoneNumbers[0] = new <a href="../Contact/contact.html">Contact</a>Field('work', '212-555-1234', false);
+ phoneNumbers[1] = new <a href="../Contact/contact.html">Contact</a>Field('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new <a href="../Contact/contact.html">Contact</a>Field('home', '203-555-7890', false);
contact.phoneNumbers = phoneNumbers;
// save the contact
contact.save();
// search contacts, returning display name and phone numbers
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter="";
filter = ["displayName","phoneNumbers"];
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -114,15 +114,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.7.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.7.0/cordova/contacts/ContactFindOptions/contactfindoptions.md b/www/docs/en/1.7.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
index e1c6647..6be2647 100644
--- a/www/docs/en/1.7.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/www/docs/en/1.7.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-ContactFindOptions
+<a href="../Contact/contact.html">Contact</a>FindOptions
==================
-Contains properties that can be used to filter the results of a `contacts.find` operation.
+Contains properties that can be used to filter the results of a `<a href="../contacts.find.html">contacts.find</a>` operation.
Properties
----------
@@ -38,7 +38,7 @@ Supported Platforms
- iOS
- Bada 1.2
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
// success callback
@@ -49,45 +49,45 @@ Quick Example
};
// error callback
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
};
// specify contact search criteria
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter=""; // empty search string returns all contacts
options.multiple=true; // return multiple results
filter = ["displayName"]; // return contact.displayName field
// find contacts
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Contact Example</title>
+ <title><a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.7.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../../device/device.html">Device</a>Ready() {
// specify contact search criteria
- var options = new ContactFindOptions();
+ var options = new <a href="../Contact/contact.html">Contact</a>FindOptions();
options.filter=""; // empty search string returns all contacts
options.multiple=true; // return multiple results
filter = ["displayName"]; // return contact.displayName field
// find contacts
- navigator.contacts.find(filter, onSuccess, onError, options);
+ navigator.<a href="../contacts.find.html">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
@@ -100,15 +100,15 @@ Full Example
// onError: Failed to get the contacts
//
- function onError(contactError) {
+ function onError(<a href="../parameters/contactError.html">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
- <h1>Example</h1>
- <p>Find Contacts</p>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <p>Find <a href="../Contact/contact.html">Contact</a>s</p>
</body>
</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org