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/21 00:28:01 UTC
[41/78] [abbrv] [partial] docs commit: Making links in docs manual
instead of automatic.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.5.0/phonegap/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/ContactOrganization/contactorganization.md b/www/docs/en/1.5.0/phonegap/contacts/ContactOrganization/contactorganization.md
index 4039cb3..c560707 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/ContactOrganization/contactorganization.md
+++ b/www/docs/en/1.5.0/phonegap/contacts/ContactOrganization/contactorganization.md
@@ -23,20 +23,20 @@ title: ContactOrganization
ContactOrganization
===================
-Contains organization properties of a `Contact` object.
+Contains organization properties of a `[Contact](../Contact/contact.html)` object.
Properties
----------
- __pref:__ Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_
- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)
-- __name:__ The name of the organization. _(DOMString)_
+- __name:__ The [name](../../storage/parameters/name.html) of the organization. _(DOMString)_
- __department:__ The department the contract works for. _(DOMString)_
- __title:__ The contacts title at the organization. _(DOMString)_
Details
-------
-The `ContactOrganization` object stores a contact's organization properties. A `Contact` object stores one or more `ContactOrganization` objects in an array.
+The `ContactOrganization` object stores a contact's organization properties. A `[Contact](../Contact/contact.html)` object stores one or more `ContactOrganization` objects in an array.
Supported Platforms
-------------------
@@ -45,7 +45,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
function onSuccess(contacts) {
@@ -69,7 +69,7 @@ Quick Example
filter = ["displayName","organizations"];
navigator.contacts.find(filter, onSuccess, onError, options);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -87,7 +87,7 @@ Full Example
// PhoneGap is ready
//
function onDeviceReady() {
- var options = new ContactFindOptions();
+ var options = new [ContactFindOptions](../ContactFindOptions/contactfindoptions.html)();
options.filter="";
filter = ["displayName","organizations"];
navigator.contacts.find(filter, onSuccess, onError, options);
@@ -138,7 +138,7 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks
--------------------------------------------
- __pref:__ This property is not supported by BlackBerry devices and will always return `false`.
- __type:__ This property is not supported by BlackBerry devices and will always return `null`.
-- __name:__ Partially supported. The first organization name will be stored in the BlackBerry __company__ field.
+- __name:__ Partially supported. The first organization [name](../../storage/parameters/name.html) will be stored in the BlackBerry __company__ field.
- __department:__ This property is not supported, and will always be returned as `null`.
- __title:__ Partially supported. The first organization title will be stored in the BlackBerry __jobTitle__ field.
@@ -146,8 +146,8 @@ iOS Quirks
-----------
- __pref:__ This property is not supported on iOS devices and will always return `false`.
- __type:__ This property is not supported on iOS devices and will always return `null`.
-- __name:__ Partially supported. The first organization name will be stored in the iOS __kABPersonOrganizationProperty__ field.
-- __department__: Partially supported. The first department name will be stored in the iOS __kABPersonDepartmentProperty__ field.
+- __name:__ Partially supported. The first organization [name](../../storage/parameters/name.html) will be stored in the iOS __kABPersonOrganizationProperty__ field.
+- __department__: Partially supported. The first department [name](../../storage/parameters/name.html) will be stored in the iOS __kABPersonDepartmentProperty__ field.
- __title__: Partially supported. The first title will be stored in the iOS __kABPersonJobTitleProperty__ field.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.5.0/phonegap/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/contacts.create.md b/www/docs/en/1.5.0/phonegap/contacts/contacts.create.md
index c39f89d..ca2bdca 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/contacts.create.md
+++ b/www/docs/en/1.5.0/phonegap/contacts/contacts.create.md
@@ -23,16 +23,16 @@ title: contacts.create
contacts.create
===============
-Returns a new Contact object.
+Returns a new [Contact](Contact/contact.html) object.
var contact = navigator.contacts.create(properties);
Description
-----------
-contacts.create is a synchronous function that returns a new `Contact` object.
+contacts.create is a synchronous function that returns a new `[Contact](Contact/contact.html)` object.
-This method does not persist the Contact object to the device contacts database. To persist the Contact object to the device, invoke the `Contact.save` method.
+This method does not persist the [Contact](Contact/contact.html) object to the device contacts database. To persist the [Contact](Contact/contact.html) object to the device, invoke the `[Contact](Contact/contact.html).save` method.
Supported Platforms
-------------------
@@ -41,12 +41,12 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
var myContact = navigator.contacts.create({"displayName": "Test User"});
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.5.0/phonegap/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/contacts.find.md b/www/docs/en/1.5.0/phonegap/contacts/contacts.find.md
index ecf65d9..45d92b6 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/contacts.find.md
+++ b/www/docs/en/1.5.0/phonegap/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]
@@ -51,7 +51,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
function onSuccess(contacts) {
@@ -68,7 +68,7 @@ Quick Example
var fields = ["displayName", "name"];
navigator.contacts.find(fields, onSuccess, onError, options);
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.5.0/phonegap/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/contacts.md b/www/docs/en/1.5.0/phonegap/contacts/contacts.md
index 9d7c63f..1b50c0a 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/contacts.md
+++ b/www/docs/en/1.5.0/phonegap/contacts/contacts.md
@@ -28,24 +28,24 @@ 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
\ No newline at end of file
+- [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)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.5.0/phonegap/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/parameters/contactFields.md b/www/docs/en/1.5.0/phonegap/contacts/parameters/contactFields.md
index ae27dd7..368541b 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/parameters/contactFields.md
+++ b/www/docs/en/1.5.0/phonegap/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/c4881540/www/docs/en/1.5.0/phonegap/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/parameters/contactFindOptions.md b/www/docs/en/1.5.0/phonegap/contacts/parameters/contactFindOptions.md
index b166110..9459ec4 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/parameters/contactFindOptions.md
+++ b/www/docs/en/1.5.0/phonegap/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/c4881540/www/docs/en/1.5.0/phonegap/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/contacts/parameters/contactSuccess.md b/www/docs/en/1.5.0/phonegap/contacts/parameters/contactSuccess.md
index 22137b6..6b5204c 100644
--- a/www/docs/en/1.5.0/phonegap/contacts/parameters/contactSuccess.md
+++ b/www/docs/en/1.5.0/phonegap/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/c4881540/www/docs/en/1.5.0/phonegap/device/device.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/device/device.md b/www/docs/en/1.5.0/phonegap/device/device.md
index ca40ae7..06be3e0 100644
--- a/www/docs/en/1.5.0/phonegap/device/device.md
+++ b/www/docs/en/1.5.0/phonegap/device/device.md
@@ -28,11 +28,11 @@ Device
Properties
----------
-- device.name
-- device.phonegap
-- device.platform
-- device.uuid
-- device.version
+- [device.name](device.name.html)
+- [device.phonegap](device.phonegap.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/c4881540/www/docs/en/1.5.0/phonegap/device/device.name.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/device/device.name.md b/www/docs/en/1.5.0/phonegap/device/device.name.md
index 6941654..f951a85 100644
--- a/www/docs/en/1.5.0/phonegap/device/device.name.md
+++ b/www/docs/en/1.5.0/phonegap/device/device.name.md
@@ -23,14 +23,14 @@ title: device.name
device.name
===========
-Get the device's model name.
+Get the device's model [name](../storage/parameters/name.html).
var string = device.name;
Description
-----------
-`device.name` returns the name of the device's model or product. This value is set by the device manufacturer and may be different across versions of the same product.
+`device.name` returns the [name](../storage/parameters/name.html) of the device's model or product. This value is set by the device manufacturer and may be different across versions of the same product.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Android: Nexus One returns "Passion" (Nexus One code name)
@@ -51,7 +51,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/c4881540/www/docs/en/1.5.0/phonegap/device/device.phonegap.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/device/device.phonegap.md b/www/docs/en/1.5.0/phonegap/device/device.phonegap.md
index 47e74af..d5fd404 100644
--- a/www/docs/en/1.5.0/phonegap/device/device.phonegap.md
+++ b/www/docs/en/1.5.0/phonegap/device/device.phonegap.md
@@ -23,14 +23,14 @@ title: device.phonegap
device.phonegap
===============
-Get the version of phonegap running on the device.
+Get the [version](../storage/parameters/version.html) of phonegap running on the device.
var string = device.phonegap;
Description
-----------
-`device.phonegap` returns the version of phonegap running on the device.
+`device.phonegap` returns the [version](../storage/parameters/version.html) of phonegap running on the device.
Supported Platforms
-------------------
@@ -41,12 +41,12 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
var name = device.phonegap;
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.5.0/phonegap/device/device.platform.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/device/device.platform.md b/www/docs/en/1.5.0/phonegap/device/device.platform.md
index c816fe9..b443d26 100644
--- a/www/docs/en/1.5.0/phonegap/device/device.platform.md
+++ b/www/docs/en/1.5.0/phonegap/device/device.platform.md
@@ -23,7 +23,7 @@ title: device.platform
device.platform
===============
-Get the device's operating system name.
+Get the device's operating system [name](../storage/parameters/name.html).
var string = device.platform;
@@ -36,7 +36,7 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Depending on the device, a few examples are:
@@ -47,7 +47,7 @@ Quick Example
// - "WinCE"
var devicePlatform = device.platform;
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -89,4 +89,4 @@ All devices return `iPhone` as the platform. This is inaccurate because Apple ha
BlackBerry Quirks
-----------------
-Devices may return the device platform version instead of the platform name. For example, the Storm2 9550 would return '2.13.0.95' or similar.
\ No newline at end of file
+Devices may return the device platform [version](../storage/parameters/version.html) instead of the platform [name](../storage/parameters/name.html). For example, the Storm2 9550 would return '2.13.0.95' or similar.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.5.0/phonegap/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/device/device.uuid.md b/www/docs/en/1.5.0/phonegap/device/device.uuid.md
index 871da0f..229fa29 100644
--- a/www/docs/en/1.5.0/phonegap/device/device.uuid.md
+++ b/www/docs/en/1.5.0/phonegap/device/device.uuid.md
@@ -41,7 +41,7 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Android: Returns a random 64-bit integer (as a string, again!)
@@ -59,7 +59,7 @@ Quick Example
//
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/c4881540/www/docs/en/1.5.0/phonegap/device/device.version.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/device/device.version.md b/www/docs/en/1.5.0/phonegap/device/device.version.md
index 712834d..2033194 100644
--- a/www/docs/en/1.5.0/phonegap/device/device.version.md
+++ b/www/docs/en/1.5.0/phonegap/device/device.version.md
@@ -23,7 +23,7 @@ title: device.version
device.version
==============
-Get the operating system version.
+Get the operating system [version](../storage/parameters/version.html).
var string = device.version;
@@ -36,7 +36,7 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Android: Froyo OS would return "2.2"
@@ -50,7 +50,7 @@ Quick Example
// Windows Phone 7: returns current OS version number, ex. on Mango returns 7.10.7720
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/c4881540/www/docs/en/1.5.0/phonegap/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.backbutton.md b/www/docs/en/1.5.0/phonegap/events/events.backbutton.md
index ddb9c1d..af8aa99 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.backbutton.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[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("backbutton", onBackKeyDown, false);
@@ -49,7 +49,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/c4881540/www/docs/en/1.5.0/phonegap/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.batterycritical.md b/www/docs/en/1.5.0/phonegap/events/events.batterycritical.md
index ed1d5fe..56c61a8 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.batterycritical.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `window.addEventListener` once you receive the PhoneGap '[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/c4881540/www/docs/en/1.5.0/phonegap/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.batterylow.md b/www/docs/en/1.5.0/phonegap/events/events.batterylow.md
index 1421d98..ce714b6 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.batterylow.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[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/c4881540/www/docs/en/1.5.0/phonegap/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.batterystatus.md b/www/docs/en/1.5.0/phonegap/events/events.batterystatus.md
index 2f7b497..aa193ea 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.batterystatus.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `window.addEventListener` once you receive the PhoneGap '[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("batterystatus", onBatteryStatus, false);
@@ -56,7 +56,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/c4881540/www/docs/en/1.5.0/phonegap/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.deviceready.md b/www/docs/en/1.5.0/phonegap/events/events.deviceready.md
index 53157e4..8c18458 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.deviceready.md
+++ b/www/docs/en/1.5.0/phonegap/events/events.deviceready.md
@@ -45,7 +45,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("deviceready", onDeviceReady, false);
@@ -54,7 +54,7 @@ Quick Example
// Now safe to use the PhoneGap API
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.5.0/phonegap/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.endcallbutton.md b/www/docs/en/1.5.0/phonegap/events/events.endcallbutton.md
index 7a87273..5e56176 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.endcallbutton.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[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/c4881540/www/docs/en/1.5.0/phonegap/events/events.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.md b/www/docs/en/1.5.0/phonegap/events/events.md
index 9e2385e..1580b5f 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.md
+++ b/www/docs/en/1.5.0/phonegap/events/events.md
@@ -28,19 +28,19 @@ 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)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.5.0/phonegap/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.menubutton.md b/www/docs/en/1.5.0/phonegap/events/events.menubutton.md
index faf6fa6..a777e40 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.menubutton.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[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/c4881540/www/docs/en/1.5.0/phonegap/events/events.offline.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.offline.md b/www/docs/en/1.5.0/phonegap/events/events.offline.md
index b16d63a..c12fcf3 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.offline.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("offline", onOffline, false);
@@ -50,7 +50,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/c4881540/www/docs/en/1.5.0/phonegap/events/events.online.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.online.md b/www/docs/en/1.5.0/phonegap/events/events.online.md
index 23de575..77f8cf9 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.online.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("online", onOnline, false);
@@ -50,7 +50,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/c4881540/www/docs/en/1.5.0/phonegap/events/events.pause.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.pause.md b/www/docs/en/1.5.0/phonegap/events/events.pause.md
index 74eaba0..55feb85 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.pause.md
+++ b/www/docs/en/1.5.0/phonegap/events/events.pause.md
@@ -32,7 +32,7 @@ Details
PhoneGap 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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("pause", onPause, false);
@@ -50,7 +50,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/c4881540/www/docs/en/1.5.0/phonegap/events/events.resume.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.resume.md b/www/docs/en/1.5.0/phonegap/events/events.resume.md
index 014b36c..56567b6 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.resume.md
+++ b/www/docs/en/1.5.0/phonegap/events/events.resume.md
@@ -32,7 +32,7 @@ Details
PhoneGap 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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("resume", onResume, false);
@@ -50,7 +50,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/c4881540/www/docs/en/1.5.0/phonegap/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.searchbutton.md b/www/docs/en/1.5.0/phonegap/events/events.searchbutton.md
index 69b509c..e28cf21 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.searchbutton.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[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/c4881540/www/docs/en/1.5.0/phonegap/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.startcallbutton.md b/www/docs/en/1.5.0/phonegap/events/events.startcallbutton.md
index e758048..3e05b40 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.startcallbutton.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[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/c4881540/www/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md b/www/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md
index bb830d6..c93ac23 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[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/c4881540/www/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md b/www/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md
index d2a960c..6c12359 100644
--- a/www/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md
+++ b/www/docs/en/1.5.0/phonegap/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 PhoneGap 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap '[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/c4881540/www/docs/en/1.5.0/phonegap/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/directoryentry/directoryentry.md b/www/docs/en/1.5.0/phonegap/file/directoryentry/directoryentry.md
index fc044bd..d0ce2f4 100644
--- a/www/docs/en/1.5.0/phonegap/file/directoryentry/directoryentry.md
+++ b/www/docs/en/1.5.0/phonegap/file/directoryentry/directoryentry.md
@@ -30,7 +30,7 @@ Properties
- __isFile:__ Always false. _(boolean)_
- __isDirectory:__ Always true. _(boolean)_
-- __name:__ The name of the DirectoryEntry, excluding the path leading to it. _(DOMString)_
+- __name:__ The [name](../../storage/parameters/name.html) of the DirectoryEntry, excluding the path leading to it. _(DOMString)_
- __fullPath:__ The full absolute path from the root to the DirectoryEntry. _(DOMString)_
NOTE: The following attributes are defined by the W3C specification, but are __not supported__ by PhoneGap:
@@ -48,7 +48,7 @@ The following methods can be invoked on a DirectoryEntry object:
- __toURI__: Return a URI 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.
@@ -69,8 +69,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__
@@ -93,7 +93,7 @@ moveTo
Move a directory to a different location on the file system. It is an error to attempt to:
- move a directory inside itself or to any child at any depth;
-- move a directory into its parent if a name different from its current one is not provided;
+- move a directory into its parent if a [name](../../storage/parameters/name.html) different from its current one is not provided;
- move a directory to a path occupied by a file;
- move a directory to a path occupied by a directory which is not empty.
@@ -102,9 +102,9 @@ In addition, an attempt to move a directory on top of an existing empty director
__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)_
+- __newName__ - The new [name](../../storage/parameters/name.html) of the directory. Defaults to the current [name](../../storage/parameters/name.html) 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__
@@ -132,16 +132,16 @@ copyTo
Copy a directory to a different location on the file system. It is an error to attempt to:
- copy a directory inside itself at any depth;
-- copy a directory into its parent if a name different from its current one is not provided.
+- copy a directory into its parent if a [name](../../storage/parameters/name.html) different from its current one is not provided.
Directory copies are always recursive - that is, they copy all contents of the directory.
__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)_
+- __newName__ - The new [name](../../storage/parameters/name.html) of the directory. Defaults to the current [name](../../storage/parameters/name.html) 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__
@@ -187,7 +187,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__
@@ -211,7 +211,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__
@@ -230,7 +230,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__
@@ -250,7 +250,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__
@@ -277,8 +277,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__
@@ -306,7 +306,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/c4881540/www/docs/en/1.5.0/phonegap/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/directoryreader/directoryreader.md b/www/docs/en/1.5.0/phonegap/file/directoryreader/directoryreader.md
index 72b6b10..facd75b 100644
--- a/www/docs/en/1.5.0/phonegap/file/directoryreader/directoryreader.md
+++ b/www/docs/en/1.5.0/phonegap/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/c4881540/www/docs/en/1.5.0/phonegap/file/file.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/file.md b/www/docs/en/1.5.0/phonegap/file/file.md
index 84a3ed4..14098b6 100644
--- a/www/docs/en/1.5.0/phonegap/file/file.md
+++ b/www/docs/en/1.5.0/phonegap/file/file.md
@@ -20,7 +20,7 @@ license: >
title: File
---
-File
+[File](fileobj/fileobj.html)
==========
> An API to read, write and navigate file system hierarchies.
@@ -28,18 +28,18 @@ File
Objects
-------
-- DirectoryEntry
-- DirectoryReader
-- File
-- FileEntry
-- FileError
-- FileReader
-- FileSystem
-- FileTransfer
-- FileTransferError
-- FileUploadOptions
-- FileUploadResult
-- FileWriter
-- Flags
-- LocalFileSystem
-- Metadata
\ No newline at end of file
+- [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)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.5.0/phonegap/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/fileentry/fileentry.md b/www/docs/en/1.5.0/phonegap/file/fileentry/fileentry.md
index 079768f..a59a9d1 100644
--- a/www/docs/en/1.5.0/phonegap/file/fileentry/fileentry.md
+++ b/www/docs/en/1.5.0/phonegap/file/fileentry/fileentry.md
@@ -30,7 +30,7 @@ Properties
- __isFile:__ Always true. _(boolean)_
- __isDirectory:__ Always false. _(boolean)_
-- __name:__ The name of the FileEntry, excluding the path leading to it. _(DOMString)_
+- __name:__ The [name](../../storage/parameters/name.html) of the FileEntry, excluding the path leading to it. _(DOMString)_
- __fullPath:__ The full absolute path from the root to the FileEntry. _(DOMString)_
NOTE: The following attributes are defined by the W3C specification, but are __not supported__ by PhoneGap:
@@ -47,8 +47,8 @@ Methods
- __toURI__: Return a URI 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
@@ -67,8 +67,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__
@@ -90,7 +90,7 @@ moveTo
Move a file to a different location on the file system. It is an error to attempt to:
-- move a file into its parent if a name different from its current one isn't provided;
+- move a file into its parent if a [name](../../storage/parameters/name.html) different from its current one isn't provided;
- move a file to a path occupied by a directory;
In addition, an attempt to move a file on top of an existing file must attempt to delete and replace that file.
@@ -98,9 +98,9 @@ In addition, an attempt to move a file on top of an existing file must attempt t
__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)_
+- __newName__ - The new [name](../../storage/parameters/name.html) of the file. Defaults to the current [name](../../storage/parameters/name.html) 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__
@@ -127,14 +127,14 @@ copyTo
Copy a file to a new location on the file system. It is an error to attempt to:
-- copy a file into its parent if a name different from its current one is not provided.
+- copy a file into its parent if a [name](../../storage/parameters/name.html) different from its current one is not provided.
__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)_
+- __newName__ - The new [name](../../storage/parameters/name.html) of the file. Defaults to the current [name](../../storage/parameters/name.html) 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__
@@ -176,7 +176,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__
@@ -195,12 +195,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__
@@ -219,12 +219,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__
@@ -243,12 +243,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/c4881540/www/docs/en/1.5.0/phonegap/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/fileerror/fileerror.md b/www/docs/en/1.5.0/phonegap/file/fileerror/fileerror.md
index dac6d35..3a4068c 100644
--- a/www/docs/en/1.5.0/phonegap/file/fileerror/fileerror.md
+++ b/www/docs/en/1.5.0/phonegap/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/c4881540/www/docs/en/1.5.0/phonegap/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/fileobj/fileobj.md b/www/docs/en/1.5.0/phonegap/file/fileobj/fileobj.md
index 3dedfd3..b6c6df6 100644
--- a/www/docs/en/1.5.0/phonegap/file/fileobj/fileobj.md
+++ b/www/docs/en/1.5.0/phonegap/file/fileobj/fileobj.md
@@ -28,16 +28,16 @@ This object contains attributes of a single file.
Properties
----------
-- __name:__ The name of the file. _(DOMString)_
-- __fullPath:__ The full path of the file including the file name. _(DOMString)_
+- __name:__ The [name](../../storage/parameters/name.html) of the file. _(DOMString)_
+- __fullPath:__ The full path of the file including the file [name](../../storage/parameters/name.html). _(DOMString)_
- __type:__ The mime type of the file. _(DOMString)_
- __lastModifiedDate:__ The last time the file was modified. _(Date)_
-- __size:__ The size of the file in bytes. _(long)_
+- __size:__ The [size](../../storage/parameters/size.html) of the file in bytes. _(long)_
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/c4881540/www/docs/en/1.5.0/phonegap/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/filereader/filereader.md b/www/docs/en/1.5.0/phonegap/file/filereader/filereader.md
index ad712a9..12613cf 100644
--- a/www/docs/en/1.5.0/phonegap/file/filereader/filereader.md
+++ b/www/docs/en/1.5.0/phonegap/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
// PhoneGap 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/c4881540/www/docs/en/1.5.0/phonegap/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/filesystem/filesystem.md b/www/docs/en/1.5.0/phonegap/file/filesystem/filesystem.md
index d462213..8938522 100644
--- a/www/docs/en/1.5.0/phonegap/file/filesystem/filesystem.md
+++ b/www/docs/en/1.5.0/phonegap/file/filesystem/filesystem.md
@@ -28,13 +28,13 @@ This object represents a file system.
Properties
----------
-- __name:__ The name of the file system. _(DOMString)_
+- __name:__ The [name](../../storage/parameters/name.html) of the file system. _(DOMString)_
- __root:__ The root directory of the file system. _(DirectoryEntry)_
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](../../storage/parameters/name.html) 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
// PhoneGap 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/c4881540/www/docs/en/1.5.0/phonegap/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/filetransfer/filetransfer.md b/www/docs/en/1.5.0/phonegap/file/filetransfer/filetransfer.md
index 69cf41b..8aad100 100644
--- a/www/docs/en/1.5.0/phonegap/file/filetransfer/filetransfer.md
+++ b/www/docs/en/1.5.0/phonegap/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,9 +57,9 @@ __Parameters:__
- __filePath__ - Full path of the file on the device
- __server__ - URL of the server to receive the file
-- __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)_
-- __options__ - Optional parameters such as file name and mimetype
+- __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](../../storage/parameters/name.html) 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";
@@ -162,8 +162,8 @@ __Parameters:__
- __source__ - URL of the server to receive the file
- __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/c4881540/www/docs/en/1.5.0/phonegap/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/fileuploadoptions/fileuploadoptions.md b/www/docs/en/1.5.0/phonegap/file/fileuploadoptions/fileuploadoptions.md
index b7f3201..4d7c050 100644
--- a/www/docs/en/1.5.0/phonegap/file/fileuploadoptions/fileuploadoptions.md
+++ b/www/docs/en/1.5.0/phonegap/file/fileuploadoptions/fileuploadoptions.md
@@ -23,13 +23,13 @@ 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
----------
-- __fileKey:__ The name of the form element. If not set defaults to "file". (DOMString)
-- __fileName:__ The file name you want the file to be saved as on the server. If not set defaults to "image.jpg". (DOMString)
+- __fileKey:__ The [name](../../storage/parameters/name.html) of the form element. If not set defaults to "file". (DOMString)
+- __fileName:__ The file [name](../../storage/parameters/name.html) you want the file to be saved as on the server. If not set defaults to "image.jpg". (DOMString)
- __mimeType:__ The mime type of the data you are uploading. If not set defaults to "image/jpeg". (DOMString)
- __params:__ A set of optional key/value pairs to be passed along in the HTTP request. (Object)
- __chunkedMode:__ Should the data be uploaded in chunked streaming mode. If not set defaults to "true". (Boolean)
@@ -38,4 +38,4 @@ 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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.5.0/phonegap/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/fileuploadresult/fileuploadresult.md b/www/docs/en/1.5.0/phonegap/file/fileuploadresult/fileuploadresult.md
index de8f5c7..19fd630 100644
--- a/www/docs/en/1.5.0/phonegap/file/fileuploadresult/fileuploadresult.md
+++ b/www/docs/en/1.5.0/phonegap/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/c4881540/www/docs/en/1.5.0/phonegap/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/filewriter/filewriter.md b/www/docs/en/1.5.0/phonegap/file/filewriter/filewriter.md
index 37cffec..196a5b5 100644
--- a/www/docs/en/1.5.0/phonegap/file/filewriter/filewriter.md
+++ b/www/docs/en/1.5.0/phonegap/file/filewriter/filewriter.md
@@ -29,7 +29,7 @@ Properties
----------
- __readyState:__ One of the three states the reader can be in INIT, WRITING or DONE.
-- __fileName:__ The name of the file to be written. _(DOMString)_
+- __fileName:__ The [name](../../storage/parameters/name.html) of the file to be written. _(DOMString)_
- __length:__ The length of the file to be written. _(long)_
- __position:__ The current position of the file pointer. _(long)_
- __error:__ An object containing errors. _(FileError)_
@@ -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/c4881540/www/docs/en/1.5.0/phonegap/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/flags/flags.md b/www/docs/en/1.5.0/phonegap/file/flags/flags.md
index 505b05c..4ce4be0 100644
--- a/www/docs/en/1.5.0/phonegap/file/flags/flags.md
+++ b/www/docs/en/1.5.0/phonegap/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/c4881540/www/docs/en/1.5.0/phonegap/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/localfilesystem/localfilesystem.md b/www/docs/en/1.5.0/phonegap/file/localfilesystem/localfilesystem.md
index c9db088..2885f8a 100644
--- a/www/docs/en/1.5.0/phonegap/file/localfilesystem/localfilesystem.md
+++ b/www/docs/en/1.5.0/phonegap/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/c4881540/www/docs/en/1.5.0/phonegap/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/file/metadata/metadata.md b/www/docs/en/1.5.0/phonegap/file/metadata/metadata.md
index a4df999..3dda5b6 100644
--- a/www/docs/en/1.5.0/phonegap/file/metadata/metadata.md
+++ b/www/docs/en/1.5.0/phonegap/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/c4881540/www/docs/en/1.5.0/phonegap/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/geolocation/Coordinates/coordinates.md b/www/docs/en/1.5.0/phonegap/geolocation/Coordinates/coordinates.md
index e272176..948bf89 100644
--- a/www/docs/en/1.5.0/phonegap/geolocation/Coordinates/coordinates.md
+++ b/www/docs/en/1.5.0/phonegap/geolocation/Coordinates/coordinates.md
@@ -39,7 +39,7 @@ Properties
Description
-----------
-The `Coordinates` object is created and populated by PhoneGap, 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 PhoneGap, 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
-------------------
@@ -50,7 +50,7 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -74,7 +74,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/c4881540/www/docs/en/1.5.0/phonegap/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/geolocation/Position/position.md b/www/docs/en/1.5.0/phonegap/geolocation/Position/position.md
index 0e883dc..2989dab 100644
--- a/www/docs/en/1.5.0/phonegap/geolocation/Position/position.md
+++ b/www/docs/en/1.5.0/phonegap/geolocation/Position/position.md
@@ -45,7 +45,7 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -70,7 +70,7 @@ Quick Example
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -105,7 +105,7 @@ Full Example
'Timestamp: ' + new Date(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/c4881540/www/docs/en/1.5.0/phonegap/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/geolocation/PositionError/positionError.md b/www/docs/en/1.5.0/phonegap/geolocation/PositionError/positionError.md
index f1c5ed9..f64233f 100644
--- a/www/docs/en/1.5.0/phonegap/geolocation/PositionError/positionError.md
+++ b/www/docs/en/1.5.0/phonegap/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,5 +41,5 @@ 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.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org