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/10/19 21:00:48 UTC
[24/52] [partial] docs commit: Making links in docs manual instead of
automatic.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/contacts/contacts.find.md b/www/docs/en/2.0.0/cordova/contacts/contacts.find.md
index 8b43e6e..0325a34 100644
--- a/www/docs/en/2.0.0/cordova/contacts/contacts.find.md
+++ b/www/docs/en/2.0.0/cordova/contacts/contacts.find.md
@@ -23,23 +23,23 @@ title: contacts.find
contacts.find
=============
-Queries the device contacts database and returns one or more `Contact` objects, each containing the fields specified.
+Queries the device contacts database and returns one or more `[Contact](Contact/contact.html)` objects, each containing the fields specified.
navigator.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions);
Description
-----------
-contacts.find is an asynchronous function that queries the device contacts database and returns an array of `Contact` objects. The resulting objects are passed to the `contactSuccess` callback function specified by the __contactSuccess__ parameter.
+contacts.find is an asynchronous function that queries the device contacts database and returns an array of `[Contact](Contact/contact.html)` objects. The resulting objects are passed to the `[contactSuccess](parameters/contactSuccess.html)` callback function specified by the __contactSuccess__ parameter.
-Users must specify the contact fields to be used as a search qualifier in the __contactFields__ parameter. Only the fields specified in the __contactFields__ parameter will be returned as properties of the `Contact` objects that are passed to the __contactSuccess__ callback function. A zero-length __contactFields__ parameter will result in an array of `Contact` objects with only the `id` property populated. A __contactFields__ value of ["*"] will return all contact fields.
+Users must specify the contact fields to be used as a search qualifier in the __contactFields__ parameter. Only the fields specified in the __contactFields__ parameter will be returned as properties of the `[Contact](Contact/contact.html)` objects that are passed to the __contactSuccess__ callback function. A zero-length __contactFields__ parameter will result in an array of `[Contact](Contact/contact.html)` objects with only the `id` property populated. A __contactFields__ value of ["*"] will return all contact fields.
The __contactFindOptions.filter__ string can be used as a search filter when querying the contacts database. If provided, a case-insensitive, partial value match is applied to each field specified in the __contactFields__ parameter. If a match is found in a comparison with _any_ of the specified fields, the contact is returned.
Parameters
----------
-- __contactFields:__ Contact fields to be used as search qualifier. Only these fields will have values in the resulting `Contact` objects. _(DOMString[])_ [Required]
+- __contactFields:__ [Contact](Contact/contact.html) fields to be used as search qualifier. Only these fields will have values in the resulting `[Contact](Contact/contact.html)` objects. _(DOMString[])_ [Required]
- __contactSuccess:__ Success callback function that is invoked with the contacts returned from the contacts database. [Required]
- __contactError:__ Error callback function. Invoked when error occurs. [Optional]
- __contactFindOptions:__ Search options to filter contacts. [Optional]
@@ -52,7 +52,7 @@ Supported Platforms
- iOS
- Bada 1.2 & 2.0
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
function onSuccess(contacts) {
@@ -69,7 +69,7 @@ Quick Example
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -88,7 +88,7 @@ Full Example
//
function onDeviceReady() {
// find all contacts with 'Bob' in any name field
- var options = new ContactFindOptions();
+ var options = new [ContactFindOptions](ContactFindOptions/contactfindoptions.html)();
options.filter="Bob";
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/contacts/contacts.md b/www/docs/en/2.0.0/cordova/contacts/contacts.md
index 0b4e923..a3c3b7d 100644
--- a/www/docs/en/2.0.0/cordova/contacts/contacts.md
+++ b/www/docs/en/2.0.0/cordova/contacts/contacts.md
@@ -28,27 +28,27 @@ Contacts
Methods
-------
-- contacts.create
-- contacts.find
+- [contacts.create](contacts.create.html)
+- [contacts.find](contacts.find.html)
Arguments
---------
-- contactFields
-- contactSuccess
-- contactError
-- contactFindOptions
+- [contactFields](parameters/contactFields.html)
+- [contactSuccess](parameters/contactSuccess.html)
+- [contactError](parameters/contactError.html)
+- [contactFindOptions](parameters/contactFindOptions.html)
Objects
-------
-- Contact
-- ContactName
-- ContactField
-- ContactAddress
-- ContactOrganization
-- ContactFindOptions
-- ContactError
+- [Contact](Contact/contact.html)
+- [ContactName](ContactName/contactname.html)
+- [ContactField](ContactField/contactfield.html)
+- [ContactAddress](ContactAddress/contactaddress.html)
+- [ContactOrganization](ContactOrganization/contactorganization.html)
+- [ContactFindOptions](ContactFindOptions/contactfindoptions.html)
+- [ContactError](ContactError/contactError.html)
Permissions
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/contacts/parameters/contactFields.md b/www/docs/en/2.0.0/cordova/contacts/parameters/contactFields.md
index ae27dd7..368541b 100644
--- a/www/docs/en/2.0.0/cordova/contacts/parameters/contactFields.md
+++ b/www/docs/en/2.0.0/cordova/contacts/parameters/contactFields.md
@@ -23,6 +23,6 @@ title: contactFields
contactFields
=============
-Required parameter of the `contacts.find` method. Use this parameter to specify which fields should be included in the `Contact` objects resulting from a find operation.
+Required parameter of the `[contacts.find](../contacts.find.html)` method. Use this parameter to specify which fields should be included in the `[Contact](../Contact/contact.html)` objects resulting from a find operation.
["name", "phoneNumbers", "emails"]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/contacts/parameters/contactFindOptions.md b/www/docs/en/2.0.0/cordova/contacts/parameters/contactFindOptions.md
index b166110..9459ec4 100644
--- a/www/docs/en/2.0.0/cordova/contacts/parameters/contactFindOptions.md
+++ b/www/docs/en/2.0.0/cordova/contacts/parameters/contactFindOptions.md
@@ -23,7 +23,7 @@ title: contactFindOptions
contactFindOptions
==================
-Optional parameter of the `contacts.find` method. Use this parameter to filter the contacts returned from the contacts database.
+Optional parameter of the `[contacts.find](../contacts.find.html)` method. Use this parameter to filter the contacts returned from the contacts database.
{
filter: "",
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/contacts/parameters/contactSuccess.md b/www/docs/en/2.0.0/cordova/contacts/parameters/contactSuccess.md
index 22137b6..6b5204c 100644
--- a/www/docs/en/2.0.0/cordova/contacts/parameters/contactSuccess.md
+++ b/www/docs/en/2.0.0/cordova/contacts/parameters/contactSuccess.md
@@ -23,7 +23,7 @@ title: contactSuccess
contactSuccess
==============
-Success callback function that provides the `Contact` array resulting from a `contacts.find` operation.
+Success callback function that provides the `[Contact](../Contact/contact.html)` array resulting from a `[contacts.find](../contacts.find.html)` operation.
function(contacts) {
// Do something
@@ -32,9 +32,9 @@ Success callback function that provides the `Contact` array resulting from a `co
Parameters
----------
-- __contacts:__ The contact array resulting from a find operation. (`Contact`)
+- __contacts:__ The contact array resulting from a find operation. (`[Contact](../Contact/contact.html)`)
-Example
+[Example](../../storage/storage.opendatabase.html)
-------
function contactSuccess(contacts) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/device/device.cordova.md b/www/docs/en/2.0.0/cordova/device/device.cordova.md
index 905eccc..07b767e 100644
--- a/www/docs/en/2.0.0/cordova/device/device.cordova.md
+++ b/www/docs/en/2.0.0/cordova/device/device.cordova.md
@@ -41,12 +41,12 @@ Supported Platforms
- Windows Phone 7 ( Mango )
- Bada 1.2 & 2.x
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
var name = device.cordova;
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/device/device.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/device/device.md b/www/docs/en/2.0.0/cordova/device/device.md
index ea0873f..0e0ec3e 100644
--- a/www/docs/en/2.0.0/cordova/device/device.md
+++ b/www/docs/en/2.0.0/cordova/device/device.md
@@ -28,11 +28,11 @@ Device
Properties
----------
-- device.name
-- device.cordova
-- device.platform
-- device.uuid
-- device.version
+- [device.name](device.name.html)
+- [device.cordova](device.cordova.html)
+- [device.platform](device.platform.html)
+- [device.uuid](device.uuid.html)
+- [device.version](device.version.html)
Variable Scope
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/device/device.name.md b/www/docs/en/2.0.0/cordova/device/device.name.md
index d9505a3..141dd68 100644
--- a/www/docs/en/2.0.0/cordova/device/device.name.md
+++ b/www/docs/en/2.0.0/cordova/device/device.name.md
@@ -42,7 +42,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Android: Nexus One returns "Passion" (Nexus One code name)
@@ -52,7 +52,7 @@ Quick Example
//
var name = device.name;
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/device/device.platform.md b/www/docs/en/2.0.0/cordova/device/device.platform.md
index 12d5c29..796a47a 100644
--- a/www/docs/en/2.0.0/cordova/device/device.platform.md
+++ b/www/docs/en/2.0.0/cordova/device/device.platform.md
@@ -37,7 +37,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Depending on the device, a few examples are:
@@ -48,7 +48,7 @@ Quick Example
// - "WinCE"
var devicePlatform = device.platform;
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/device/device.uuid.md b/www/docs/en/2.0.0/cordova/device/device.uuid.md
index fa33a0a..025b640 100644
--- a/www/docs/en/2.0.0/cordova/device/device.uuid.md
+++ b/www/docs/en/2.0.0/cordova/device/device.uuid.md
@@ -42,7 +42,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Android: Returns a random 64-bit integer (as a string, again!)
@@ -61,7 +61,7 @@ Quick Example
// webOS: returns the device NDUID
var deviceID = device.uuid;
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/device/device.version.md b/www/docs/en/2.0.0/cordova/device/device.version.md
index 9df080b..08d35ef 100644
--- a/www/docs/en/2.0.0/cordova/device/device.version.md
+++ b/www/docs/en/2.0.0/cordova/device/device.version.md
@@ -37,7 +37,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Android: Froyo OS would return "2.2"
@@ -52,7 +52,7 @@ Quick Example
// webOS: webOS 2.2.4 return 2.2.4
var deviceVersion = device.version;
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.backbutton.md b/www/docs/en/2.0.0/cordova/events/events.backbutton.md
index 7e5dd34..83e6dac 100644
--- a/www/docs/en/2.0.0/cordova/events/events.backbutton.md
+++ b/www/docs/en/2.0.0/cordova/events/events.backbutton.md
@@ -32,7 +32,7 @@ Details
If you need to override the default back button behaviour you can register an event listener for the 'backbutton' event. It is no longer necessary to call any other method to over ride the back button behaviour. Now, you only need to register an event listener for 'backbutton'.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("backbutton", onBackKeyDown, false);
@@ -50,7 +50,7 @@ Quick Example
// Handle the back button
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.batterycritical.md b/www/docs/en/2.0.0/cordova/events/events.batterycritical.md
index 3d3d030..83d8549 100644
--- a/www/docs/en/2.0.0/cordova/events/events.batterycritical.md
+++ b/www/docs/en/2.0.0/cordova/events/events.batterycritical.md
@@ -37,7 +37,7 @@ The batterycritical handler will be called with an object that contains two prop
- __level:__ The percentage of battery (0-100). _(Number)_
- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
-Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
window.addEventListener("batterycritical", onBatteryCritical, false);
@@ -56,7 +56,7 @@ Quick Example
alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.batterylow.md b/www/docs/en/2.0.0/cordova/events/events.batterylow.md
index 731c310..fafe6dd 100644
--- a/www/docs/en/2.0.0/cordova/events/events.batterylow.md
+++ b/www/docs/en/2.0.0/cordova/events/events.batterylow.md
@@ -37,7 +37,7 @@ The batterylow handler will be called with an object that contains two propertie
- __level:__ The percentage of battery (0-100). _(Number)_
- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
window.addEventListener("batterylow", onBatteryLow, false);
@@ -56,7 +56,7 @@ Quick Example
alert("Battery Level Low " + info.level + "%");
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.batterystatus.md b/www/docs/en/2.0.0/cordova/events/events.batterystatus.md
index 386b857..70f9612 100644
--- a/www/docs/en/2.0.0/cordova/events/events.batterystatus.md
+++ b/www/docs/en/2.0.0/cordova/events/events.batterystatus.md
@@ -37,7 +37,7 @@ The battery status handler will be called with an object that contains two prope
- __level:__ The percentage of battery (0-100). _(Number)_
- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
-Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -55,7 +55,7 @@ The `level` property is unavailable as Windows Phone 7 does not provide
native APIs for determining battery level. The `isPlugged` parameter
_is_ supported.
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
window.addEventListener("batterystatus", onBatteryStatus, false);
@@ -65,7 +65,7 @@ Quick Example
console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.deviceready.md b/www/docs/en/2.0.0/cordova/events/events.deviceready.md
index 0faffaa..17363cd 100644
--- a/www/docs/en/2.0.0/cordova/events/events.deviceready.md
+++ b/www/docs/en/2.0.0/cordova/events/events.deviceready.md
@@ -47,7 +47,7 @@ Supported Platforms
- Windows Phone 7
- Bada 1.2 & 2.x
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("deviceready", onDeviceReady, false);
@@ -56,7 +56,7 @@ Quick Example
// Now safe to use the Cordova API
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.endcallbutton.md b/www/docs/en/2.0.0/cordova/events/events.endcallbutton.md
index 48974c5..9e75d6d 100644
--- a/www/docs/en/2.0.0/cordova/events/events.endcallbutton.md
+++ b/www/docs/en/2.0.0/cordova/events/events.endcallbutton.md
@@ -32,14 +32,14 @@ Details
If you need to override the default end call behaviour you can register an event listener for the 'endcallbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("endcallbutton", onEndCallKeyDown, false);
@@ -48,7 +48,7 @@ Quick Example
// Handle the end call button
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.md b/www/docs/en/2.0.0/cordova/events/events.md
index ae7cc8c..32d048a 100644
--- a/www/docs/en/2.0.0/cordova/events/events.md
+++ b/www/docs/en/2.0.0/cordova/events/events.md
@@ -28,21 +28,21 @@ Events
Event Types
-----------
-- deviceready
-- pause
-- resume
-- online
-- offline
-- backbutton
-- batterycritical
-- batterylow
-- batterystatus
-- menubutton
-- searchbutton
-- startcallbutton
-- endcallbutton
-- volumedownbutton
-- volumeupbutton
+- [deviceready](events.deviceready.html)
+- [pause](events.pause.html)
+- [resume](events.resume.html)
+- [online](events.online.html)
+- [offline](events.offline.html)
+- [backbutton](events.backbutton.html)
+- [batterycritical](events.batterycritical.html)
+- [batterylow](events.batterylow.html)
+- [batterystatus](events.batterystatus.html)
+- [menubutton](events.menubutton.html)
+- [searchbutton](events.searchbutton.html)
+- [startcallbutton](events.startcallbutton.html)
+- [endcallbutton](events.endcallbutton.html)
+- [volumedownbutton](events.volumedownbutton.html)
+- [volumeupbutton](events.volumeupbutton.html)
Permissions
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.menubutton.md b/www/docs/en/2.0.0/cordova/events/events.menubutton.md
index f27bab9..5d69bdf 100644
--- a/www/docs/en/2.0.0/cordova/events/events.menubutton.md
+++ b/www/docs/en/2.0.0/cordova/events/events.menubutton.md
@@ -32,7 +32,7 @@ Details
If you need to override the default menu button behaviour you can register an event listener for the 'menubutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("menubutton", onMenuKeyDown, false);
@@ -49,7 +49,7 @@ Quick Example
// Handle the back button
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.offline.md b/www/docs/en/2.0.0/cordova/events/events.offline.md
index 574f345..c5b7760 100644
--- a/www/docs/en/2.0.0/cordova/events/events.offline.md
+++ b/www/docs/en/2.0.0/cordova/events/events.offline.md
@@ -32,7 +32,7 @@ Details
When the application's network connection changes to being offline, the offline event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -42,7 +42,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("offline", onOffline, false);
@@ -51,7 +51,7 @@ Quick Example
// Handle the offline event
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.online.md b/www/docs/en/2.0.0/cordova/events/events.online.md
index 60800b8..28c7b3e 100644
--- a/www/docs/en/2.0.0/cordova/events/events.online.md
+++ b/www/docs/en/2.0.0/cordova/events/events.online.md
@@ -32,7 +32,7 @@ Details
When the application's network connection changes to being online, the online event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -42,7 +42,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("online", onOnline, false);
@@ -51,7 +51,7 @@ Quick Example
// Handle the online event
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.pause.md b/www/docs/en/2.0.0/cordova/events/events.pause.md
index 509a264..d0bbb34 100644
--- a/www/docs/en/2.0.0/cordova/events/events.pause.md
+++ b/www/docs/en/2.0.0/cordova/events/events.pause.md
@@ -32,7 +32,7 @@ Details
Cordova consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -42,7 +42,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("pause", onPause, false);
@@ -51,7 +51,7 @@ Quick Example
// Handle the pause event
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.resume.md b/www/docs/en/2.0.0/cordova/events/events.resume.md
index afeeadf..fe21183 100644
--- a/www/docs/en/2.0.0/cordova/events/events.resume.md
+++ b/www/docs/en/2.0.0/cordova/events/events.resume.md
@@ -32,7 +32,7 @@ Details
Cordova consists of two code bases: native and JavaScript. While the native code pulls the application from the background the resume event is fired.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -42,7 +42,7 @@ Supported Platforms
- iOS
- Windows Phone 7
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("resume", onResume, false);
@@ -51,7 +51,7 @@ Quick Example
// Handle the resume event
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.searchbutton.md b/www/docs/en/2.0.0/cordova/events/events.searchbutton.md
index 336f53f..5d2b273 100644
--- a/www/docs/en/2.0.0/cordova/events/events.searchbutton.md
+++ b/www/docs/en/2.0.0/cordova/events/events.searchbutton.md
@@ -32,14 +32,14 @@ Details
If you need to override the default search button behaviour on Android you can register an event listener for the 'searchbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
- Android
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("searchbutton", onSearchKeyDown, false);
@@ -48,7 +48,7 @@ Quick Example
// Handle the search button
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.startcallbutton.md b/www/docs/en/2.0.0/cordova/events/events.startcallbutton.md
index ed480fd..1168477 100644
--- a/www/docs/en/2.0.0/cordova/events/events.startcallbutton.md
+++ b/www/docs/en/2.0.0/cordova/events/events.startcallbutton.md
@@ -32,14 +32,14 @@ Details
If you need to override the default start call behaviour you can register an event listener for the 'startcallbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("startcallbutton", onStartCallKeyDown, false);
@@ -48,7 +48,7 @@ Quick Example
// Handle the start call button
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.volumedownbutton.md b/www/docs/en/2.0.0/cordova/events/events.volumedownbutton.md
index 8c14c80..a2e54c1 100644
--- a/www/docs/en/2.0.0/cordova/events/events.volumedownbutton.md
+++ b/www/docs/en/2.0.0/cordova/events/events.volumedownbutton.md
@@ -32,14 +32,14 @@ Details
If you need to override the default volume down behaviour you can register an event listener for the 'volumedownbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
@@ -48,7 +48,7 @@ Quick Example
// Handle the volume down button
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/events/events.volumeupbutton.md b/www/docs/en/2.0.0/cordova/events/events.volumeupbutton.md
index 2969d41..7c13fd5 100644
--- a/www/docs/en/2.0.0/cordova/events/events.volumeupbutton.md
+++ b/www/docs/en/2.0.0/cordova/events/events.volumeupbutton.md
@@ -32,14 +32,14 @@ Details
If you need to override the default volume up behaviour you can register an event listener for the 'volumeupbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
@@ -48,7 +48,7 @@ Quick Example
// Handle the volume up button
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/directoryentry/directoryentry.md b/www/docs/en/2.0.0/cordova/file/directoryentry/directoryentry.md
index 6bcedf1..895c644 100644
--- a/www/docs/en/2.0.0/cordova/file/directoryentry/directoryentry.md
+++ b/www/docs/en/2.0.0/cordova/file/directoryentry/directoryentry.md
@@ -49,7 +49,7 @@ The following methods can be invoked on a DirectoryEntry object:
- __toURL__: Return a URL that can be used to locate a directory.
- __remove__: Delete a directory. The directory must be empty.
- __getParent__: Look up the parent directory.
-- __createReader__: Create a new DirectoryReader that can read entries from a directory.
+- __createReader__: Create a new [DirectoryReader](../directoryreader/directoryreader.html) that can read entries from a directory.
- __getDirectory__: Create or look up a directory.
- __getFile__: Create or look up a file.
- __removeRecursively__: Delete a directory and all of its contents.
@@ -70,8 +70,8 @@ Look up metadata about a directory.
__Parameters:__
-- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is called with a [Metadata](../metadata/metadata.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the [Metadata](../metadata/metadata.html). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -134,7 +134,7 @@ __Parameters:__
- __parent__ - The parent directory to which to move the directory. _(DirectoryEntry)_
- __newName__ - The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to move the directory. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to move the directory. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -172,7 +172,7 @@ __Parameters:__
- __parent__ - The parent directory to which to copy the directory. _(DirectoryEntry)_
- __newName__ - The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the underlying directory. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the underlying directory. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -219,7 +219,7 @@ Deletes a directory. It is an error to attempt to:
__Parameters:__
- __successCallback__ - A callback that is called after the directory has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the directory. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the directory. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -243,7 +243,7 @@ Look up the parent DirectoryEntry containing the directory.
__Parameters:__
- __successCallback__ - A callback that is called with the directory's parent DirectoryEntry. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -262,7 +262,7 @@ __Quick Example__
createReader
------------
-Creates a new DirectoryReader to read entries in a directory.
+Creates a new [DirectoryReader](../directoryreader/directoryreader.html) to read entries in a directory.
__Quick Example__
@@ -282,7 +282,7 @@ __Parameters:__
- __path__ - The path to the directory to be looked up or created. Either an absolute path, or a relative path from this DirectoryEntry. _(DOMString)_
- __options__ - Options to specify whether the directory is created if it doesn't exist. _(Flags)_
- __successCallback__ - A callback that is invoked with a DirectoryEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs creating or looking up the directory. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs creating or looking up the directory. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -309,8 +309,8 @@ __Parameters:__
- __path__ - The path to the file to be looked up or created. Either an absolute path, or a relative path from this DirectoryEntry. _(DOMString)_
- __options__ - Options to specify whether the file is created if it doesn't exist. _(Flags)_
-- __successCallback__ - A callback that is invoked with a FileEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs creating or looking up the file. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is invoked with a [FileEntry](../fileentry/fileentry.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs creating or looking up the file. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -338,7 +338,7 @@ be deleted. It is an error to attempt to:
__Parameters:__
- __successCallback__ - A callback that is called after the DirectoryEntry has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the DirectoryEntry. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the DirectoryEntry. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/directoryreader/directoryreader.md b/www/docs/en/2.0.0/cordova/file/directoryreader/directoryreader.md
index 72b6b10..facd75b 100644
--- a/www/docs/en/2.0.0/cordova/file/directoryreader/directoryreader.md
+++ b/www/docs/en/2.0.0/cordova/file/directoryreader/directoryreader.md
@@ -46,8 +46,8 @@ Read the entries in this directory.
__Parameters:__
-- __successCallback__ - A callback that is passed an array of FileEntry and DirectoryEntry objects. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the directory listing. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is passed an array of [FileEntry](../fileentry/fileentry.html) and [DirectoryEntry](../directoryentry/directoryentry.html) objects. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the directory listing. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/file.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/file.md b/www/docs/en/2.0.0/cordova/file/file.md
index e56b420..008f78c 100644
--- a/www/docs/en/2.0.0/cordova/file/file.md
+++ b/www/docs/en/2.0.0/cordova/file/file.md
@@ -20,7 +20,7 @@ license: >
title: File
---
-File
+[File](fileobj/fileobj.html)
==========
> This API is based on the W3C [File API](http://www.w3.org/TR/FileAPI). An API to read, write and navigate file system hierarchies.
@@ -28,21 +28,21 @@ File
Objects
-------
-- DirectoryEntry
-- DirectoryReader
-- File
-- FileEntry
-- FileError
-- FileReader
-- FileSystem
-- FileTransfer
-- FileTransferError
-- FileUploadOptions
-- FileUploadResult
-- FileWriter
-- Flags
-- LocalFileSystem
-- Metadata
+- [DirectoryEntry](directoryentry/directoryentry.html)
+- [DirectoryReader](directoryreader/directoryreader.html)
+- [File](fileobj/fileobj.html)
+- [FileEntry](fileentry/fileentry.html)
+- [FileError](fileerror/fileerror.html)
+- [FileReader](filereader/filereader.html)
+- [FileSystem](filesystem/filesystem.html)
+- [FileTransfer](filetransfer/filetransfer.html)
+- [FileTransferError](filetransfererror/filetransfererror.html)
+- [FileUploadOptions](fileuploadoptions/fileuploadoptions.html)
+- [FileUploadResult](fileuploadresult/fileuploadresult.html)
+- [FileWriter](filewriter/filewriter.html)
+- [Flags](flags/flags.html)
+- [LocalFileSystem](localfilesystem/localfilesystem.html)
+- [Metadata](metadata/metadata.html)
Permissions
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/fileentry/fileentry.md b/www/docs/en/2.0.0/cordova/file/fileentry/fileentry.md
index d6823c7..3d74772 100644
--- a/www/docs/en/2.0.0/cordova/file/fileentry/fileentry.md
+++ b/www/docs/en/2.0.0/cordova/file/fileentry/fileentry.md
@@ -48,8 +48,8 @@ Methods
- __toURL__: Return a URL that can be used to locate a file.
- __remove__: Delete a file.
- __getParent__: Look up the parent directory.
-- __createWriter__: Creates a FileWriter object that can be used to write to a file.
-- __file__: Creates a File object containing file properties.
+- __createWriter__: Creates a [FileWriter](../filewriter/filewriter.html) object that can be used to write to a file.
+- __file__: Creates a [File](../fileobj/fileobj.html) object containing file properties.
Supported Platforms
@@ -68,8 +68,8 @@ Look up metadata about a file.
__Parameters:__
-- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is called with a [Metadata](../metadata/metadata.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the [Metadata](../metadata/metadata.html). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -131,7 +131,7 @@ __Parameters:__
- __parent__ - The parent directory to which to move the file. _(DirectoryEntry)_
- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -166,7 +166,7 @@ __Parameters:__
- __parent__ - The parent directory to which to copy the file. _(DirectoryEntry)_
- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -209,7 +209,7 @@ Deletes a file.
__Parameters:__
- __successCallback__ - A callback that is called after the file has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -228,12 +228,12 @@ __Quick Example__
getParent
---------
-Look up the parent DirectoryEntry containing the file.
+Look up the parent [DirectoryEntry](../directoryentry/directoryentry.html) containing the file.
__Parameters:__
-- __successCallback__ - A callback that is called with the file's parent DirectoryEntry. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is called with the file's parent [DirectoryEntry](../directoryentry/directoryentry.html). _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent [DirectoryEntry](../directoryentry/directoryentry.html). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -252,12 +252,12 @@ __Quick Example__
createWriter
------------
-Create a FileWriter object associated with the file that the FileEntry represents.
+Create a [FileWriter](../filewriter/filewriter.html) object associated with the file that the FileEntry represents.
__Parameters:__
-- __successCallback__ - A callback that is called with a FileWriter object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs while attempting to create the FileWriter. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is called with a [FileWriter](../filewriter/filewriter.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs while attempting to create the [FileWriter](../filewriter/filewriter.html). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -276,12 +276,12 @@ __Quick Example__
file
----
-Return a File object that represents the current state of the file that this FileEntry represents.
+Return a [File](../fileobj/fileobj.html) object that represents the current state of the file that this FileEntry represents.
__Parameters:__
-- __successCallback__ - A callback that is called with a File object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when creating the File object (e.g. the underlying file no longer exists). Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is called with a [File](../fileobj/fileobj.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when creating the [File](../fileobj/fileobj.html) object (e.g. the underlying file no longer exists). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/fileerror/fileerror.md b/www/docs/en/2.0.0/cordova/file/fileerror/fileerror.md
index dac6d35..3a4068c 100644
--- a/www/docs/en/2.0.0/cordova/file/fileerror/fileerror.md
+++ b/www/docs/en/2.0.0/cordova/file/fileerror/fileerror.md
@@ -23,7 +23,7 @@ title: FileError
FileError
========
-A 'FileError' object is set when an error occurs in any of the File API methods.
+A 'FileError' object is set when an error occurs in any of the [File](../fileobj/fileobj.html) API methods.
Properties
----------
@@ -49,4 +49,4 @@ Constants
Description
-----------
-The `FileError` object is the only parameter of any of the File API's error callbacks. Developers must read the code property to determine the type of error.
\ No newline at end of file
+The `FileError` object is the only parameter of any of the [File](../fileobj/fileobj.html) API's error callbacks. Developers must read the code property to determine the type of error.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/fileobj/fileobj.md b/www/docs/en/2.0.0/cordova/file/fileobj/fileobj.md
index 3dedfd3..d6ff638 100644
--- a/www/docs/en/2.0.0/cordova/file/fileobj/fileobj.md
+++ b/www/docs/en/2.0.0/cordova/file/fileobj/fileobj.md
@@ -37,7 +37,7 @@ Properties
Details
-------
-The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `FileEntry` object.
+The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `[FileEntry](../fileentry/fileentry.html)` object.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/filereader/filereader.md b/www/docs/en/2.0.0/cordova/file/filereader/filereader.md
index 8054f6a..3a01cd6 100644
--- a/www/docs/en/2.0.0/cordova/file/filereader/filereader.md
+++ b/www/docs/en/2.0.0/cordova/file/filereader/filereader.md
@@ -65,7 +65,7 @@ __Parameters:__
- file - the file object to read
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
function win(file) {
@@ -91,7 +91,7 @@ __Parameters:__
- file - the file object to read
- encoding - the encoding to use to encode the file's content. Default is UTF8.
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
function win(file) {
@@ -109,7 +109,7 @@ Quick Example
entry.file(win, fail);
-Abort Quick Example
+Abort Quick [Example](../../storage/storage.opendatabase.html)
-------------------
function win(file) {
@@ -128,7 +128,7 @@ Abort Quick Example
entry.file(win, fail);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -148,7 +148,7 @@ Full Example
// Cordova is ready
//
function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
+ window.requestFileSystem([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, 0, gotFS, fail);
}
function gotFS(fileSystem) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/filesystem/filesystem.md b/www/docs/en/2.0.0/cordova/file/filesystem/filesystem.md
index 81a376c..af3eb47 100644
--- a/www/docs/en/2.0.0/cordova/file/filesystem/filesystem.md
+++ b/www/docs/en/2.0.0/cordova/file/filesystem/filesystem.md
@@ -34,7 +34,7 @@ Properties
Details
-------
-The `FileSystem` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `DirectoryEntry` object which represents the root directory of the file system.
+The `FileSystem` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `[DirectoryEntry](../directoryentry/directoryentry.html)` object which represents the root directory of the file system.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-File System Quick Example
+[File](../fileobj/fileobj.html) System Quick [Example](../../storage/storage.opendatabase.html)
-------------------------
function onSuccess(fileSystem) {
@@ -53,9 +53,9 @@ File System Quick Example
}
// request the persistent file system
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, null);
+ window.requestFileSystem([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, 0, onSuccess, null);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -73,7 +73,7 @@ Full Example
// Cordova is ready
//
function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
+ window.requestFileSystem([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, 0, onFileSystemSuccess, fail);
}
function onFileSystemSuccess(fileSystem) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/filetransfer/filetransfer.md b/www/docs/en/2.0.0/cordova/file/filetransfer/filetransfer.md
index 30807b4..ec18a6d 100644
--- a/www/docs/en/2.0.0/cordova/file/filetransfer/filetransfer.md
+++ b/www/docs/en/2.0.0/cordova/file/filetransfer/filetransfer.md
@@ -39,7 +39,7 @@ Methods
Details
-------
-The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback will be called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object.
+The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a [FileUploadOptions](../fileuploadoptions/fileuploadoptions.html) object to the upload method. On successful upload, the success callback will be called with a [FileUploadResult](../fileuploadresult/fileuploadresult.html) object. If an error occurs, the error callback will be invoked with a [FileTransferError](../filetransfererror/filetransfererror.html) object.
It is also possible to download a file from remote and save it on the device (only iOS and Android).
Supported Platforms
@@ -57,8 +57,8 @@ __Parameters:__
- __filePath__ - Full path of the file on the device
- __server__ - URL of the server to receive the file (must already be encoded using encodeURI())
-- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_
+- __successCallback__ - A callback that is called with a [Metadata](../metadata/metadata.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the [Metadata](../metadata/metadata.html). Invoked with a [FileTransferError](../filetransfererror/filetransfererror.html) object. _(Function)_
- __options__ - Optional parameters such as file name and mimetype
__Quick Example__
@@ -77,7 +77,7 @@ __Quick Example__
console.log("upload error target " + error.target);
}
- var options = new FileUploadOptions();
+ var options = new [FileUploadOptions](../fileuploadoptions/fileuploadoptions.html)();
options.fileKey="file";
options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
options.mimeType="text/plain";
@@ -196,8 +196,8 @@ __Parameters:__
- __source__ - URL of the server to download the file (must already be encoded using encodeURI())
- __target__ - Full path of the file on the device
-- __successCallback__ - A callback that is called with a FileEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_
+- __successCallback__ - A callback that is called with a [FileEntry](../fileentry/fileentry.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the [Metadata](../metadata/metadata.html). Invoked with a [FileTransferError](../filetransfererror/filetransfererror.html) object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md b/www/docs/en/2.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md
index f03d86a..b064413 100644
--- a/www/docs/en/2.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/www/docs/en/2.0.0/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -23,7 +23,7 @@ title: FileUploadOptions
FileUploadOptions
========
-A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
+A `FileUploadOptions` object can be passed to the [FileTransfer](../filetransfer/filetransfer.html) objects upload method in order to specify additional parameters to the upload script.
Properties
----------
@@ -38,7 +38,7 @@ Properties
Description
-----------
-A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
+A `FileUploadOptions` object can be passed to the [FileTransfer](../filetransfer/filetransfer.html) objects upload method in order to specify additional parameters to the upload script.
WP7 Quirk
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/fileuploadresult/fileuploadresult.md b/www/docs/en/2.0.0/cordova/file/fileuploadresult/fileuploadresult.md
index de8f5c7..19fd630 100644
--- a/www/docs/en/2.0.0/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/www/docs/en/2.0.0/cordova/file/fileuploadresult/fileuploadresult.md
@@ -23,7 +23,7 @@ title: FileUploadResult
FileUploadResult
========
-A `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
+A `FileUploadResult` object is returned via the success callback of the [FileTransfer](../filetransfer/filetransfer.html) upload method.
Properties
----------
@@ -35,7 +35,7 @@ Properties
Description
-----------
-The `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
+The `FileUploadResult` object is returned via the success callback of the [FileTransfer](../filetransfer/filetransfer.html) upload method.
iOS Quirks
----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/filewriter/filewriter.md b/www/docs/en/2.0.0/cordova/file/filewriter/filewriter.md
index 9770e9c..b1a8ea4 100644
--- a/www/docs/en/2.0.0/cordova/file/filewriter/filewriter.md
+++ b/www/docs/en/2.0.0/cordova/file/filewriter/filewriter.md
@@ -63,7 +63,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Seek Quick Example
+Seek Quick [Example](../../storage/storage.opendatabase.html)
------------------------------
function win(writer) {
@@ -77,7 +77,7 @@ Seek Quick Example
entry.createWriter(win, fail);
-Truncate Quick Example
+Truncate Quick [Example](../../storage/storage.opendatabase.html)
--------------------------
function win(writer) {
@@ -90,7 +90,7 @@ Truncate Quick Example
entry.createWriter(win, fail);
-Write Quick Example
+Write Quick [Example](../../storage/storage.opendatabase.html)
-------------------
function win(writer) {
@@ -106,7 +106,7 @@ Write Quick Example
entry.createWriter(win, fail);
-Append Quick Example
+Append Quick [Example](../../storage/storage.opendatabase.html)
--------------------
function win(writer) {
@@ -123,7 +123,7 @@ Append Quick Example
entry.createWriter(win, fail);
-Abort Quick Example
+Abort Quick [Example](../../storage/storage.opendatabase.html)
-------------------
function win(writer) {
@@ -140,7 +140,7 @@ Abort Quick Example
entry.createWriter(win, fail);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/flags/flags.md b/www/docs/en/2.0.0/cordova/file/flags/flags.md
index 505b05c..4ce4be0 100644
--- a/www/docs/en/2.0.0/cordova/file/flags/flags.md
+++ b/www/docs/en/2.0.0/cordova/file/flags/flags.md
@@ -23,7 +23,7 @@ title: Flags
Flags
=====
-This object is used to supply arguments to the `DirectoryEntry` __getFile__ and __getDirectory__ methods, which look up or create files and directories, respectively.
+This object is used to supply arguments to the `[DirectoryEntry](../directoryentry/directoryentry.html)` __getFile__ and __getDirectory__ methods, which look up or create files and directories, respectively.
Properties
----------
@@ -39,7 +39,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// Get the data directory, creating it if it doesn't exist.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/localfilesystem/localfilesystem.md b/www/docs/en/2.0.0/cordova/file/localfilesystem/localfilesystem.md
index 464b022..e46ce4f 100644
--- a/www/docs/en/2.0.0/cordova/file/localfilesystem/localfilesystem.md
+++ b/www/docs/en/2.0.0/cordova/file/localfilesystem/localfilesystem.md
@@ -29,7 +29,7 @@ Methods
----------
- __requestFileSystem:__ Requests a filesystem. _(Function)_
-- __resolveLocalFileSystemURI:__ Retrieve a DirectoryEntry or FileEntry using local URI. _(Function)_
+- __resolveLocalFileSystemURI:__ Retrieve a [DirectoryEntry](../directoryentry/directoryentry.html) or [FileEntry](../fileentry/fileentry.html) using local URI. _(Function)_
Constants
---------
@@ -50,7 +50,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Request File System Quick Example
+Request [File](../fileobj/fileobj.html) System Quick [Example](../../storage/storage.opendatabase.html)
---------------------------------
function onSuccess(fileSystem) {
@@ -60,7 +60,7 @@ Request File System Quick Example
// request the persistent file system
window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);
-Resolve Local File System URI Quick Example
+Resolve Local [File](../fileobj/fileobj.html) System URI Quick [Example](../../storage/storage.opendatabase.html)
-------------------------------------------
function onSuccess(fileEntry) {
@@ -69,7 +69,7 @@ Resolve Local File System URI Quick Example
window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/file/metadata/metadata.md b/www/docs/en/2.0.0/cordova/file/metadata/metadata.md
index a4df999..3dda5b6 100644
--- a/www/docs/en/2.0.0/cordova/file/metadata/metadata.md
+++ b/www/docs/en/2.0.0/cordova/file/metadata/metadata.md
@@ -33,7 +33,7 @@ Properties
Details
-------
-The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `DirectoryEntry` or `FileEntry` object.
+The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `[DirectoryEntry](../directoryentry/directoryentry.html)` or `[FileEntry](../fileentry/fileentry.html)` object.
Supported Platforms
-------------------
@@ -43,7 +43,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
function win(metadata) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/geolocation/Coordinates/coordinates.md b/www/docs/en/2.0.0/cordova/geolocation/Coordinates/coordinates.md
index 33f658e..6724a1f 100644
--- a/www/docs/en/2.0.0/cordova/geolocation/Coordinates/coordinates.md
+++ b/www/docs/en/2.0.0/cordova/geolocation/Coordinates/coordinates.md
@@ -39,7 +39,7 @@ Properties
Description
-----------
-The `Coordinates` object is created and populated by Cordova, and attached to the `Position` object. The `Position` object is then returned to the user through a callback function.
+The `Coordinates` object is created and populated by Cordova, and attached to the `[Position](../Position/position.html)` object. The `[Position](../Position/position.html)` object is then returned to the user through a callback function.
Supported Platforms
-------------------
@@ -51,7 +51,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -75,7 +75,7 @@ Quick Example
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/geolocation/Position/position.md b/www/docs/en/2.0.0/cordova/geolocation/Position/position.md
index 126126c..69e6bbd 100644
--- a/www/docs/en/2.0.0/cordova/geolocation/Position/position.md
+++ b/www/docs/en/2.0.0/cordova/geolocation/Position/position.md
@@ -46,7 +46,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -71,7 +71,7 @@ Quick Example
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -107,7 +107,7 @@ Full Example
position.timestamp + '<br />';
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a [PositionError](../PositionError/positionError.html) object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/geolocation/PositionError/positionError.md b/www/docs/en/2.0.0/cordova/geolocation/PositionError/positionError.md
index 2f06723..db51351 100644
--- a/www/docs/en/2.0.0/cordova/geolocation/PositionError/positionError.md
+++ b/www/docs/en/2.0.0/cordova/geolocation/PositionError/positionError.md
@@ -23,7 +23,7 @@ title: PositionError
PositionError
========
-A `PositionError` object is returned to the `geolocationError` callback when an error occurs.
+A `PositionError` object is returned to the `[geolocationError](../parameters/geolocationError.html)` callback when an error occurs.
Properties
----------
@@ -41,7 +41,7 @@ Constants
Description
-----------
-The `PositionError` object is returned to the user through the `geolocationError` callback function when an error occurs with geolocation.
+The `PositionError` object is returned to the user through the `[geolocationError](../parameters/geolocationError.html)` callback function when an error occurs with geolocation.
### `PositionError.PERMISSION_DENIED`
@@ -57,6 +57,6 @@ satellite fix.
### `PositionError.TIMEOUT`
Returned when the device was unable to retrieve a position within the
-time specified in the `geolocationOptions`' `timeout` property. When using
-in conjunction with `geolocation.watchPosition`, this error could be
-called into the `geolocationError` callback every `timeout` milliseconds.
+time specified in the `[geolocationOptions](../parameters/geolocation.options.html)`' `timeout` property. When using
+in conjunction with `[geolocation.watchPosition](../geolocation.watchPosition.html)`, this error could be
+called into the `[geolocationError](../parameters/geolocationError.html)` callback every `timeout` milliseconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/geolocation/geolocation.clearWatch.md b/www/docs/en/2.0.0/cordova/geolocation/geolocation.clearWatch.md
index c00a19a..b343329 100644
--- a/www/docs/en/2.0.0/cordova/geolocation/geolocation.clearWatch.md
+++ b/www/docs/en/2.0.0/cordova/geolocation/geolocation.clearWatch.md
@@ -35,7 +35,7 @@ Parameters
Description
-----------
-`geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`.
+`geolocation.clearWatch` stops watching changes to the device's location by clearing the `[geolocation.watchPosition](geolocation.watchPosition.html)` referenced by `watchID`.
Supported Platforms
-------------------
@@ -47,7 +47,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Options: watch for changes in position, and use the most
@@ -60,7 +60,7 @@ Quick Example
navigator.geolocation.clearWatch(watchID);
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -104,7 +104,7 @@ Full Example
}
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a [PositionError](PositionError/positionError.html) object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/geolocation/geolocation.getCurrentPosition.md b/www/docs/en/2.0.0/cordova/geolocation/geolocation.getCurrentPosition.md
index 2df9080..9d301c4 100644
--- a/www/docs/en/2.0.0/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/www/docs/en/2.0.0/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -23,7 +23,7 @@ title: geolocation.getCurrentPosition
geolocation.getCurrentPosition
==============================
-Returns the device's current position as a `Position` object.
+Returns the device's current position as a `[Position](Position/position.html)` object.
navigator.geolocation.getCurrentPosition(geolocationSuccess,
[geolocationError],
@@ -39,7 +39,7 @@ Parameters
Description
-----------
-`geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `geolocationSuccess` callback with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
+`geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `[geolocationSuccess](parameters/geolocationSuccess.html)` callback with a `[Position](Position/position.html)` object as the parameter. If there is an error, the `[geolocationError](parameters/geolocationError.html)` callback is invoked with a `[PositionError](PositionError/positionError.html)` object.
Supported Platforms
@@ -52,7 +52,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -79,7 +79,7 @@ Quick Example
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -114,7 +114,7 @@ Full Example
'Timestamp: ' + position.timestamp + '<br />';
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a [PositionError](PositionError/positionError.html) object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/geolocation/geolocation.md b/www/docs/en/2.0.0/cordova/geolocation/geolocation.md
index 225a37f..72405ee 100644
--- a/www/docs/en/2.0.0/cordova/geolocation/geolocation.md
+++ b/www/docs/en/2.0.0/cordova/geolocation/geolocation.md
@@ -32,24 +32,24 @@ This API is based on the [W3C Geolocation API Specification](http://dev.w3.org/g
Methods
-------
-- geolocation.getCurrentPosition
-- geolocation.watchPosition
-- geolocation.clearWatch
+- [geolocation.getCurrentPosition](geolocation.getCurrentPosition.html)
+- [geolocation.watchPosition](geolocation.watchPosition.html)
+- [geolocation.clearWatch](geolocation.clearWatch.html)
Arguments
---------
-- geolocationSuccess
-- geolocationError
-- geolocationOptions
+- [geolocationSuccess](parameters/geolocationSuccess.html)
+- [geolocationError](parameters/geolocationError.html)
+- [geolocationOptions](parameters/geolocation.options.html)
Objects (Read-Only)
-------------------
-- Position
-- PositionError
-- Coordinates
+- [Position](Position/position.html)
+- [PositionError](PositionError/positionError.html)
+- [Coordinates](Coordinates/coordinates.html)
Permissions
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/geolocation/geolocation.watchPosition.md b/www/docs/en/2.0.0/cordova/geolocation/geolocation.watchPosition.md
index cb2c21d..c96c946 100644
--- a/www/docs/en/2.0.0/cordova/geolocation/geolocation.watchPosition.md
+++ b/www/docs/en/2.0.0/cordova/geolocation/geolocation.watchPosition.md
@@ -39,12 +39,12 @@ Parameters
Returns
-------
-- __String__: returns a watch id that references the watch position interval. The watch id should be used with `geolocation.clearWatch` to stop watching for changes in position.
+- __String__: returns a watch id that references the watch position interval. The watch id should be used with `[geolocation.clearWatch](geolocation.clearWatch.html)` to stop watching for changes in position.
Description
-----------
-`geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `geolocationSuccess` callback is invoked with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
+`geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `[geolocationSuccess](parameters/geolocationSuccess.html)` callback is invoked with a `[Position](Position/position.html)` object as the parameter. If there is an error, the `[geolocationError](parameters/geolocationError.html)` callback is invoked with a `[PositionError](PositionError/positionError.html)` object.
Supported Platforms
-------------------
@@ -56,7 +56,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -82,7 +82,7 @@ Quick Example
var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -116,7 +116,7 @@ Full Example
'<hr />' + element.innerHTML;
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a [PositionError](PositionError/positionError.html) object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocation.options.md b/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocation.options.md
index 65f3bd6..9af53c2 100644
--- a/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocation.options.md
+++ b/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocation.options.md
@@ -24,15 +24,15 @@ geolocationOptions
==================
Optional parameters to customize the retrieval of the geolocation
-`Position`.
+`[Position](../Position/position.html)`.
{ maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };
Options
-------
-- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a `Position` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
-- __timeout:__ The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback will be invoked with a `PositionError.TIMEOUT` error code. NOTE: when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds! _(Number)_
+- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a `[Position](../Position/position.html)` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
+- __timeout:__ The maximum length of time (milliseconds) that is allowed to pass from the call to `[geolocation.getCurrentPosition](../geolocation.getCurrentPosition.html)` or `[geolocation.watchPosition](../geolocation.watchPosition.html)` until the corresponding `[geolocationSuccess](geolocationSuccess.html)` callback is invoked. If the `[geolocationSuccess](geolocationSuccess.html)` callback is not invoked within this time, the `[geolocationError](geolocationError.html)` callback will be invoked with a `[PositionError](../PositionError/positionError.html).TIMEOUT` error code. NOTE: when used in conjunction with `[geolocation.watchPosition](../geolocation.watchPosition.html)`, the `[geolocationError](geolocationError.html)` callback could be called on an interval every `timeout` milliseconds! _(Number)_
- __maximumAge:__ Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
Android Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocationError.md b/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocationError.md
index 1cc1d9e..665914a 100644
--- a/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocationError.md
+++ b/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocationError.md
@@ -32,4 +32,4 @@ The user's callback function that is called when there is an error for geolocati
Parameters
----------
-- __error:__ The error returned by the device. (`PositionError`)
+- __error:__ The error returned by the device. (`[PositionError](../PositionError/positionError.html)`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocationSuccess.md b/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocationSuccess.md
index 6e6a063..fe96449 100644
--- a/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocationSuccess.md
+++ b/www/docs/en/2.0.0/cordova/geolocation/parameters/geolocationSuccess.md
@@ -23,7 +23,7 @@ title: geolocationSuccess
geolocationSuccess
==================
-The user's callback function that is called when a geolocation position becomes available (when using with `geolocation.getCurrentPosition`), or when the position changes (when using with `geolocation.watchPosition`).
+The user's callback function that is called when a geolocation position becomes available (when using with `[geolocation.getCurrentPosition](../geolocation.getCurrentPosition.html)`), or when the position changes (when using with `[geolocation.watchPosition](../geolocation.watchPosition.html)`).
function(position) {
// Do something
@@ -32,9 +32,9 @@ The user's callback function that is called when a geolocation position becomes
Parameters
----------
-- __position:__ The geolocation position returned by the device. (`Position`)
+- __position:__ The geolocation position returned by the device. (`[Position](../Position/position.html)`)
-Example
+[Example](../../storage/storage.opendatabase.html)
-------
function geolocationSuccess(position) {
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org