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:07 UTC
[23/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.6.0/cordova/storage/sqlresultsetlist/sqlresultsetlist.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/storage/sqlresultsetlist/sqlresultsetlist.md b/www/docs/en/1.6.0/cordova/storage/sqlresultsetlist/sqlresultsetlist.md
index 71ec126..4a6b46f 100644
--- a/www/docs/en/1.6.0/cordova/storage/sqlresultsetlist/sqlresultsetlist.md
+++ b/www/docs/en/1.6.0/cordova/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", "Cordova Demo", 200000);
+ var db = window.openDatabase("Database", "1.0", "Cordova 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.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);
// 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", "Cordova Demo", 200000);
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
db.transaction(queryDB, errorCB);
}
// Cordova 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", "Cordova Demo", 200000);
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "Cordova 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.6.0/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/storage/sqltransaction/sqltransaction.md b/www/docs/en/1.6.0/cordova/storage/sqltransaction/sqltransaction.md
index a111968..155fd64 100644
--- a/www/docs/en/1.6.0/cordova/storage/sqltransaction/sqltransaction.md
+++ b/www/docs/en/1.6.0/cordova/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", "Cordova Demo", 200000);
+ var db = window.openDatabase("Database", "1.0", "Cordova 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.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() {
- 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", "Cordova Demo", 200000);
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "Cordova 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.6.0/cordova/storage/storage.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/storage/storage.md b/www/docs/en/1.6.0/cordova/storage/storage.md
index db98812..9970c74 100644
--- a/www/docs/en/1.6.0/cordova/storage/storage.md
+++ b/www/docs/en/1.6.0/cordova/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 Cordova's implementation. For devices that don't have storage support, Cordova'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 Cordova's implementation. For devices that don't have storage support, Cordova'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">database_name</a>
-- <a href="parameters/version.html">database_version</a>
-- <a href="parameters/display_name.html">database_displayname</a>
-- <a href="parameters/size.html">database_size</a>
+- database_name
+- database_version
+- database_displayname
+- database_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.6.0/cordova/storage/storage.opendatabase.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/cordova/storage/storage.opendatabase.md b/www/docs/en/1.6.0/cordova/storage/storage.opendatabase.md
index e727650..dfe0eef 100644
--- a/www/docs/en/1.6.0/cordova/storage/storage.opendatabase.md
+++ b/www/docs/en/1.6.0/cordova/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">database_name</a>, <a href="parameters/version.html">database_version</a>, <a href="parameters/display_name.html">database_displayname</a>, <a href="parameters/size.html">database_size</a>);
+ var dbShell = window.openDatabase(database_name, database_version, database_displayname, database_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.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() {
- 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/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/guide/getting-started/android/index.md b/www/docs/en/1.6.0/guide/getting-started/android/index.md
index de741a5..3cb6dc9 100644
--- a/www/docs/en/1.6.0/guide/getting-started/android/index.md
+++ b/www/docs/en/1.6.0/guide/getting-started/android/index.md
@@ -99,7 +99,7 @@ This guide describes how to set up your development environment for Cordova and
-4. <a href="../webos/index.html">Hello World</a>
+4. Hello World
--------------
- Create and open a new file named **index.html** in the **assets/www** directory. Paste the following code:
@@ -111,7 +111,7 @@ This guide describes how to set up your development environment for Cordova and
<script type="text/javascript" charset="utf-8" src="cordova-1.6.0.js"></script>
</head>
<body>
- <h1><a href="../webos/index.html">Hello World</a></h1>
+ <h1>Hello World</h1>
</body>
</html>
@@ -122,7 +122,7 @@ This guide describes how to set up your development environment for Cordova and
- Eclipse will ask you to select an appropriate AVD. If there isn't one, then you'll need to create it.
-5B. Deploy to <a href="../../../cordova/device/device.html">Device</a>
+5B. Deploy to Device
--------------------
- Make sure USB debugging is enabled on your device and plug it into your system. (**Settings > Applications > Development**)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/guide/getting-started/blackberry/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/guide/getting-started/blackberry/index.md b/www/docs/en/1.6.0/guide/getting-started/blackberry/index.md
index 698e7ea..8aeb884 100644
--- a/www/docs/en/1.6.0/guide/getting-started/blackberry/index.md
+++ b/www/docs/en/1.6.0/guide/getting-started/blackberry/index.md
@@ -55,7 +55,7 @@ Cordova for BlackBerry makes use of the [BlackBerry WebWorks framework](https://
- Open up the project.properties file with your favorite editor and edit the entries for `blackberry.bbwp.dir=` and/or `playbook.bbwp.dir=`. Set the value(s) to the directory containing the `bbwp` binary in the WebWorks SDK(s) installed earlier.
-4. <a href="../webos/index.html">Hello World</a>
+4. Hello World
--------------
Build the Cordova sample project by typing `ant target build` in your command prompt/terminal while you are in your project's directory. Replace `target` with either `blackberry` or `playbook`. Note this is a sample Cordova project and not a basic hello world application. The provided index.html in the www contains example usages of many of the Cordova API.
@@ -75,7 +75,7 @@ BlackBerry smartphone simulators are only available on Windows. PlayBook simulat
- While in your project directory, in command prompt/terminal type `ant target load-simulator`. Replace `target` with either `blackberry` or `playbook`. Note, for PlayBook the simulator virtual image must already be started.
- The application will be installed in the All Applications section in the simulator. Note, on BlackBerry OS 5 the application is installed in the Downloads folder.
-5B. Deploy to <a href="../../../cordova/device/device.html">Device</a> (Windows and Mac)
+5B. Deploy to Device (Windows and Mac)
--------------------------------------
- Deploying to a device requires signing keys which can be obtained from RIM.
@@ -91,7 +91,7 @@ BlackBerry smartphone simulators are only available on Windows. PlayBook simulat
- `playbook.sigtool.csk.password` : Signing key password.
- `playbook.sigtool.p12.password` : Signing key password.
- `playbook.device.ip` : IP address of device obtained when placing the device in developer mode through device security settings.
- - `playbook.device.password` : <a href="../../../cordova/device/device.html">Device</a> password which is set through device security settings.
+ - `playbook.device.password` : Device password which is set through device security settings.
- While in your project directory, in command prompt/terminal type `ant target load-device`. Replace `target` with either `blackberry` or `playbook`.
- The application will be installed in the All Applications section in the device. Note, on BlackBerry OS 5 the application is installed in the Downloads folder.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/guide/getting-started/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/guide/getting-started/index.md b/www/docs/en/1.6.0/guide/getting-started/index.md
index 451866d..124d04d 100644
--- a/www/docs/en/1.6.0/guide/getting-started/index.md
+++ b/www/docs/en/1.6.0/guide/getting-started/index.md
@@ -21,9 +21,9 @@ license: >
Getting Started Guides
======================
-- <a href="android/index.html">Getting Started with Android</a>
-- <a href="blackberry/index.html">Getting Started with BlackBerry</a>
-- <a href="ios/index.html">Getting Started with iOS</a>
-- <a href="symbian/index.html">Getting Started with Symbian</a>
-- <a href="webos/index.html">Getting Started with WebOS</a>
-- <a href="windows-phone/index.html">Getting Started with Windows Phone</a>
\ No newline at end of file
+- Getting Started with Android
+- Getting Started with BlackBerry
+- Getting Started with iOS
+- Getting Started with Symbian
+- Getting Started with WebOS
+- Getting Started with Windows Phone
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/guide/getting-started/ios/index.md b/www/docs/en/1.6.0/guide/getting-started/ios/index.md
index f6f4502..4eebc57 100644
--- a/www/docs/en/1.6.0/guide/getting-started/ios/index.md
+++ b/www/docs/en/1.6.0/guide/getting-started/ios/index.md
@@ -32,7 +32,7 @@ Video Tutorials:
1. Requirements
---------------
- Intel-based computer with Mac OS X Lion (10.7)
-- Necessary for Installing on <a href="../../../cordova/device/device.html">Device</a>:
+- Necessary for Installing on Device:
- An Apple iOS device (iPhone, iPad, iPod Touch)
- iOS developer certification
@@ -48,7 +48,7 @@ Video Tutorials:
--------------------
- Launch Xcode
-- Select the **<a href="../../../cordova/file/fileobj/fileobj.html">File</a>** menu
+- Select the **File** menu
- Select **New**, then **New Project...**
- Select **Cordova-based Application** from the list of templates
@@ -86,12 +86,12 @@ Video Tutorials:
- Select the **Finish** button
-4. <a href="../webos/index.html">Hello World</a>
+4. Hello World
--------------
- Select the folder named **www** in your Project Navigator in Xcode
- Select the **index.html** file
-- Type `<h1><a href="../webos/index.html">Hello World</a></h1>` after the `<body>` tag
+- Type `<h1>Hello World</h1>` after the `<body>` tag
You can also add any associated JavaScript and CSS files there as well.
@@ -103,10 +103,10 @@ You can also add any associated JavaScript and CSS files there as well.
- Select the **Run** button in your project window's toolbar
-5B. Deploy to <a href="../../../cordova/device/device.html">Device</a>
+5B. Deploy to Device
--------------------
-- Open [AppName]-Info.plist (where [AppName] is your application's name), under the "Supporting <a href="../../../cordova/file/fileobj/fileobj.html">File</a>s" group
+- Open [AppName]-Info.plist (where [AppName] is your application's name), under the "Supporting Files" group
- Change **BundleIdentifier** to the identifier provided by Apple, or your own bundle identifier. If you have a developer license, you can access and run the Assistant [here](http://developer.apple.com/iphone/manage/overview/index.action) and register your app.
- Change the Active SDK in the Scheme drop-down menu on the toolbar to **[DEVICENAME]** where [DEVICENAME] is the name of the device you want to deploy to.
- Select the **Run** button in your project window's toolbar
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/guide/getting-started/symbian/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/guide/getting-started/symbian/index.md b/www/docs/en/1.6.0/guide/getting-started/symbian/index.md
index 9fd0938..aaac5e1 100644
--- a/www/docs/en/1.6.0/guide/getting-started/symbian/index.md
+++ b/www/docs/en/1.6.0/guide/getting-started/symbian/index.md
@@ -50,11 +50,11 @@ There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGa
- In cygwin, navigate to where you extracted Cordova and go into the Symbian directory</li>
-4. <a href="../webos/index.html">Hello World</a>
+4. Hello World
--------------
- Open up index.html located in phonegap/symbian/framework/www with your favourite editor.
-- In the `body` tag, remove the line `"Build your phonegap app here! Dude!"` and add the line `<h1><a href="../webos/index.html">Hello World</a></h1>`
+- In the `body` tag, remove the line `"Build your phonegap app here! Dude!"` and add the line `<h1>Hello World</h1>`
- In cygwin/terminal, type make. This will produce phonegap-symbian.wrt/app.wgz.
@@ -66,7 +66,7 @@ There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGa
- Load the phonegap-symbian.wrt/app.wgz file into the emulator.
-5B. Deploy to <a href="../../../cordova/device/device.html">Device</a>
+5B. Deploy to Device
--------------------
- Load the phonegap-symbian.wrt/app.wgz file into the device using bluetooth or email.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/guide/getting-started/webos/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/guide/getting-started/webos/index.md b/www/docs/en/1.6.0/guide/getting-started/webos/index.md
index e87bd6a..68d7570 100644
--- a/www/docs/en/1.6.0/guide/getting-started/webos/index.md
+++ b/www/docs/en/1.6.0/guide/getting-started/webos/index.md
@@ -65,7 +65,7 @@ In phonegap/webOS/framework/www, open up index.html with your favourite editor.
- Type `make` in your terminal/cygwin while in the webOS directory.
-5B. Deploy to <a href="../../../cordova/device/device.html">Device</a>
+5B. Deploy to Device
--------------------
- Make sure your device is in [Developer Mode and plug it in.](http://developer.palm.com/index.php?option=com_content&view=article&id=1552&Itemid=59#dev_mode)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/guide/getting-started/windows-phone/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/guide/getting-started/windows-phone/index.md b/www/docs/en/1.6.0/guide/getting-started/windows-phone/index.md
index 1497693..cc334e9 100644
--- a/www/docs/en/1.6.0/guide/getting-started/windows-phone/index.md
+++ b/www/docs/en/1.6.0/guide/getting-started/windows-phone/index.md
@@ -37,7 +37,7 @@ Video Tutorials:
Note: Running in VM has issues, if you are on a Mac, you will need to setup a bootcamp partition with Windows 7 or Vista
-Necessary for Installing on <a href="../../../cordova/device/device.html">Device</a> and Submitting to Market Place:
+Necessary for Installing on Device and Submitting to Market Place:
- Become an [App Hub member](http://create.msdn.com/en-US/home/membership).
@@ -84,7 +84,7 @@ Necessary for Installing on <a href="../../../cordova/device/device.html">Device
In order to test your application on a device, the device must be registered. Click [here][register-url] to read documentation on deploying and testing on your Windows Phone.
- Make sure your phone is connected, and the screen is unlocked
-- In Visual Studio, select 'Windows Phone <a href="../../../cordova/device/device.html">Device</a>' from the top drop-down menu.
+- In Visual Studio, select 'Windows Phone Device' from the top drop-down menu.
- Hit the green **play button** beside the drop-down menu to start debugging or press F5.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.0/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.0/index.md b/www/docs/en/1.6.0/index.md
index 4204baf..1924993 100644
--- a/www/docs/en/1.6.0/index.md
+++ b/www/docs/en/1.6.0/index.md
@@ -22,62 +22,62 @@ license: >
<h1>API Reference</h1>
<ul>
<li>
- <h2><a href="cordova/accelerometer/accelerometer.html">Accelerometer</a></h2>
+ <h2>Accelerometer</h2>
<span>Tap into the device's motion sensor.</span>
</li>
<li>
- <h2><a href="cordova/camera/camera.html">Camera</a></h2>
- <span><a href="cordova/media/capture/capture.html">Capture</a> a photo using the device's camera.</span>
+ <h2>Camera</h2>
+ <span>Capture a photo using the device's camera.</span>
</li>
<li>
- <h2><a href="cordova/media/capture/capture.html">Capture</a></h2>
- <span><a href="cordova/media/capture/capture.html">Capture</a> media files using device's media capture applications.</span>
+ <h2>Capture</h2>
+ <span>Capture media files using device's media capture applications.</span>
</li>
<li>
- <h2><a href="cordova/compass/compass.html">Compass</a></h2>
+ <h2>Compass</h2>
<span>Obtain the direction that the device is pointing.</span>
</li>
<li>
- <h2><a href="cordova/connection/connection.html">Connection</a></h2>
+ <h2>Connection</h2>
<span>Quickly check the network state, and cellular network information.</span>
</li>
<li>
- <h2><a href="cordova/contacts/Contact/contact.html">Contact</a>s</h2>
+ <h2>Contacts</h2>
<span>Work with the devices contact database.</span>
</li>
<li>
- <h2><a href="cordova/device/device.html">Device</a></h2>
+ <h2>Device</h2>
<span>Gather device specific information.</span>
</li>
<li>
- <h2><a href="cordova/events/events.html">Events</a></h2>
+ <h2>Events</h2>
<span>Hook into native events through JavaScript.</span>
</li>
<li>
- <h2><a href="cordova/file/fileobj/fileobj.html">File</a></h2>
+ <h2>File</h2>
<span>Hook into native file system through JavaScript.</span>
</li>
<li>
- <h2><a href="cordova/geolocation/geolocation.html">Geolocation</a></h2>
+ <h2>Geolocation</h2>
<span>Make your application location aware.</span>
</li>
<li>
- <h2><a href="cordova/media/media.html">Media</a></h2>
+ <h2>Media</h2>
<span>Record and play back audio files.</span>
</li>
<li>
- <h2><a href="cordova/notification/notification.html">Notification</a></h2>
+ <h2>Notification</h2>
<span>Visual, audible, and tactile device notifications.</span>
</li>
<li>
- <h2><a href="cordova/storage/storage.html">Storage</a></h2>
+ <h2>Storage</h2>
<span>Hook into the devices native storage options.</span>
</li>
</ul>
<h1>Guides</h1>
<ul>
<li>
- <h2><a href="guide/getting-started/index.html">Getting Started Guides</a></h2>
+ <h2>Getting Started Guides</h2>
<span>Setup each SDK and create your first Cordova app.</span>
</li>
<li>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af6a5545/www/docs/en/1.6.1/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/accelerometer/acceleration/acceleration.md b/www/docs/en/1.6.1/cordova/accelerometer/acceleration/acceleration.md
index d9ca346..0f55774 100644
--- a/www/docs/en/1.6.1/cordova/accelerometer/acceleration/acceleration.md
+++ b/www/docs/en/1.6.1/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.1.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.1/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.clearWatch.md b/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.clearWatch.md
index c5df16e..3c44a67 100644
--- a/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/www/docs/en/1.6.1/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.1.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.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index 4996cd6..bed2ee7 100644
--- a/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/www/docs/en/1.6.1/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.1.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.1/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.md b/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.md
index afb5e45..7607cd0 100644
--- a/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.md
+++ b/www/docs/en/1.6.1/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.1/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.watchAcceleration.md b/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.watchAcceleration.md
index 4a5bfd2..e7ab82a 100644
--- a/www/docs/en/1.6.1/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/www/docs/en/1.6.1/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.1.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.1/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/accelerometer/parameters/accelerometerOptions.md b/www/docs/en/1.6.1/cordova/accelerometer/parameters/accelerometerOptions.md
index d105d2d..86fb292 100644
--- a/www/docs/en/1.6.1/cordova/accelerometer/parameters/accelerometerOptions.md
+++ b/www/docs/en/1.6.1/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.1/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/accelerometer/parameters/accelerometerSuccess.md b/www/docs/en/1.6.1/cordova/accelerometer/parameters/accelerometerSuccess.md
index 5f448d2..67166dc 100644
--- a/www/docs/en/1.6.1/cordova/accelerometer/parameters/accelerometerSuccess.md
+++ b/www/docs/en/1.6.1/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.1/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/camera/camera.getPicture.md b/www/docs/en/1.6.1/cordova/camera/camera.getPicture.md
index 8ceab96..77de411 100644
--- a/www/docs/en/1.6.1/cordova/camera/camera.getPicture.md
+++ b/www/docs/en/1.6.1/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.1.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.1/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/camera/camera.md b/www/docs/en/1.6.1/cordova/camera/camera.md
index 4608c34..611035d 100644
--- a/www/docs/en/1.6.1/cordova/camera/camera.md
+++ b/www/docs/en/1.6.1/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.1/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/camera/parameter/cameraOptions.md b/www/docs/en/1.6.1/cordova/camera/parameter/cameraOptions.md
index bc9b1f4..82deba8 100644
--- a/www/docs/en/1.6.1/cordova/camera/parameter/cameraOptions.md
+++ b/www/docs/en/1.6.1/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.1/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/camera/parameter/cameraSuccess.md b/www/docs/en/1.6.1/cordova/camera/parameter/cameraSuccess.md
index 6083130..ec04795 100644
--- a/www/docs/en/1.6.1/cordova/camera/parameter/cameraSuccess.md
+++ b/www/docs/en/1.6.1/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.1/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/compass/compass.clearWatch.md b/www/docs/en/1.6.1/cordova/compass/compass.clearWatch.md
index 1bd6803..562cce1 100644
--- a/www/docs/en/1.6.1/cordova/compass/compass.clearWatch.md
+++ b/www/docs/en/1.6.1/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.1.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.1/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/compass/compass.clearWatchFilter.md b/www/docs/en/1.6.1/cordova/compass/compass.clearWatchFilter.md
index 9cf3e19..276c11f 100644
--- a/www/docs/en/1.6.1/cordova/compass/compass.clearWatchFilter.md
+++ b/www/docs/en/1.6.1/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.1/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/compass/compass.getCurrentHeading.md b/www/docs/en/1.6.1/cordova/compass/compass.getCurrentHeading.md
index fa2a7d1..4225db0 100644
--- a/www/docs/en/1.6.1/cordova/compass/compass.getCurrentHeading.md
+++ b/www/docs/en/1.6.1/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.1.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.1/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/compass/compass.md b/www/docs/en/1.6.1/cordova/compass/compass.md
index febba7c..beb83e2 100644
--- a/www/docs/en/1.6.1/cordova/compass/compass.md
+++ b/www/docs/en/1.6.1/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.1/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/compass/compass.watchHeading.md b/www/docs/en/1.6.1/cordova/compass/compass.watchHeading.md
index 104b9f9..9c2e9e8 100644
--- a/www/docs/en/1.6.1/cordova/compass/compass.watchHeading.md
+++ b/www/docs/en/1.6.1/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.1.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.1/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/compass/compass.watchHeadingFilter.md b/www/docs/en/1.6.1/cordova/compass/compass.watchHeadingFilter.md
index f05a774..991da30 100644
--- a/www/docs/en/1.6.1/cordova/compass/compass.watchHeadingFilter.md
+++ b/www/docs/en/1.6.1/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.1/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/compass/compassError/compassError.md b/www/docs/en/1.6.1/cordova/compass/compassError/compassError.md
index e356b45..20d01c5 100644
--- a/www/docs/en/1.6.1/cordova/compass/compassError/compassError.md
+++ b/www/docs/en/1.6.1/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.1/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/compass/parameters/compassError.md b/www/docs/en/1.6.1/cordova/compass/parameters/compassError.md
index 44700bc..3d2f523 100644
--- a/www/docs/en/1.6.1/cordova/compass/parameters/compassError.md
+++ b/www/docs/en/1.6.1/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.1/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.6.1/cordova/compass/parameters/compassHeading.md b/www/docs/en/1.6.1/cordova/compass/parameters/compassHeading.md
index 8293202..adae2f6 100644
--- a/www/docs/en/1.6.1/cordova/compass/parameters/compassHeading.md
+++ b/www/docs/en/1.6.1/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
--------------
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org