You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/09/11 06:41:12 UTC
[28/51] [partial] docs commit: Reverting autolinking change because
of inconsistencies.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/storage/sqlresultset/sqlresultset.md b/www/docs/en/1.5.0/phonegap/storage/sqlresultset/sqlresultset.md
index 99ea17e..72869c1 100644
--- a/www/docs/en/1.5.0/phonegap/storage/sqlresultset/sqlresultset.md
+++ b/www/docs/en/1.5.0/phonegap/storage/sqlresultset/sqlresultset.md
@@ -21,7 +21,7 @@ license: >
SQLResultSet
=======
-When the executeSql method of a <a href="../sqltransaction/sqltransaction.html">SQLTransaction</a> is called it will invoke it's callback with a SQLResultSet.
+When the executeSql method of a SQLTransaction is called it will invoke it's callback with a SQLResultSet.
Properties
-------
@@ -33,7 +33,7 @@ Properties
Details
-------
-When you call the <a href="../sqltransaction/sqltransaction.html">SQLTransaction</a> executeSql method it's callback methods will be called with a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type <a href="../sqlresultsetlist/sqlresultsetlist.html">SQLResultSetList</a> and it contains the data returned from a SQL select statement.
+When you call the SQLTransaction executeSql method it's callback methods will be called with a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement.
Supported Platforms
-------------------
@@ -42,7 +42,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 6.0 and higher)
- iPhone
-Execute SQL Quick <a href="../storage.opendatabase.html">Example</a>
+Execute SQL Quick Example
------------------
function queryDB(tx) {
@@ -62,23 +62,23 @@ Execute SQL Quick <a href="../storage.opendatabase.html">Example</a>
alert("Error processing SQL: "+err.code);
}
- var db = window.<a href="../storage.opendatabase.html">open<a href="../database/database.html">Database</a></a>("<a href="../database/database.html">Database</a>", "1.0", "PhoneGap Demo", 200000);
+ var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000);
db.transaction(queryDB, errorCB);
-Full <a href="../storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../../contacts/Contact/contact.html">Contact</a> <a href="../storage.opendatabase.html">Example</a></title>
+ <title>Contact Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Populate the database
//
@@ -115,21 +115,21 @@ Full <a href="../storage.opendatabase.html">Example</a>
// Transaction success callback
//
function successCB() {
- var db = window.<a href="../storage.opendatabase.html">open<a href="../database/database.html">Database</a></a>("<a href="../database/database.html">Database</a>", "1.0", "PhoneGap Demo", 200000);
+ var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000);
db.transaction(queryDB, errorCB);
}
// PhoneGap is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- var db = window.<a href="../storage.opendatabase.html">open<a href="../database/database.html">Database</a></a>("<a href="../database/database.html">Database</a>", "1.0", "PhoneGap Demo", 200000);
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000);
db.transaction(populateDB, errorCB, successCB);
}
</script>
</head>
<body>
- <h1><a href="../storage.opendatabase.html">Example</a></h1>
- <p><a href="../database/database.html">Database</a></p>
+ <h1>Example</h1>
+ <p>Database</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/storage/sqlresultsetlist/sqlresultsetlist.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/storage/sqlresultsetlist/sqlresultsetlist.md b/www/docs/en/1.5.0/phonegap/storage/sqlresultsetlist/sqlresultsetlist.md
index 7238287..8d31fc3 100644
--- a/www/docs/en/1.5.0/phonegap/storage/sqlresultsetlist/sqlresultsetlist.md
+++ b/www/docs/en/1.5.0/phonegap/storage/sqlresultsetlist/sqlresultsetlist.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../sqlresultset/sqlresultset.html">SQLResultSet</a>List
+SQLResultSetList
=======
-One of the properties of the <a href="../sqlresultset/sqlresultset.html">SQLResultSet</a> containing the rows returned from a SQL query.
+One of the properties of the SQLResultSet containing the rows returned from a SQL query.
Properties
-------
@@ -36,7 +36,7 @@ Methods
Details
-------
-The <a href="../sqlresultset/sqlresultset.html">SQLResultSet</a>List contains the data returned from a SQL select statement. The object contains a length property letting you know how many rows the select statement has been returned. To get a row of data you would call the `item` method specifying an index. The item method returns a JavaScript Object who's properties are the columns of the database the select statement was executed against.
+The SQLResultSetList contains the data returned from a SQL select statement. The object contains a length property letting you know how many rows the select statement has been returned. To get a row of data you would call the `item` method specifying an index. The item method returns a JavaScript Object who's properties are the columns of the database the select statement was executed against.
Supported Platforms
-------------------
@@ -45,7 +45,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 6.0 and higher)
- iPhone
-Execute SQL Quick <a href="../storage.opendatabase.html">Example</a>
+Execute SQL Quick Example
------------------
function queryDB(tx) {
@@ -64,23 +64,23 @@ Execute SQL Quick <a href="../storage.opendatabase.html">Example</a>
alert("Error processing SQL: "+err.code);
}
- var db = window.<a href="../storage.opendatabase.html">open<a href="../database/database.html">Database</a></a>("<a href="../database/database.html">Database</a>", "1.0", "PhoneGap Demo", 200000);
+ var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000);
db.transaction(queryDB, errorCB);
-Full <a href="../storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../../contacts/Contact/contact.html">Contact</a> <a href="../storage.opendatabase.html">Example</a></title>
+ <title>Contact Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Populate the database
//
@@ -116,21 +116,21 @@ Full <a href="../storage.opendatabase.html">Example</a>
// Transaction success callback
//
function successCB() {
- var db = window.<a href="../storage.opendatabase.html">open<a href="../database/database.html">Database</a></a>("<a href="../database/database.html">Database</a>", "1.0", "PhoneGap Demo", 200000);
+ var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000);
db.transaction(queryDB, errorCB);
}
// PhoneGap is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- var db = window.<a href="../storage.opendatabase.html">open<a href="../database/database.html">Database</a></a>("<a href="../database/database.html">Database</a>", "1.0", "PhoneGap Demo", 200000);
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000);
db.transaction(populateDB, errorCB, successCB);
}
</script>
</head>
<body>
- <h1><a href="../storage.opendatabase.html">Example</a></h1>
- <p><a href="../database/database.html">Database</a></p>
+ <h1>Example</h1>
+ <p>Database</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/storage/sqltransaction/sqltransaction.md b/www/docs/en/1.5.0/phonegap/storage/sqltransaction/sqltransaction.md
index af91dfb..0f16a82 100644
--- a/www/docs/en/1.5.0/phonegap/storage/sqltransaction/sqltransaction.md
+++ b/www/docs/en/1.5.0/phonegap/storage/sqltransaction/sqltransaction.md
@@ -21,7 +21,7 @@ license: >
SQLTransaction
=======
-Contains methods that allow the user to execute SQL statements against the <a href="../database/database.html">Database</a>.
+Contains methods that allow the user to execute SQL statements against the Database.
Methods
-------
@@ -31,7 +31,7 @@ Methods
Details
-------
-When you call a <a href="../database/database.html">Database</a> objects transaction method it's callback methods will be called with a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
+When you call a Database objects transaction method it's callback methods will be called with a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times.
Supported Platforms
-------------------
@@ -40,7 +40,7 @@ Supported Platforms
- BlackBerry WebWorks (OS 6.0 and higher)
- iPhone
-Execute SQL Quick <a href="../storage.opendatabase.html">Example</a>
+Execute SQL Quick Example
------------------
function populateDB(tx) {
@@ -58,28 +58,28 @@ Execute SQL Quick <a href="../storage.opendatabase.html">Example</a>
alert("success!");
}
- var db = window.<a href="../storage.opendatabase.html">open<a href="../database/database.html">Database</a></a>("<a href="../database/database.html">Database</a>", "1.0", "PhoneGap Demo", 200000);
+ var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000);
db.transaction(populateDB, errorCB, successCB);
-Full <a href="../storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../../contacts/Contact/contact.html">Contact</a> <a href="../storage.opendatabase.html">Example</a></title>
+ <title>Contact Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- var db = window.<a href="../storage.opendatabase.html">open<a href="../database/database.html">Database</a></a>("<a href="../database/database.html">Database</a>", "1.0", "PhoneGap Demo", 200000);
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000);
db.transaction(populateDB, errorCB, successCB);
}
@@ -107,7 +107,7 @@ Full <a href="../storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../storage.opendatabase.html">Example</a></h1>
+ <h1>Example</h1>
<p>SQLTransaction</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/storage/storage.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/storage/storage.md b/www/docs/en/1.5.0/phonegap/storage/storage.md
index 2fb2b39..1105697 100644
--- a/www/docs/en/1.5.0/phonegap/storage/storage.md
+++ b/www/docs/en/1.5.0/phonegap/storage/storage.md
@@ -23,27 +23,27 @@ Storage
> Provides access to the devices storage options.
-This API is based on the [W3C Web SQL <a href="database/database.html">Database</a> Specification](http://dev.w3.org/html5/webdatabase/) and [W3C Web Storage API Specification](http://dev.w3.org/html5/webstorage/). Some devices already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with PhoneGap's implementation. For devices that don't have storage support, PhoneGap's implementation should be compatible with the W3C specification.
+This API is based on the [W3C Web SQL Database Specification](http://dev.w3.org/html5/webdatabase/) and [W3C Web Storage API Specification](http://dev.w3.org/html5/webstorage/). Some devices already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with PhoneGap's implementation. For devices that don't have storage support, PhoneGap's implementation should be compatible with the W3C specification.
Methods
-------
-- <a href="storage.opendatabase.html">open<a href="database/database.html">Database</a></a>
+- openDatabase
Arguments
---------
-- <a href="parameters/name.html">name</a>
-- <a href="parameters/version.html">version</a>
-- <a href="parameters/display_<a href="parameters/name.html">name</a>.html">display_<a href="parameters/name.html">name</a></a>
-- <a href="parameters/size.html">size</a>
+- name
+- version
+- display_name
+- size
Objects
-------
-- <a href="database/database.html">Database</a>
-- <a href="sqltransaction/sqltransaction.html">SQLTransaction</a>
-- <a href="sqlresultset/sqlresultset.html">SQLResultSet</a>
-- <a href="sqlresultsetlist/sqlresultsetlist.html"><a href="sqlresultset/sqlresultset.html">SQLResultSet</a>List</a>
-- <a href="sqlerror/sqlerror.html">SQLError</a>
-- <a href="localstorage/localstorage.html">localStorage</a>
\ No newline at end of file
+- Database
+- SQLTransaction
+- SQLResultSet
+- SQLResultSetList
+- SQLError
+- localStorage
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.5.0/phonegap/storage/storage.opendatabase.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.5.0/phonegap/storage/storage.opendatabase.md b/www/docs/en/1.5.0/phonegap/storage/storage.opendatabase.md
index 79f00a6..e186398 100644
--- a/www/docs/en/1.5.0/phonegap/storage/storage.opendatabase.md
+++ b/www/docs/en/1.5.0/phonegap/storage/storage.opendatabase.md
@@ -18,19 +18,19 @@ license: >
under the License.
---
-open<a href="database/database.html">Database</a>
+openDatabase
===============
-Returns a new <a href="database/database.html">Database</a> object.
+Returns a new Database object.
- var dbShell = window.open<a href="database/database.html">Database</a>(<a href="parameters/name.html">name</a>, <a href="parameters/version.html">version</a>, <a href="parameters/display_<a href="parameters/name.html">name</a>.html">display_<a href="parameters/name.html">name</a></a>, <a href="parameters/size.html">size</a>);
+ var dbShell = window.openDatabase(name, version, display_name, size);
Description
-----------
-window.open<a href="database/database.html">Database</a> returns a new <a href="database/database.html">Database</a> object.
+window.openDatabase returns a new Database object.
-This method will create a new SQL Lite <a href="database/database.html">Database</a> and return a <a href="database/database.html">Database</a> object. Use the <a href="database/database.html">Database</a> Object to manipulate the data.
+This method will create a new SQL Lite Database and return a Database object. Use the Database Object to manipulate the data.
Supported Platforms
-------------------
@@ -42,7 +42,7 @@ Supported Platforms
Quick Example
-------------
- var db = window.open<a href="database/database.html">Database</a>("test", "1.0", "Test DB", 1000000);
+ var db = window.openDatabase("test", "1.0", "Test DB", 1000000);
Full Example
------------
@@ -50,25 +50,25 @@ Full Example
<!DOCTYPE html>
<html>
<head>
- <title><a href="../contacts/Contact/contact.html">Contact</a> Example</title>
+ <title>Contact Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for PhoneGap to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// PhoneGap is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
- var db = window.open<a href="database/database.html">Database</a>("test", "1.0", "Test DB", 1000000);
+ function onDeviceReady() {
+ var db = window.openDatabase("test", "1.0", "Test DB", 1000000);
}
</script>
</head>
<body>
<h1>Example</h1>
- <p>Open <a href="database/database.html">Database</a></p>
+ <p>Open Database</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/accelerometer/acceleration/acceleration.md b/www/docs/en/1.6.0/cordova/accelerometer/acceleration/acceleration.md
index 49b51fd..0cbd6f3 100644
--- a/www/docs/en/1.6.0/cordova/accelerometer/acceleration/acceleration.md
+++ b/www/docs/en/1.6.0/cordova/accelerometer/acceleration/acceleration.md
@@ -21,7 +21,7 @@ license: >
Acceleration
============
-Contains `<a href="../accelerometer.html">Accelerometer</a>` data captured at a specific point in time.
+Contains `Accelerometer` data captured at a specific point in time.
Properties
----------
@@ -34,7 +34,7 @@ Properties
Description
-----------
-This object is created and populated by Cordova, and returned by an `<a href="../accelerometer.html">Accelerometer</a>` method. The x, y, z acceleration values include the effect of gravity (9.81 m/s^2), so at when a device is lying flat on a table facing up, the value returned should be x=0, y=0, z=9.81.
+This object is created and populated by Cordova, and returned by an `Accelerometer` method. The x, y, z acceleration values include the effect of gravity (9.81 m/s^2), so at when a device is lying flat on a table facing up, the value returned should be x=0, y=0, z=9.81.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- iOS
- Windows Phone 7 (Mango)
-Quick <a href="../../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(acceleration) {
@@ -58,27 +58,27 @@ Quick <a href="../../storage/storage.opendatabase.html">Example</a>
alert('onError!');
};
- navigator.<a href="../accelerometer.getCurrentAcceleration.html">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
-Full <a href="../../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title>Acceleration <a href="../../storage/storage.opendatabase.html">Example</a></title>
+ <title>Acceleration Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../../device/device.html">Device</a>Ready() {
- navigator.<a href="../accelerometer.getCurrentAcceleration.html">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
+ function onDeviceReady() {
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
}
// onSuccess: Get a snapshot of the current acceleration
@@ -99,7 +99,7 @@ Full <a href="../../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
+ <h1>Example</h1>
<p>getCurrentAcceleration</p>
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.clearWatch.md b/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.clearWatch.md
index 6074e2a..3d1104d 100644
--- a/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.clearWatch.md
@@ -21,11 +21,11 @@ license: >
accelerometer.clearWatch
========================
-Stop watching the `<a href="acceleration/acceleration.html">Acceleration</a>` referenced by the watch ID parameter.
+Stop watching the `Acceleration` referenced by the watch ID parameter.
navigator.accelerometer.clearWatch(watchID);
-- __watchID__: The ID returned by `accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>`.
+- __watchID__: The ID returned by `accelerometer.watchAcceleration`.
Supported Platforms
-------------------
@@ -35,36 +35,36 @@ Supported Platforms
- iPhone
- Windows Phone 7 (Mango)
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
- var watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
+ var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
// ... later on ...
navigator.accelerometer.clearWatch(watchID);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Acceleration Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // The watch id references the current `watch<a href="acceleration/acceleration.html">Acceleration</a>`
+ // The watch id references the current `watchAcceleration`
var watchID = null;
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -75,7 +75,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
+ watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
}
// Stop watching the acceleration
@@ -91,9 +91,9 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = '<a href="acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '<br />' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '<br />' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '<br />' +
+ element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
+ 'Acceleration Y: ' + acceleration.y + '<br />' +
+ 'Acceleration Z: ' + acceleration.z + '<br />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index 07ac54d..e7d1de6 100644
--- a/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -18,19 +18,19 @@ license: >
under the License.
---
-accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>
+accelerometer.getCurrentAcceleration
====================================
Get the current acceleration along the x, y, and z axis.
- navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>, <a href="parameters/accelerometerError.html">accelerometerError</a>);
+ navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
Description
-----------
The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation. The accelerometer can detect 3D movement along the x, y, and z axis.
-The acceleration is returned using the `<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>` callback function.
+The acceleration is returned using the `accelerometerSuccess` callback function.
Supported Platforms
-------------------
@@ -40,13 +40,13 @@ Supported Platforms
- iPhone
- Windows Phone 7 (Mango)
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(acceleration) {
- alert('<a href="acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
@@ -54,35 +54,35 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
alert('onError!');
};
- navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError);
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Acceleration Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
- navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError);
+ function onDeviceReady() {
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
}
// onSuccess: Get a snapshot of the current acceleration
//
function onSuccess(acceleration) {
- alert('<a href="acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
}
@@ -95,8 +95,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
- <p>getCurrent<a href="acceleration/acceleration.html">Acceleration</a></p>
+ <h1>Example</h1>
+ <p>getCurrentAcceleration</p>
</body>
</html>
@@ -105,4 +105,4 @@ iPhone Quirks
- iPhone doesn't have the concept of getting the current acceleration at any given point.
- You must watch the acceleration and capture the data at given time intervals.
-- Thus, the `getCurrent<a href="acceleration/acceleration.html">Acceleration</a>` function will give you the last value reported from a Cordova `watch<a href="accelerometer.html">Accelerometer</a>` call.
+- Thus, the `getCurrentAcceleration` function will give you the last value reported from a Cordova `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.md b/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.md
index afb5e45..7607cd0 100644
--- a/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.md
+++ b/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.md
@@ -21,23 +21,23 @@ license: >
Accelerometer
=============
-> <a href="../media/capture/capture.html">Capture</a>s device motion in the x, y, and z direction.
+> Captures device motion in the x, y, and z direction.
Methods
-------
-- accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>
-- accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>
-- <a href="accelerometer.clearWatch.html">accelerometer.clearWatch</a>
+- accelerometer.getCurrentAcceleration
+- accelerometer.watchAcceleration
+- accelerometer.clearWatch
Arguments
---------
-- <a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>
-- <a href="parameters/accelerometerError.html">accelerometerError</a>
-- <a href="parameters/accelerometerOptions.html">accelerometerOptions</a>
+- accelerometerSuccess
+- accelerometerError
+- accelerometerOptions
Objects (Read-Only)
-------------------
-- <a href="acceleration/acceleration.html">Acceleration</a>
\ No newline at end of file
+- Acceleration
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.watchAcceleration.md b/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.watchAcceleration.md
index ef1c2e5..9b6fdfd 100644
--- a/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/www/docs/en/1.6.0/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -18,23 +18,23 @@ license: >
under the License.
---
-accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>
+accelerometer.watchAcceleration
===============================
At a regular interval, get the acceleration along the x, y, and z axis.
- var watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>,
- <a href="parameters/accelerometerError.html">accelerometerError</a>,
- [<a href="parameters/accelerometerOptions.html">accelerometerOptions</a>]);
+ var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
+ accelerometerError,
+ [accelerometerOptions]);
Description
-----------
The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current position. The accelerometer can detect 3D movement along the x, y, and z axis.
-The `accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>` gets the device's current acceleration at a regular interval. Each time the `<a href="acceleration/acceleration.html">Acceleration</a>` is retrieved, the `<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object.
+The `accelerometer.watchAcceleration` gets the device's current acceleration at a regular interval. Each time the `Acceleration` is retrieved, the `accelerometerSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object.
-The returned watch ID references references the accelerometer watch interval. The watch ID can be used with `<a href="accelerometer.clearWatch.html">accelerometer.clearWatch</a>` to stop watching the accelerometer.
+The returned watch ID references references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer.
Supported Platforms
-------------------
@@ -45,13 +45,13 @@ Supported Platforms
- Windows Phone 7 (Mango)
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(acceleration) {
- alert('<a href="acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
@@ -61,29 +61,29 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
var options = { frequency: 3000 }; // Update every 3 seconds
- var watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
+ var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Acceleration Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
<script type="text/javascript" charset="utf-8">
- // The watch id references the current `watch<a href="acceleration/acceleration.html">Acceleration</a>`
+ // The watch id references the current `watchAcceleration`
var watchID = null;
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -94,14 +94,14 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
+ watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
}
// Stop watching the acceleration
//
function stopWatch() {
if (watchID) {
- navigator.<a href="accelerometer.clearWatch.html">accelerometer.clearWatch</a>(watchID);
+ navigator.accelerometer.clearWatch(watchID);
watchID = null;
}
}
@@ -110,9 +110,9 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = '<a href="acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '<br />' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '<br />' +
- '<a href="acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '<br />' +
+ element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
+ 'Acceleration Y: ' + acceleration.y + '<br />' +
+ 'Acceleration Z: ' + acceleration.z + '<br />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerOptions.md b/www/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerOptions.md
index d105d2d..86fb292 100644
--- a/www/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerOptions.md
+++ b/www/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerOptions.md
@@ -26,4 +26,4 @@ An optional parameter to customize the retrieval of the accelerometer.
Options
-------
-- __frequency:__ How often to retrieve the `<a href="../acceleration/acceleration.html">Acceleration</a>` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
+- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerSuccess.md b/www/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerSuccess.md
index 5f448d2..67166dc 100644
--- a/www/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerSuccess.md
+++ b/www/docs/en/1.6.0/cordova/accelerometer/parameters/accelerometerSuccess.md
@@ -21,7 +21,7 @@ license: >
accelerometerSuccess
====================
-onSuccess callback function that provides the <a href="../acceleration/acceleration.html">Acceleration</a> information.
+onSuccess callback function that provides the Acceleration information.
function(acceleration) {
// Do something
@@ -30,14 +30,14 @@ onSuccess callback function that provides the <a href="../acceleration/accelerat
Parameters
----------
-- __acceleration:__ The acceleration at a single moment in time. (<a href="../acceleration/acceleration.html">Acceleration</a>)
+- __acceleration:__ The acceleration at a single moment in time. (Acceleration)
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
function onSuccess(acceleration) {
- alert('<a href="../acceleration/acceleration.html">Acceleration</a> X: ' + acceleration.x + '\n' +
- '<a href="../acceleration/acceleration.html">Acceleration</a> Y: ' + acceleration.y + '\n' +
- '<a href="../acceleration/acceleration.html">Acceleration</a> Z: ' + acceleration.z + '\n' +
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/camera/camera.getPicture.md b/www/docs/en/1.6.0/cordova/camera/camera.getPicture.md
index d259f47..f2f5052 100644
--- a/www/docs/en/1.6.0/cordova/camera/camera.getPicture.md
+++ b/www/docs/en/1.6.0/cordova/camera/camera.getPicture.md
@@ -23,16 +23,16 @@ camera.getPicture
Takes a photo using the camera or retrieves a photo from the device's album. The image is returned as a base64 encoded `String` or as the URI of an image file.
- navigator.camera.getPicture( <a href="parameter/cameraSuccess.html">cameraSuccess</a>, <a href="parameter/cameraError.html">cameraError</a>, [ <a href="parameter/cameraOptions.html">cameraOptions</a> ] );
+ navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] );
Description
-----------
-Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `<a href="camera.html">Camera</a>.sourceType = <a href="camera.html">Camera</a>.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
+Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `Camera.sourceType = Camera.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
-If `<a href="camera.html">Camera</a>.sourceType = <a href="camera.html">Camera</a>.PictureSourceType.PHOTOLIBRARY` or `<a href="camera.html">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected.
+If `Camera.sourceType = Camera.PictureSourceType.PHOTOLIBRARY` or `Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected.
-The return value will be sent to the `<a href="parameter/cameraSuccess.html">cameraSuccess</a>` function, in one of the following formats, depending on the `<a href="parameter/cameraOptions.html">cameraOptions</a>` you specify:
+The return value will be sent to the `cameraSuccess` function, in one of the following formats, depending on the `cameraOptions` you specify:
- A `String` containing the Base64 encoded photo image.
- A `String` representing the image file location on local storage (default).
@@ -40,10 +40,10 @@ The return value will be sent to the `<a href="parameter/cameraSuccess.html">cam
You can do whatever you want with the encoded image or URI, for example:
- Render the image in an `<img>` tag _(see example below)_
-- Save the data locally (`Local<a href="../storage/storage.html">Storage</a>`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
+- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
- Post the data to a remote server
-Note: The image quality of pictures taken using the camera on newer devices is quite good. _Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800)._ Therefore, using FILE_URI as the '<a href="camera.html">Camera</a>.destinationType' is highly recommended.
+Note: The image quality of pictures taken using the camera on newer devices is quite good. _Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800)._ Therefore, using FILE_URI as the 'Camera.destinationType' is highly recommended.
Supported Platforms
-------------------
@@ -61,13 +61,13 @@ Invoking the native camera application while your device is connected
via Zune will not work, and the error callback will be triggered.
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
Take photo and retrieve Base64-encoded image:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: <a href="camera.html">Camera</a>.DestinationType.DATA_URL
+ destinationType: Camera.DestinationType.DATA_URL
});
function onSuccess(imageData) {
@@ -82,7 +82,7 @@ Take photo and retrieve Base64-encoded image:
Take photo and retrieve image file location:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: <a href="camera.html">Camera</a>.DestinationType.FILE_URI });
+ destinationType: Camera.DestinationType.FILE_URI });
function onSuccess(imageURI) {
var image = document.getElementById('myImage');
@@ -94,13 +94,13 @@ Take photo and retrieve image file location:
}
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="../media/capture/capture.html">Capture</a> Photo</title>
+ <title>Capture Photo</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -110,11 +110,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for Cordova to connect with the device
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>",on<a href="../device/device.html">Device</a>Ready,false);
+ document.addEventListener("deviceready",onDeviceReady,false);
// Cordova is ready to be used!
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
pictureSource=navigator.camera.PictureSourceType;
destinationType=navigator.camera.DestinationType;
}
@@ -193,8 +193,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
</script>
</head>
<body>
- <button onclick="capturePhoto();"><a href="../media/capture/capture.html">Capture</a> Photo</button> <br>
- <button onclick="capturePhotoEdit();"><a href="../media/capture/capture.html">Capture</a> Editable Photo</button> <br>
+ <button onclick="capturePhoto();">Capture Photo</button> <br>
+ <button onclick="capturePhotoEdit();">Capture Editable Photo</button> <br>
<button onclick="getPhoto(pictureSource.PHOTOLIBRARY);">From Photo Library</button><br>
<button onclick="getPhoto(pictureSource.SAVEDPHOTOALBUM);">From Photo Album</button><br>
<img style="display:none;width:60px;height:60px;" id="smallImage" src="" />
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/camera/camera.md b/www/docs/en/1.6.0/cordova/camera/camera.md
index 4608c34..611035d 100644
--- a/www/docs/en/1.6.0/cordova/camera/camera.md
+++ b/www/docs/en/1.6.0/cordova/camera/camera.md
@@ -26,4 +26,4 @@ Camera
Methods
-------
-- <a href="camera.getPicture.html">camera.getPicture</a>
\ No newline at end of file
+- camera.getPicture
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/camera/parameter/cameraOptions.md b/www/docs/en/1.6.0/cordova/camera/parameter/cameraOptions.md
index bc9b1f4..82deba8 100644
--- a/www/docs/en/1.6.0/cordova/camera/parameter/cameraOptions.md
+++ b/www/docs/en/1.6.0/cordova/camera/parameter/cameraOptions.md
@@ -24,10 +24,10 @@ cameraOptions
Optional parameters to customize the camera settings.
{ quality : 75,
- destinationType : <a href="../camera.html">Camera</a>.DestinationType.DATA_URL,
- sourceType : <a href="../camera.html">Camera</a>.PictureSourceType.CAMERA,
+ destinationType : Camera.DestinationType.DATA_URL,
+ sourceType : Camera.PictureSourceType.CAMERA,
allowEdit : true,
- encodingType: <a href="../camera.html">Camera</a>.EncodingType.JPEG,
+ encodingType: Camera.EncodingType.JPEG,
targetWidth: 100,
targetHeight: 100 };
@@ -38,14 +38,14 @@ Options
- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`)
- <a href="../camera.html">Camera</a>.DestinationType = {
+ Camera.DestinationType = {
DATA_URL : 0, // Return image as base64 encoded string
FILE_URI : 1 // Return image file URI
};
- __sourceType:__ Set the source of the picture. Defined in nagivator.camera.PictureSourceType (`Number`)
- <a href="../camera.html">Camera</a>.PictureSourceType = {
+ Camera.PictureSourceType = {
PHOTOLIBRARY : 0,
CAMERA : 1,
SAVEDPHOTOALBUM : 2
@@ -55,7 +55,7 @@ Options
- __encodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`)
- <a href="../camera.html">Camera</a>.EncodingType = {
+ Camera.EncodingType = {
JPEG : 0, // Return JPEG encoded image
PNG : 1 // Return PNG encoded image
};
@@ -63,9 +63,9 @@ Options
- __targetWidth:__ Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained. (`Number`)
- __targetHeight:__ Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (`Number`)
-- __mediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.<a href="../../media/media.html">Media</a>Type (`Number`)
+- __mediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (`Number`)
- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type = {
+ Camera.MediaType = {
PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
ALLMEDIA : 2 // allow selection from all media types
@@ -78,8 +78,8 @@ Android Quirks
--------------
- Ignores the `allowEdit` parameter.
-- <a href="../camera.html">Camera</a>.PictureSourceType.PHOTOLIBRARY and <a href="../camera.html">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
-- <a href="../camera.html">Camera</a>.EncodingType is not supported.
+- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
+- Camera.EncodingType is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
@@ -89,9 +89,9 @@ BlackBerry Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Application must have key injection permissions to close native <a href="../camera.html">Camera</a> application after photo is taken.
+- Application must have key injection permissions to close native Camera application after photo is taken.
- Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).
-- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
+- Camera.MediaType is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
@@ -101,7 +101,7 @@ Palm Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
+- Camera.MediaType is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/camera/parameter/cameraSuccess.md b/www/docs/en/1.6.0/cordova/camera/parameter/cameraSuccess.md
index 6083130..ec04795 100644
--- a/www/docs/en/1.6.0/cordova/camera/parameter/cameraSuccess.md
+++ b/www/docs/en/1.6.0/cordova/camera/parameter/cameraSuccess.md
@@ -30,9 +30,9 @@ onSuccess callback function that provides the image data.
Parameters
----------
-- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `<a href="cameraOptions.html">cameraOptions</a>` used. (`String`)
+- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `cameraOptions` used. (`String`)
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
// Show image
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/compass/compass.clearWatch.md b/www/docs/en/1.6.0/cordova/compass/compass.clearWatch.md
index 81a884c..c5cf648 100644
--- a/www/docs/en/1.6.0/cordova/compass/compass.clearWatch.md
+++ b/www/docs/en/1.6.0/cordova/compass/compass.clearWatch.md
@@ -25,7 +25,7 @@ Stop watching the compass referenced by the watch ID parameter.
navigator.compass.clearWatch(watchID);
-- __watchID__: The ID returned by `<a href="compass.watchHeading.html">compass.watchHeading</a>`.
+- __watchID__: The ID returned by `compass.watchHeading`.
Supported Platforms
-------------------
@@ -34,22 +34,22 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango ) if available in hardware
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
- var watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
+ var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
// ... later on ...
navigator.compass.clearWatch(watchID);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Compass Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -59,11 +59,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -74,7 +74,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Update compass every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
+ watchID = navigator.compass.watchHeading(onSuccess, onError, options);
}
// Stop watching the compass
@@ -95,8 +95,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the heading
//
- function onError(<a href="parameters/compassError.html">compassError</a>) {
- alert('<a href="compass.html">Compass</a> error: ' + <a href="parameters/compassError.html">compassError</a>.code);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/compass/compass.clearWatchFilter.md b/www/docs/en/1.6.0/cordova/compass/compass.clearWatchFilter.md
index 9cf3e19..276c11f 100644
--- a/www/docs/en/1.6.0/cordova/compass/compass.clearWatchFilter.md
+++ b/www/docs/en/1.6.0/cordova/compass/compass.clearWatchFilter.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="compass.clearWatch.html">compass.clearWatch</a>Filter
+compass.clearWatchFilter
========================
-No longer supported as of 1.6. See `<a href="compass.clearWatch.html">compass.clearWatch</a>`.
\ No newline at end of file
+No longer supported as of 1.6. See `compass.clearWatch`.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/compass/compass.getCurrentHeading.md b/www/docs/en/1.6.0/cordova/compass/compass.getCurrentHeading.md
index ee22d57..33fefb1 100644
--- a/www/docs/en/1.6.0/cordova/compass/compass.getCurrentHeading.md
+++ b/www/docs/en/1.6.0/cordova/compass/compass.getCurrentHeading.md
@@ -23,14 +23,14 @@ compass.getCurrentHeading
Get the current compass heading.
- navigator.compass.getCurrentHeading(<a href="parameters/compassSuccess.html">compassSuccess</a>, <a href="parameters/compassError.html">compassError</a>, <a href="parameters/compassOptions.html">compassOptions</a>);
+ navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
Description
-----------
The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
-The compass heading information is returned via a <a href="compass.html">Compass</a>Heading object using the `<a href="parameters/compassSuccess.html">compassSuccess</a>` callback function.
+The compass heading information is returned via a CompassHeading object using the `compassSuccess` callback function.
Supported Platforms
-------------------
@@ -39,7 +39,7 @@ Supported Platforms
- iPhone
- Windows Phone 7 ( Mango ) if available in hardware
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(heading) {
@@ -47,29 +47,29 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
};
function onError(error) {
- alert('<a href="<a href="parameters/compassError.html">compassError</a>/<a href="parameters/compassError.html">compassError</a>.html"><a href="compass.html">Compass</a>Error</a>: ' error.code);
+ alert('CompassError: ' error.code);
};
navigator.compass.getCurrentHeading(onSuccess, onError);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Compass Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
navigator.compass.getCurrentHeading(onSuccess, onError);
}
@@ -81,14 +81,14 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the heading
//
- function onError(<a href="parameters/compassError.html">compassError</a>) {
- alert('<a href="compass.html">Compass</a> Error: ' + <a href="parameters/compassError.html">compassError</a>.code);
+ function onError(compassError) {
+ alert('Compass Error: ' + compassError.code);
}
</script>
</head>
<body>
- <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
+ <h1>Example</h1>
<p>getCurrentHeading</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/compass/compass.md b/www/docs/en/1.6.0/cordova/compass/compass.md
index febba7c..beb83e2 100644
--- a/www/docs/en/1.6.0/cordova/compass/compass.md
+++ b/www/docs/en/1.6.0/cordova/compass/compass.md
@@ -26,16 +26,16 @@ Compass
Methods
-------
-- <a href="compass.getCurrentHeading.html">compass.getCurrentHeading</a>
-- <a href="compass.watchHeading.html">compass.watchHeading</a>
-- <a href="compass.clearWatch.html">compass.clearWatch</a>
-- <a href="<a href="compass.watchHeading.html">compass.watchHeading</a>Filter.html"><a href="compass.watchHeading.html">compass.watchHeading</a>Filter</a> (obsolete)
-- <a href="<a href="compass.clearWatch.html">compass.clearWatch</a>Filter.html"><a href="compass.clearWatch.html">compass.clearWatch</a>Filter</a> (obsolete)
+- compass.getCurrentHeading
+- compass.watchHeading
+- compass.clearWatch
+- compass.watchHeadingFilter (obsolete)
+- compass.clearWatchFilter (obsolete)
Arguments
---------
-- <a href="parameters/compassSuccess.html">compassSuccess</a>
-- <a href="parameters/compassError.html">compassError</a>
-- <a href="parameters/compassOptions.html">compassOptions</a>
-- <a href="parameters/compassHeading.html">compassHeading</a>
+- compassSuccess
+- compassError
+- compassOptions
+- compassHeading
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/compass/compass.watchHeading.md b/www/docs/en/1.6.0/cordova/compass/compass.watchHeading.md
index bddbfe6..9b07dfe 100644
--- a/www/docs/en/1.6.0/cordova/compass/compass.watchHeading.md
+++ b/www/docs/en/1.6.0/cordova/compass/compass.watchHeading.md
@@ -23,16 +23,16 @@ compass.watchHeading
At a regular interval, get the compass heading in degrees.
- var watchID = navigator.compass.watchHeading(<a href="parameters/compassSuccess.html">compassSuccess</a>, <a href="parameters/compassError.html">compassError</a>, [<a href="parameters/compassOptions.html">compassOptions</a>]);
+ var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
Description
-----------
The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
-The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `<a href="parameters/compassOptions.html">compassOptions</a>` object.
+The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `compassOptions` object.
-The returned watch ID references references the compass watch interval. The watch ID can be used with `<a href="compass.clearWatch.html">compass.clearWatch</a>` to stop watching the compass.
+The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass.
Supported Platforms
-------------------
@@ -42,7 +42,7 @@ Supported Platforms
- Windows Phone 7 ( Mango ) if available in hardware
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
function onSuccess(heading) {
@@ -50,21 +50,21 @@ Quick <a href="../storage/storage.opendatabase.html">Example</a>
element.innerHTML = 'Heading: ' + heading.magneticHeading;
};
- function onError(<a href="parameters/compassError.html">compassError</a>) {
- alert('<a href="compass.html">Compass</a> error: ' + <a href="parameters/compassError.html">compassError</a>.code);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
};
var options = { frequency: 3000 }; // Update every 3 seconds
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>Compass Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -74,11 +74,11 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
//
- function on<a href="../device/device.html">Device</a>Ready() {
+ function onDeviceReady() {
startWatch();
}
@@ -96,7 +96,7 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
//
function stopWatch() {
if (watchID) {
- navigator.<a href="compass.clearWatch.html">compass.clearWatch</a>(watchID);
+ navigator.compass.clearWatch(watchID);
watchID = null;
}
}
@@ -110,8 +110,8 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
// onError: Failed to get the heading
//
- function onError(<a href="parameters/compassError.html">compassError</a>) {
- alert('<a href="compass.html">Compass</a> error: ' + <a href="parameters/compassError.html">compassError</a>.code);
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
}
</script>
@@ -126,6 +126,6 @@ Full <a href="../storage/storage.opendatabase.html">Example</a>
iOS Quirks
--------------
-In iOS `compass.watchHeading` can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `<a href="parameters/compassOptions.html">compassOptions</a>` object. Clear the watch as normal by passing the returned watch ID to `<a href="compass.clearWatch.html">compass.clearWatch</a>`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
+In iOS `compass.watchHeading` can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `compassOptions` object. Clear the watch as normal by passing the returned watch ID to `compass.clearWatch`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
In iOS only one watchHeading can be in effect at one time. If a watchHeading via filter is in effect, calling getCurrentHeading or watchHeading will use the existing filter value for specifying heading changes. On iOS watching heading changes via a filter is more efficient than via time.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/compass/compass.watchHeadingFilter.md b/www/docs/en/1.6.0/cordova/compass/compass.watchHeadingFilter.md
index f05a774..991da30 100644
--- a/www/docs/en/1.6.0/cordova/compass/compass.watchHeadingFilter.md
+++ b/www/docs/en/1.6.0/cordova/compass/compass.watchHeadingFilter.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-<a href="compass.watchHeading.html">compass.watchHeading</a>Filter
+compass.watchHeadingFilter
==========================
-No longer supported as of 1.6, see `<a href="compass.watchHeading.html">compass.watchHeading</a>` for equivalent functionality.
+No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/compass/compassError/compassError.md b/www/docs/en/1.6.0/cordova/compass/compassError/compassError.md
index e356b45..20d01c5 100644
--- a/www/docs/en/1.6.0/cordova/compass/compassError/compassError.md
+++ b/www/docs/en/1.6.0/cordova/compass/compassError/compassError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-<a href="../compass.html">Compass</a>Error
+CompassError
==========
-A `<a href="../compass.html">Compass</a>Error` object is returned to the `<a href="../parameters/compassError.html">compassError</a>` callback function when an error occurs.
+A `CompassError` object is returned to the `compassError` callback function when an error occurs.
Properties
----------
@@ -30,12 +30,12 @@ Properties
Constants
---------
-- `<a href="../compass.html">Compass</a>Error.COMPASS_INTERNAL_ERR`
-- `<a href="../compass.html">Compass</a>Error.COMPASS_NOT_SUPPORTED`
+- `CompassError.COMPASS_INTERNAL_ERR`
+- `CompassError.COMPASS_NOT_SUPPORTED`
Description
-----------
-The `<a href="../compass.html">Compass</a>Error` object is returned to the user through the `<a href="../parameters/compassError.html">compassError</a>` callback function when an error occurs.
+The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/compass/parameters/compassError.md b/www/docs/en/1.6.0/cordova/compass/parameters/compassError.md
index 44700bc..3d2f523 100644
--- a/www/docs/en/1.6.0/cordova/compass/parameters/compassError.md
+++ b/www/docs/en/1.6.0/cordova/compass/parameters/compassError.md
@@ -23,9 +23,9 @@ compassError
onError callback function for compass functions.
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
-function(<a href="../compassError/compassError.html"><a href="../compass.html">Compass</a>Error</a>) {
+function(CompassError) {
// Handle the error
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/compass/parameters/compassHeading.md b/www/docs/en/1.6.0/cordova/compass/parameters/compassHeading.md
index 8293202..adae2f6 100644
--- a/www/docs/en/1.6.0/cordova/compass/parameters/compassHeading.md
+++ b/www/docs/en/1.6.0/cordova/compass/parameters/compassHeading.md
@@ -21,7 +21,7 @@ license: >
compassHeading
==========
-A `<a href="../compass.html">Compass</a>Heading` object is returned to the `<a href="compassSuccess.html">compassSuccess</a>` callback function when an error occurs.
+A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs.
Properties
----------
@@ -33,7 +33,7 @@ Properties
Description
-----------
-The `<a href="../compass.html">Compass</a>Heading` object is returned to the user through the `<a href="compassSuccess.html">compassSuccess</a>` callback function.
+The `CompassHeading` object is returned to the user through the `compassSuccess` callback function.
Android Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/compass/parameters/compassSuccess.md b/www/docs/en/1.6.0/cordova/compass/parameters/compassSuccess.md
index 015bb3f..a9bc5ff 100644
--- a/www/docs/en/1.6.0/cordova/compass/parameters/compassSuccess.md
+++ b/www/docs/en/1.6.0/cordova/compass/parameters/compassSuccess.md
@@ -21,7 +21,7 @@ license: >
compassSuccess
==============
-onSuccess callback function that provides the compass heading information via a <a href="compassHeading.html">compassHeading</a> object.
+onSuccess callback function that provides the compass heading information via a compassHeading object.
function(heading) {
// Do something
@@ -31,9 +31,9 @@ Parameters
----------
-- __heading:__ The heading information. _(<a href="compassHeading.html">compassHeading</a>)_
+- __heading:__ The heading information. _(compassHeading)_
-<a href="../../storage/storage.opendatabase.html">Example</a>
+Example
-------
function onSuccess(heading) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/connection/connection.md b/www/docs/en/1.6.0/cordova/connection/connection.md
index 525d57f..6b6d22c 100644
--- a/www/docs/en/1.6.0/cordova/connection/connection.md
+++ b/www/docs/en/1.6.0/cordova/connection/connection.md
@@ -28,7 +28,7 @@ This object is accessed under the navigator.network interface.
Properties
----------
-- <a href="connection.type.html">connection.type</a>
+- connection.type
Constants
---------
@@ -45,5 +45,5 @@ WP7 Quirk
---------
- __type:__
-Windows Phone Emulator always reports navigator.network.<a href="connection.type.html">connection.type</a> is Connection.UNKNOWN
+Windows Phone Emulator always reports navigator.network.connection.type is Connection.UNKNOWN
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/connection/connection.type.md b/www/docs/en/1.6.0/cordova/connection/connection.type.md
index 495c663..3282e14 100644
--- a/www/docs/en/1.6.0/cordova/connection/connection.type.md
+++ b/www/docs/en/1.6.0/cordova/connection/connection.type.md
@@ -37,61 +37,61 @@ Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
- Windows Phone 7 ( Mango )
-Quick <a href="../storage/storage.opendatabase.html">Example</a>
+Quick Example
-------------
- function check<a href="connection.html">Connection</a>() {
+ function checkConnection() {
var networkState = navigator.network.connection.type;
var states = {};
- states[<a href="connection.html">Connection</a>.UNKNOWN] = 'Unknown connection';
- states[<a href="connection.html">Connection</a>.ETHERNET] = 'Ethernet connection';
- states[<a href="connection.html">Connection</a>.WIFI] = 'WiFi connection';
- states[<a href="connection.html">Connection</a>.CELL_2G] = 'Cell 2G connection';
- states[<a href="connection.html">Connection</a>.CELL_3G] = 'Cell 3G connection';
- states[<a href="connection.html">Connection</a>.CELL_4G] = 'Cell 4G connection';
- states[<a href="connection.html">Connection</a>.NONE] = 'No network connection';
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.NONE] = 'No network connection';
- alert('<a href="connection.html">Connection</a> type: ' + states[networkState]);
+ alert('Connection type: ' + states[networkState]);
}
- check<a href="connection.html">Connection</a>();
+ checkConnection();
-Full <a href="../storage/storage.opendatabase.html">Example</a>
+Full Example
------------
<!DOCTYPE html>
<html>
<head>
- <title>navigator.network.connection.type <a href="../storage/storage.opendatabase.html">Example</a></title>
+ <title>navigator.network.connection.type Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is loaded and it is now safe to make calls Cordova methods
//
- function on<a href="../device/device.html">Device</a>Ready() {
- check<a href="connection.html">Connection</a>();
+ function onDeviceReady() {
+ checkConnection();
}
- function check<a href="connection.html">Connection</a>() {
+ function checkConnection() {
var networkState = navigator.network.connection.type;
var states = {};
- states[<a href="connection.html">Connection</a>.UNKNOWN] = 'Unknown connection';
- states[<a href="connection.html">Connection</a>.ETHERNET] = 'Ethernet connection';
- states[<a href="connection.html">Connection</a>.WIFI] = 'WiFi connection';
- states[<a href="connection.html">Connection</a>.CELL_2G] = 'Cell 2G connection';
- states[<a href="connection.html">Connection</a>.CELL_3G] = 'Cell 3G connection';
- states[<a href="connection.html">Connection</a>.CELL_4G] = 'Cell 4G connection';
- states[<a href="connection.html">Connection</a>.NONE] = 'No network connection';
-
- alert('<a href="connection.html">Connection</a> type: ' + states[networkState]);
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.NONE] = 'No network connection';
+
+ alert('Connection type: ' + states[networkState]);
}
</script>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org