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:33 UTC
[09/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.5.0/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/device/device.platform.md b/www/docs/en/2.5.0/cordova/device/device.platform.md
index 0ed16a7..423bef2 100644
--- a/www/docs/en/2.5.0/cordova/device/device.platform.md
+++ b/www/docs/en/2.5.0/cordova/device/device.platform.md
@@ -39,7 +39,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Depending on the device, a few examples are:
@@ -51,7 +51,7 @@ Quick Example
// - "Tizen"
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.5.0/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/device/device.uuid.md b/www/docs/en/2.5.0/cordova/device/device.uuid.md
index d9aa256..7936dc1 100644
--- a/www/docs/en/2.5.0/cordova/device/device.uuid.md
+++ b/www/docs/en/2.5.0/cordova/device/device.uuid.md
@@ -44,7 +44,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Android: Returns a random 64-bit integer (as a string, again!)
@@ -66,7 +66,7 @@ Quick Example
// unique to every GSM and UMTS mobile phone.
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.5.0/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/device/device.version.md b/www/docs/en/2.5.0/cordova/device/device.version.md
index c774a6d..843b07c 100644
--- a/www/docs/en/2.5.0/cordova/device/device.version.md
+++ b/www/docs/en/2.5.0/cordova/device/device.version.md
@@ -39,7 +39,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Android: Froyo OS would return "2.2"
@@ -55,7 +55,7 @@ Quick Example
// Tizen: returns "TIZEN_20120425_2"
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.5.0/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.backbutton.md b/www/docs/en/2.5.0/cordova/events/events.backbutton.md
index 8314455..c695629 100644
--- a/www/docs/en/2.5.0/cordova/events/events.backbutton.md
+++ b/www/docs/en/2.5.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 and 8
-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.5.0/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.batterycritical.md b/www/docs/en/2.5.0/cordova/events/events.batterycritical.md
index a9aa69d..f8e4985 100644
--- a/www/docs/en/2.5.0/cordova/events/events.batterycritical.md
+++ b/www/docs/en/2.5.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
-------------------
@@ -47,7 +47,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- Tizen
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
window.addEventListener("batterycritical", onBatteryCritical, false);
@@ -57,7 +57,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.5.0/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.batterylow.md b/www/docs/en/2.5.0/cordova/events/events.batterylow.md
index 722771b..43b76a0 100644
--- a/www/docs/en/2.5.0/cordova/events/events.batterylow.md
+++ b/www/docs/en/2.5.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
-------------------
@@ -47,7 +47,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- Tizen
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
window.addEventListener("batterylow", onBatteryLow, false);
@@ -57,7 +57,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.5.0/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.batterystatus.md b/www/docs/en/2.5.0/cordova/events/events.batterystatus.md
index 7440553..1fa6a76 100644
--- a/www/docs/en/2.5.0/cordova/events/events.batterystatus.md
+++ b/www/docs/en/2.5.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.5.0/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.deviceready.md b/www/docs/en/2.5.0/cordova/events/events.deviceready.md
index 8fa903a..42e435e 100644
--- a/www/docs/en/2.5.0/cordova/events/events.deviceready.md
+++ b/www/docs/en/2.5.0/cordova/events/events.deviceready.md
@@ -51,7 +51,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("deviceready", onDeviceReady, false);
@@ -60,7 +60,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.5.0/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.endcallbutton.md b/www/docs/en/2.5.0/cordova/events/events.endcallbutton.md
index 60f647a..a22fc65 100644
--- a/www/docs/en/2.5.0/cordova/events/events.endcallbutton.md
+++ b/www/docs/en/2.5.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.5.0/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.md b/www/docs/en/2.5.0/cordova/events/events.md
index 0851a40..f64722b 100644
--- a/www/docs/en/2.5.0/cordova/events/events.md
+++ b/www/docs/en/2.5.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.5.0/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.menubutton.md b/www/docs/en/2.5.0/cordova/events/events.menubutton.md
index 18e7b57..af5ea01 100644
--- a/www/docs/en/2.5.0/cordova/events/events.menubutton.md
+++ b/www/docs/en/2.5.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.5.0/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.offline.md b/www/docs/en/2.5.0/cordova/events/events.offline.md
index 27a85f8..7a8bf26 100644
--- a/www/docs/en/2.5.0/cordova/events/events.offline.md
+++ b/www/docs/en/2.5.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
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("offline", onOffline, false);
@@ -53,7 +53,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.5.0/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.online.md b/www/docs/en/2.5.0/cordova/events/events.online.md
index e4b0da7..fcdff4c 100644
--- a/www/docs/en/2.5.0/cordova/events/events.online.md
+++ b/www/docs/en/2.5.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
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("online", onOnline, false);
@@ -53,7 +53,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.5.0/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.pause.md b/www/docs/en/2.5.0/cordova/events/events.pause.md
index 35e64c7..0aedf57 100644
--- a/www/docs/en/2.5.0/cordova/events/events.pause.md
+++ b/www/docs/en/2.5.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
-------------------
@@ -43,7 +43,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("pause", onPause, false);
@@ -52,7 +52,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.5.0/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.resume.md b/www/docs/en/2.5.0/cordova/events/events.resume.md
index f606e1c..700841f 100644
--- a/www/docs/en/2.5.0/cordova/events/events.resume.md
+++ b/www/docs/en/2.5.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
-------------------
@@ -43,7 +43,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("resume", onResume, false);
@@ -52,7 +52,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.5.0/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.searchbutton.md b/www/docs/en/2.5.0/cordova/events/events.searchbutton.md
index e8aeb3c..10d79c5 100644
--- a/www/docs/en/2.5.0/cordova/events/events.searchbutton.md
+++ b/www/docs/en/2.5.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.5.0/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.startcallbutton.md b/www/docs/en/2.5.0/cordova/events/events.startcallbutton.md
index 99cc83e..b49ab13 100644
--- a/www/docs/en/2.5.0/cordova/events/events.startcallbutton.md
+++ b/www/docs/en/2.5.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.5.0/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.volumedownbutton.md b/www/docs/en/2.5.0/cordova/events/events.volumedownbutton.md
index 22f7481..a8f1399 100644
--- a/www/docs/en/2.5.0/cordova/events/events.volumedownbutton.md
+++ b/www/docs/en/2.5.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.5.0/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/events/events.volumeupbutton.md b/www/docs/en/2.5.0/cordova/events/events.volumeupbutton.md
index f94afde..d3a1eaf 100644
--- a/www/docs/en/2.5.0/cordova/events/events.volumeupbutton.md
+++ b/www/docs/en/2.5.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.5.0/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/directoryentry/directoryentry.md b/www/docs/en/2.5.0/cordova/file/directoryentry/directoryentry.md
index 4eb9e8b..019b6c1 100644
--- a/www/docs/en/2.5.0/cordova/file/directoryentry/directoryentry.md
+++ b/www/docs/en/2.5.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.
@@ -71,8 +71,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__
@@ -148,7 +148,7 @@ __Quick Example__
window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
}
- setFolderMetadata(LocalFileSystem.PERSISTENT, "Backups", "com.apple.MobileBackup", 1);
+ setFolderMetadata([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, "Backups", "com.apple.MobileBackup", 1);
moveTo
------
@@ -167,7 +167,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__
@@ -205,7 +205,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__
@@ -252,7 +252,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__
@@ -276,7 +276,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__
@@ -295,7 +295,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__
@@ -315,7 +315,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__
@@ -342,8 +342,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__
@@ -371,7 +371,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.5.0/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/directoryreader/directoryreader.md b/www/docs/en/2.5.0/cordova/file/directoryreader/directoryreader.md
index f07dcd4..f27fd65 100644
--- a/www/docs/en/2.5.0/cordova/file/directoryreader/directoryreader.md
+++ b/www/docs/en/2.5.0/cordova/file/directoryreader/directoryreader.md
@@ -47,8 +47,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.5.0/cordova/file/file.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/file.md b/www/docs/en/2.5.0/cordova/file/file.md
index 9dccf00..a4a7229 100644
--- a/www/docs/en/2.5.0/cordova/file/file.md
+++ b/www/docs/en/2.5.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.5.0/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/fileentry/fileentry.md b/www/docs/en/2.5.0/cordova/file/fileentry/fileentry.md
index 9e8b758..0e4e105 100644
--- a/www/docs/en/2.5.0/cordova/file/fileentry/fileentry.md
+++ b/www/docs/en/2.5.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
@@ -69,8 +69,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__
@@ -147,7 +147,7 @@ __Quick Example__
window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
}
- setFileMetadata(LocalFileSystem.PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1);
+ setFileMetadata([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1);
moveTo
------
@@ -164,7 +164,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__
@@ -199,7 +199,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__
@@ -242,7 +242,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__
@@ -261,12 +261,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__
@@ -285,12 +285,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__
@@ -309,12 +309,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.5.0/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/fileerror/fileerror.md b/www/docs/en/2.5.0/cordova/file/fileerror/fileerror.md
index dac6d35..3a4068c 100644
--- a/www/docs/en/2.5.0/cordova/file/fileerror/fileerror.md
+++ b/www/docs/en/2.5.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.5.0/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/fileobj/fileobj.md b/www/docs/en/2.5.0/cordova/file/fileobj/fileobj.md
index a23ad2b..81a53b2 100644
--- a/www/docs/en/2.5.0/cordova/file/fileobj/fileobj.md
+++ b/www/docs/en/2.5.0/cordova/file/fileobj/fileobj.md
@@ -42,7 +42,7 @@ Methods
Details
-------
-The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `FileEntry` object.
+The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `[FileEntry](../fileentry/fileentry.html)` object.
Supported Platforms
-------------------
@@ -57,7 +57,7 @@ Supported Platforms
slice
--------------
-Return a new File object, for which FileReader will return only the specified portion of the file.
+Return a new File object, for which [FileReader](../filereader/filereader.html) will return only the specified portion of the file.
Negative values for __start__ or __end__ are measured from the end of the file.
The indexes are always relative to the current slice (see the full example).
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.5.0/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/filereader/filereader.md b/www/docs/en/2.5.0/cordova/file/filereader/filereader.md
index 5dde476..28d8de6 100644
--- a/www/docs/en/2.5.0/cordova/file/filereader/filereader.md
+++ b/www/docs/en/2.5.0/cordova/file/filereader/filereader.md
@@ -66,7 +66,7 @@ __Parameters:__
- file - the file object to read
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
function win(file) {
@@ -92,7 +92,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) {
@@ -110,7 +110,7 @@ Quick Example
entry.file(win, fail);
-Abort Quick Example
+Abort Quick [Example](../../storage/storage.opendatabase.html)
-------------------
function win(file) {
@@ -129,7 +129,7 @@ Abort Quick Example
entry.file(win, fail);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -149,7 +149,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.5.0/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/filesystem/filesystem.md b/www/docs/en/2.5.0/cordova/file/filesystem/filesystem.md
index aae4e45..d19dcb4 100644
--- a/www/docs/en/2.5.0/cordova/file/filesystem/filesystem.md
+++ b/www/docs/en/2.5.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
-------------------
@@ -45,7 +45,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-File System Quick Example
+[File](../fileobj/fileobj.html) System Quick [Example](../../storage/storage.opendatabase.html)
-------------------------
function onSuccess(fileSystem) {
@@ -54,9 +54,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>
@@ -74,7 +74,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.5.0/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/filetransfer/filetransfer.md b/www/docs/en/2.5.0/cordova/file/filetransfer/filetransfer.md
index d65c161..7ff9c4f 100644
--- a/www/docs/en/2.5.0/cordova/file/filetransfer/filetransfer.md
+++ b/www/docs/en/2.5.0/cordova/file/filetransfer/filetransfer.md
@@ -40,7 +40,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
@@ -59,8 +59,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
- __trustAllHosts__ - Optional parameter, defaults to false. If set to true then it will accept all security certificates. This is useful as Android rejects self signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
@@ -80,7 +80,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";
@@ -199,8 +199,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)_
- __trustAllHosts__ - Optional parameter, defaults to false. If set to true then it will accept all security certificates. This is useful as Android rejects self signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
__Quick Example__
@@ -226,7 +226,7 @@ __Quick Example__
abort
--------------
-Aborts an in-progress transfer. The onerror callback will be called with a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
+Aborts an in-progress transfer. The onerror callback will be called with a [FileTransferError](../filetransfererror/filetransfererror.html) object which has an error code of [FileTransferError](../filetransfererror/filetransfererror.html).ABORT_ERR.
__Supported Platforms__
@@ -249,7 +249,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";
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.5.0/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/fileuploadoptions/fileuploadoptions.md b/www/docs/en/2.5.0/cordova/file/fileuploadoptions/fileuploadoptions.md
index e28cfcc..3e89008 100644
--- a/www/docs/en/2.5.0/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/www/docs/en/2.5.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
----------
@@ -39,7 +39,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.5.0/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/fileuploadresult/fileuploadresult.md b/www/docs/en/2.5.0/cordova/file/fileuploadresult/fileuploadresult.md
index de8f5c7..19fd630 100644
--- a/www/docs/en/2.5.0/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/www/docs/en/2.5.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.5.0/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/filewriter/filewriter.md b/www/docs/en/2.5.0/cordova/file/filewriter/filewriter.md
index 82704fd..a49a252 100644
--- a/www/docs/en/2.5.0/cordova/file/filewriter/filewriter.md
+++ b/www/docs/en/2.5.0/cordova/file/filewriter/filewriter.md
@@ -64,7 +64,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Seek Quick Example
+Seek Quick [Example](../../storage/storage.opendatabase.html)
------------------------------
function win(writer) {
@@ -78,7 +78,7 @@ Seek Quick Example
entry.createWriter(win, fail);
-Truncate Quick Example
+Truncate Quick [Example](../../storage/storage.opendatabase.html)
--------------------------
function win(writer) {
@@ -91,7 +91,7 @@ Truncate Quick Example
entry.createWriter(win, fail);
-Write Quick Example
+Write Quick [Example](../../storage/storage.opendatabase.html)
-------------------
function win(writer) {
@@ -107,7 +107,7 @@ Write Quick Example
entry.createWriter(win, fail);
-Append Quick Example
+Append Quick [Example](../../storage/storage.opendatabase.html)
--------------------
function win(writer) {
@@ -124,7 +124,7 @@ Append Quick Example
entry.createWriter(win, fail);
-Abort Quick Example
+Abort Quick [Example](../../storage/storage.opendatabase.html)
-------------------
function win(writer) {
@@ -141,7 +141,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.5.0/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/flags/flags.md b/www/docs/en/2.5.0/cordova/file/flags/flags.md
index c6f155e..3776f96 100644
--- a/www/docs/en/2.5.0/cordova/file/flags/flags.md
+++ b/www/docs/en/2.5.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
----------
@@ -40,7 +40,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-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.5.0/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/localfilesystem/localfilesystem.md b/www/docs/en/2.5.0/cordova/file/localfilesystem/localfilesystem.md
index a1e10b7..4bf2038 100644
--- a/www/docs/en/2.5.0/cordova/file/localfilesystem/localfilesystem.md
+++ b/www/docs/en/2.5.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
---------
@@ -51,7 +51,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Request File System Quick Example
+Request [File](../fileobj/fileobj.html) System Quick [Example](../../storage/storage.opendatabase.html)
---------------------------------
function onSuccess(fileSystem) {
@@ -61,7 +61,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) {
@@ -70,7 +70,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.5.0/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/file/metadata/metadata.md b/www/docs/en/2.5.0/cordova/file/metadata/metadata.md
index 9d7a8e5..6d5ac04 100644
--- a/www/docs/en/2.5.0/cordova/file/metadata/metadata.md
+++ b/www/docs/en/2.5.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
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-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.5.0/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/geolocation/Coordinates/coordinates.md b/www/docs/en/2.5.0/cordova/geolocation/Coordinates/coordinates.md
index e1c0cf8..f21500c 100644
--- a/www/docs/en/2.5.0/cordova/geolocation/Coordinates/coordinates.md
+++ b/www/docs/en/2.5.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
-------------------
@@ -53,7 +53,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -77,7 +77,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.5.0/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/geolocation/Position/position.md b/www/docs/en/2.5.0/cordova/geolocation/Position/position.md
index 725d4ee..2bb234c 100644
--- a/www/docs/en/2.5.0/cordova/geolocation/Position/position.md
+++ b/www/docs/en/2.5.0/cordova/geolocation/Position/position.md
@@ -48,7 +48,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -73,7 +73,7 @@ Quick Example
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -109,7 +109,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.5.0/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/geolocation/PositionError/positionError.md b/www/docs/en/2.5.0/cordova/geolocation/PositionError/positionError.md
index 2f06723..db51351 100644
--- a/www/docs/en/2.5.0/cordova/geolocation/PositionError/positionError.md
+++ b/www/docs/en/2.5.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.5.0/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/geolocation/geolocation.clearWatch.md b/www/docs/en/2.5.0/cordova/geolocation/geolocation.clearWatch.md
index 5cf7bee..bfb274d 100644
--- a/www/docs/en/2.5.0/cordova/geolocation/geolocation.clearWatch.md
+++ b/www/docs/en/2.5.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
-------------------
@@ -49,7 +49,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Options: watch for changes in position, and use the most
@@ -62,7 +62,7 @@ Quick Example
navigator.geolocation.clearWatch(watchID);
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -106,7 +106,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.5.0/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/geolocation/geolocation.getCurrentPosition.md b/www/docs/en/2.5.0/cordova/geolocation/geolocation.getCurrentPosition.md
index ea3716b..11711ce 100644
--- a/www/docs/en/2.5.0/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/www/docs/en/2.5.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
@@ -54,7 +54,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -81,7 +81,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.5.0/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/geolocation/geolocation.md b/www/docs/en/2.5.0/cordova/geolocation/geolocation.md
index 88f381f..97943da 100644
--- a/www/docs/en/2.5.0/cordova/geolocation/geolocation.md
+++ b/www/docs/en/2.5.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.5.0/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/geolocation/geolocation.watchPosition.md b/www/docs/en/2.5.0/cordova/geolocation/geolocation.watchPosition.md
index 9910acc..29647cd 100644
--- a/www/docs/en/2.5.0/cordova/geolocation/geolocation.watchPosition.md
+++ b/www/docs/en/2.5.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
-------------------
@@ -58,7 +58,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -84,7 +84,7 @@ Quick Example
var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -118,7 +118,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.5.0/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/geolocation/parameters/geolocation.options.md b/www/docs/en/2.5.0/cordova/geolocation/parameters/geolocation.options.md
index 65f3bd6..9af53c2 100644
--- a/www/docs/en/2.5.0/cordova/geolocation/parameters/geolocation.options.md
+++ b/www/docs/en/2.5.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.5.0/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/geolocation/parameters/geolocationError.md b/www/docs/en/2.5.0/cordova/geolocation/parameters/geolocationError.md
index 1cc1d9e..665914a 100644
--- a/www/docs/en/2.5.0/cordova/geolocation/parameters/geolocationError.md
+++ b/www/docs/en/2.5.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.5.0/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/geolocation/parameters/geolocationSuccess.md b/www/docs/en/2.5.0/cordova/geolocation/parameters/geolocationSuccess.md
index 6e6a063..fe96449 100644
--- a/www/docs/en/2.5.0/cordova/geolocation/parameters/geolocationSuccess.md
+++ b/www/docs/en/2.5.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) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.5.0/cordova/globalization/GlobalizationError/globalizationerror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/globalization/GlobalizationError/globalizationerror.md b/www/docs/en/2.5.0/cordova/globalization/GlobalizationError/globalizationerror.md
index 814824b..10851e8 100644
--- a/www/docs/en/2.5.0/cordova/globalization/GlobalizationError/globalizationerror.md
+++ b/www/docs/en/2.5.0/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -23,7 +23,7 @@ title: GlobalizationError
GlobalizationError
============
-An object representing a error from the Globalization API.
+An object representing a error from the [Globalization](../globalization.html) API.
Properties
----------
@@ -47,7 +47,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
When the following error callback is invoked, it should display a popup dialog with the text similar to "code: 3" and "message: ".
@@ -57,7 +57,7 @@ When the following error callback is invoked, it should display a popup dialog w
'message: ' + error.message + '\n');
};
-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.5.0/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/globalization/globalization.dateToString.md b/www/docs/en/2.5.0/cordova/globalization/globalization.dateToString.md
index a1e1389..9f73d00 100644
--- a/www/docs/en/2.5.0/cordova/globalization/globalization.dateToString.md
+++ b/www/docs/en/2.5.0/cordova/globalization/globalization.dateToString.md
@@ -34,7 +34,7 @@ It returns the formatted date string to the successCB callback with a properties
The inbound ``date`` parameter should be of type ``Date``.
-If there is an error formatting the date, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+If there is an error formatting the date, then the errorCB callback is invoked with a [GlobalizationError](GlobalizationError/globalizationerror.html) object as a parameter. The expected code for this error is [GlobalizationError](GlobalizationError/globalizationerror.html).FORMATTING\_ERROR.
`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
`options.selector` can be 'date', 'time' or 'date and time'.
@@ -51,7 +51,7 @@ Supported Platforms
- iPhone
- Windows Phone 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "date: 9/25/2012 4:21PM" using the default options.
@@ -63,7 +63,7 @@ In the case when the browser is set to the en\_US locale, this should display a
{formatLength:'short', selector:'date and time'}
);
-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.5.0/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/globalization/globalization.getCurrencyPattern.md b/www/docs/en/2.5.0/cordova/globalization/globalization.getCurrencyPattern.md
index 1a82c4e..e5ba581 100644
--- a/www/docs/en/2.5.0/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/www/docs/en/2.5.0/cordova/globalization/globalization.getCurrencyPattern.md
@@ -42,7 +42,7 @@ It returns the pattern to the successCB callback with a properties object as a p
The inbound `currencyCode` parameter should be a String of one of the ISO 4217 currency codes, for example 'USD'.
-If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+If there is an error obtaining the pattern, then the errorCB callback is invoked with a [GlobalizationError](GlobalizationError/globalizationerror.html) object as a parameter. The expected code for this error is [GlobalizationError](GlobalizationError/globalizationerror.html).FORMATTING\_ERROR.
Supported Platforms
-------------------
@@ -51,7 +51,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iPhone
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
In the case when the browser is set to the en\_US locale and the selected currency is United States Dollars, this should display a popup dialog with text similar to:
@@ -77,7 +77,7 @@ In the case when the browser is set to the en\_US locale and the selected curren
);
-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.5.0/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/globalization/globalization.getDateNames.md b/www/docs/en/2.5.0/cordova/globalization/globalization.getDateNames.md
index 779a7a7..7d8970f 100644
--- a/www/docs/en/2.5.0/cordova/globalization/globalization.getDateNames.md
+++ b/www/docs/en/2.5.0/cordova/globalization/globalization.getDateNames.md
@@ -32,7 +32,7 @@ Description
It returns the array of names to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
-If there is an error obtaining the names, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error obtaining the names, then the errorCB callback is invoked with a [GlobalizationError](GlobalizationError/globalizationerror.html) object as a parameter. The expected code for this error is [GlobalizationError](GlobalizationError/globalizationerror.html).UNKNOWN\_ERROR.
`options.type` can be 'narrow', or 'wide'.
`options.item` can be 'months', or 'days'.
@@ -49,7 +49,7 @@ Supported Platforms
- iPhone
- Windows Phone 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
In the case when the browser is set to the en\_US locale, this should display a series of 12 popup dialogs, one per month, with text similar to "month: January"
@@ -65,7 +65,7 @@ In the case when the browser is set to the en\_US locale, this should display a
);
-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.5.0/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/www/docs/en/2.5.0/cordova/globalization/globalization.getDatePattern.md b/www/docs/en/2.5.0/cordova/globalization/globalization.getDatePattern.md
index bcd022e..9ffede4 100644
--- a/www/docs/en/2.5.0/cordova/globalization/globalization.getDatePattern.md
+++ b/www/docs/en/2.5.0/cordova/globalization/globalization.getDatePattern.md
@@ -37,7 +37,7 @@ It returns the pattern to the successCB callback with a properties object as a p
- utc\_offset {Number}: The current difference in seconds between the client's time zone and coordinated universal time.
- dst\_offset {Number}: The current daylight saving time offset in seconds between the client's non-daylight saving's time zone and the client's daylight saving's time zone.
-If there is an error obtaining the pattern, then the errorCB callback is invokedwith a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR.
+If there is an error obtaining the pattern, then the errorCB callback is invokedwith a [GlobalizationError](GlobalizationError/globalizationerror.html) object as a parameter. The expected code for this error is [GlobalizationError](GlobalizationError/globalizationerror.html).PATTERN\_ERROR.
`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
`options.selector` can be 'date', 'time' or 'date and time'.
@@ -53,7 +53,7 @@ Supported Platforms
- iPhone
- Windows Phone 8
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "pattern: M/d/yyyy h:mm a".
@@ -66,7 +66,7 @@ In the case when the browser is set to the en\_US locale, this should display a
);
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org