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/10 23:28:08 UTC
[08/51] [partial] docs commit: Solidifying 'automatic' links.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/guide/getting-started/android/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/getting-started/android/index.md b/www/docs/en/1.8.0/guide/getting-started/android/index.md
index ffe1662..0e10360 100644
--- a/www/docs/en/1.8.0/guide/getting-started/android/index.md
+++ b/www/docs/en/1.8.0/guide/getting-started/android/index.md
@@ -98,7 +98,7 @@ This guide describes how to set up your development environment for Cordova and
-4. Hello World
+4. <a href="../webos/index.html">Hello World</a>
--------------
- Create and open a new file named **index.html** in the **assets/www** directory. Paste the following code:
@@ -110,7 +110,7 @@ This guide describes how to set up your development environment for Cordova and
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
</head>
<body>
- <h1>Hello World</h1>
+ <h1><a href="../webos/index.html">Hello World</a></h1>
</body>
</html>
@@ -121,7 +121,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 Device
+5B. Deploy to <a href="../../../cordova/device/device.html">Device</a>
--------------------
- 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/89392fa8/www/docs/en/1.8.0/guide/getting-started/bada/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/getting-started/bada/index.md b/www/docs/en/1.8.0/guide/getting-started/bada/index.md
index e93287c..09ba9b0 100644
--- a/www/docs/en/1.8.0/guide/getting-started/bada/index.md
+++ b/www/docs/en/1.8.0/guide/getting-started/bada/index.md
@@ -39,7 +39,7 @@ This guide describes how to set up your development environment for Cordova and
3. Setup New Project
--------------------
-- In Bada IDE, select _File_ -> Import project -> Bada C++ / Flash Project.
+- In Bada IDE, select _<a href="../../../cordova/file/fileobj/fileobj.html">File</a>_ -> Import project -> Bada C++ / Flash Project.
- Note: Bada 1.2 select "Bada Application Project"
@@ -54,7 +54,7 @@ This guide describes how to set up your development environment for Cordova and
-4. Hello World
+4. <a href="../webos/index.html">Hello World</a>
--------------
**Bada 2.x**: Your HTML/CSS/Javascript code lives under the Res/ folder. Make sure your index.html contains the following two lines in the <head> section.
@@ -80,7 +80,7 @@ This guide describes how to set up your development environment for Cordova and
- Right click on your project's folder and select Run As -> bada Simulator Application. You need to close the emulator every time you update your app!
-5B. Deploy to Device
+5B. Deploy to <a href="../../../cordova/device/device.html">Device</a>
--------------------
- Make sure your device is properly configured
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/guide/getting-started/blackberry/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/getting-started/blackberry/index.md b/www/docs/en/1.8.0/guide/getting-started/blackberry/index.md
index 8aeb884..698e7ea 100644
--- a/www/docs/en/1.8.0/guide/getting-started/blackberry/index.md
+++ b/www/docs/en/1.8.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. Hello World
+4. <a href="../webos/index.html">Hello World</a>
--------------
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 Device (Windows and Mac)
+5B. Deploy to <a href="../../../cordova/device/device.html">Device</a> (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` : Device password which is set through device security settings.
+ - `playbook.device.password` : <a href="../../../cordova/device/device.html">Device</a> 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/89392fa8/www/docs/en/1.8.0/guide/getting-started/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/getting-started/index.md b/www/docs/en/1.8.0/guide/getting-started/index.md
index 2bddf89..cef668b 100644
--- a/www/docs/en/1.8.0/guide/getting-started/index.md
+++ b/www/docs/en/1.8.0/guide/getting-started/index.md
@@ -21,10 +21,10 @@ license: >
Getting Started Guides
======================
-- 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
-- Getting Started with Bada
+- <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>
+- <a href="bada/index.html">Getting Started with Bada</a>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/getting-started/ios/index.md b/www/docs/en/1.8.0/guide/getting-started/ios/index.md
index 4420b6d..ef7cbb1 100644
--- a/www/docs/en/1.8.0/guide/getting-started/ios/index.md
+++ b/www/docs/en/1.8.0/guide/getting-started/ios/index.md
@@ -48,7 +48,7 @@ Setup New Project
-----------------
- Launch Xcode
-- Select the _File Menu_
+- Select the _<a href="../../../cordova/file/fileobj/fileobj.html">File</a> Menu_
- Select _New_ -> _New Project..._
- Select _Cordova-based Application_ from the list of templates
@@ -92,14 +92,14 @@ in Xcode project templates.
-Hello World
+<a href="../webos/index.html">Hello World</a>
-----------
- Select the folder named `www` in the Xcode _Project Navigator_
- Select the file `index.html`
- Add the following after `<body>`:
- <h1>Hello World</h1>
+ <h1><a href="../webos/index.html">Hello World</a></h1>
You can also add any associated JavaScript and CSS files there as well.
@@ -109,13 +109,13 @@ Deploy to Simulator
- Change the _Active SDK_ in the Scheme drop-down menu on the toolbar to _iOS version Simulator_
- Select the _Run_ button in your project window's toolbar
-Deploy to Device
+Deploy to <a href="../../../cordova/device/device.html">Device</a>
----------------
-- Open `YourAppName-Info.plist`, under the _Supporting Files_ group
+- Open `YourAppName-Info.plist`, under the _Supporting <a href="../../../cordova/file/fileobj/fileobj.html">File</a>s_ group
- Change _BundleIdentifier_ to the identifier provided by Apple or your own bundle identifier
- If you have a developer license, you can run the [Assistant](http://developer.apple.com/iphone/manage/overview/index.action) to register your app
-- Change the _Active SDK_ in the Scheme drop-down menu on the toolbar to _YourDeviceName_
+- Change the _Active SDK_ in the Scheme drop-down menu on the toolbar to _Your<a href="../../../cordova/device/device.html">Device</a>Name_
- You will need to have your device connected via USB
- Select the _Run_ button in your project window's toolbar
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/guide/getting-started/symbian/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/getting-started/symbian/index.md b/www/docs/en/1.8.0/guide/getting-started/symbian/index.md
index aaac5e1..9fd0938 100644
--- a/www/docs/en/1.8.0/guide/getting-started/symbian/index.md
+++ b/www/docs/en/1.8.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. Hello World
+4. <a href="../webos/index.html">Hello World</a>
--------------
- 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>Hello World</h1>`
+- 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 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 Device
+5B. Deploy to <a href="../../../cordova/device/device.html">Device</a>
--------------------
- 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/89392fa8/www/docs/en/1.8.0/guide/getting-started/webos/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/getting-started/webos/index.md b/www/docs/en/1.8.0/guide/getting-started/webos/index.md
index 68d7570..e87bd6a 100644
--- a/www/docs/en/1.8.0/guide/getting-started/webos/index.md
+++ b/www/docs/en/1.8.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 Device
+5B. Deploy to <a href="../../../cordova/device/device.html">Device</a>
--------------------
- 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/89392fa8/www/docs/en/1.8.0/guide/getting-started/windows-phone/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/getting-started/windows-phone/index.md b/www/docs/en/1.8.0/guide/getting-started/windows-phone/index.md
index cc334e9..1497693 100644
--- a/www/docs/en/1.8.0/guide/getting-started/windows-phone/index.md
+++ b/www/docs/en/1.8.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 Device and Submitting to Market Place:
+Necessary for Installing on <a href="../../../cordova/device/device.html">Device</a> 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 Device and Submitting to Market Place:
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 Device' from the top drop-down menu.
+- In Visual Studio, select 'Windows Phone <a href="../../../cordova/device/device.html">Device</a>' 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/89392fa8/www/docs/en/1.8.0/guide/upgrading/blackberry/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/upgrading/blackberry/index.md b/www/docs/en/1.8.0/guide/upgrading/blackberry/index.md
index b4afe55..489ff3b 100644
--- a/www/docs/en/1.8.0/guide/upgrading/blackberry/index.md
+++ b/www/docs/en/1.8.0/guide/upgrading/blackberry/index.md
@@ -36,16 +36,16 @@ Updating just the www folder:
- If playbook, then update the .js file in the `playbook/` folder.
5. Update your HTML to use the new `cordova-1.8.0.js` file.
6. Update your `www/plugins.xml` file. Two plugins changed their
- namespace/service label. Change the old entries for the Capture and
- Contact plugins from:
+ namespace/service label. Change the old entries for the <a href="../../../cordova/media/capture/capture.html">Capture</a> and
+ <a href="../../../cordova/contacts/Contact/contact.html">Contact</a> plugins from:
- <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/>
- <plugin name="Contact" value="org.apache.cordova.pim.Contact"/>
+ <plugin name="<a href="../../../cordova/media/capture/capture.html">Capture</a>" value="org.apache.cordova.media.<a href="../../../cordova/media/media.html">Media</a><a href="../../../cordova/media/capture/capture.html">Capture</a>"/>
+ <plugin name="<a href="../../../cordova/contacts/Contact/contact.html">Contact</a>" value="org.apache.cordova.pim.<a href="../../../cordova/contacts/Contact/contact.html">Contact</a>"/>
To:
- <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
- <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
+ <plugin name="<a href="../../../cordova/media/capture/capture.html">Capture</a>" value="org.apache.cordova.capture.<a href="../../../cordova/media/media.html">Media</a><a href="../../../cordova/media/capture/capture.html">Capture</a>"/>
+ <plugin name="<a href="../../../cordova/contacts/Contact/contact.html">Contact</a>s" value="org.apache.cordova.pim.<a href="../../../cordova/contacts/Contact/contact.html">Contact</a>"/>
Updating the sample folder (ie, updating using the ant tools):
@@ -59,13 +59,13 @@ Updating the sample folder (ie, updating using the ant tools):
7. Open the `www/` folder and update your HTML to use the new `cordova-1.8.0.js` file.
8. Open the `www/` folder and update the `plugins.xml` file. Two plugins
changed their namespace/service label. Change the old entries for the
- Capture and Contact plugins from:
+ <a href="../../../cordova/media/capture/capture.html">Capture</a> and <a href="../../../cordova/contacts/Contact/contact.html">Contact</a> plugins from:
- <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/>
- <plugin name="Contact" value="org.apache.cordova.pim.Contact"/>
+ <plugin name="<a href="../../../cordova/media/capture/capture.html">Capture</a>" value="org.apache.cordova.media.<a href="../../../cordova/media/media.html">Media</a><a href="../../../cordova/media/capture/capture.html">Capture</a>"/>
+ <plugin name="<a href="../../../cordova/contacts/Contact/contact.html">Contact</a>" value="org.apache.cordova.pim.<a href="../../../cordova/contacts/Contact/contact.html">Contact</a>"/>
To:
- <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
- <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
+ <plugin name="<a href="../../../cordova/media/capture/capture.html">Capture</a>" value="org.apache.cordova.capture.<a href="../../../cordova/media/media.html">Media</a><a href="../../../cordova/media/capture/capture.html">Capture</a>"/>
+ <plugin name="<a href="../../../cordova/contacts/Contact/contact.html">Contact</a>s" value="org.apache.cordova.pim.<a href="../../../cordova/contacts/Contact/contact.html">Contact</a>"/>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/guide/upgrading/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/upgrading/index.md b/www/docs/en/1.8.0/guide/upgrading/index.md
index b539a58..6e981c4 100644
--- a/www/docs/en/1.8.0/guide/upgrading/index.md
+++ b/www/docs/en/1.8.0/guide/upgrading/index.md
@@ -23,10 +23,10 @@ Upgrading Guides
> Learn how to upgrade an application to the latest Apache Cordova release.
-- Upgrading Cordova Android
-- Upgrading Cordova Bada
-- Upgrading Cordova BlackBerry
-- Upgrading Cordova iOS
-- Upgrading Cordova Symbian
-- Upgrading Cordova webOS
-- Upgrading Cordova Windows Phone
+- <a href="android/index.html">Upgrading Cordova Android</a>
+- <a href="bada/index.html">Upgrading Cordova Bada</a>
+- <a href="blackberry/index.html">Upgrading Cordova BlackBerry</a>
+- <a href="ios/index.html">Upgrading Cordova iOS</a>
+- <a href="symbian/index.html">Upgrading Cordova Symbian</a>
+- <a href="webos/index.html">Upgrading Cordova webOS</a>
+- <a href="windows-phone/index.html">Upgrading Cordova Windows Phone</a>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/guide/upgrading/ios/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/upgrading/ios/index.md b/www/docs/en/1.8.0/guide/upgrading/ios/index.md
index b5ab36b..e86c4f1 100644
--- a/www/docs/en/1.8.0/guide/upgrading/ios/index.md
+++ b/www/docs/en/1.8.0/guide/upgrading/ios/index.md
@@ -28,8 +28,8 @@ Upgrading Cordova iOS
3. **Copy** the **www/cordova-1.8.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.7.x.js** file
4. **Update** the Cordova script reference in your **www/index.html** file (and any other files that contain the script reference) to point to the new **cordova-1.8.0.js** file
-If you intend on using the **Capture API**, you will need the new **iPad retina-display** assets:
+If you intend on using the **<a href="../../../cordova/media/capture/capture.html">Capture</a> API**, you will need the new **iPad retina-display** assets:
-1. **Copy** the **Resources/Capture.bundle** item from the new project into your project folder, over-writing your existing **Resources/Capture.bundle** item
-2. In your project, select the **Capture.bundle** item into Xcode into your Project Navigator, and press the **Delete** key, then select **Remove Reference** from the dialog that pops up.
-3. Drag the new **Capture.bundle** from Step 1. above into Xcode into your Project Navigator, and select the **Create groups for any added folders** radio-button
+1. **Copy** the **Resources/<a href="../../../cordova/media/capture/capture.html">Capture</a>.bundle** item from the new project into your project folder, over-writing your existing **Resources/<a href="../../../cordova/media/capture/capture.html">Capture</a>.bundle** item
+2. In your project, select the **<a href="../../../cordova/media/capture/capture.html">Capture</a>.bundle** item into Xcode into your Project Navigator, and press the **Delete** key, then select **Remove Reference** from the dialog that pops up.
+3. Drag the new **<a href="../../../cordova/media/capture/capture.html">Capture</a>.bundle** from Step 1. above into Xcode into your Project Navigator, and select the **Create groups for any added folders** radio-button
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/guide/whitelist/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/guide/whitelist/index.md b/www/docs/en/1.8.0/guide/whitelist/index.md
index dec4216..4aba002 100644
--- a/www/docs/en/1.8.0/guide/whitelist/index.md
+++ b/www/docs/en/1.8.0/guide/whitelist/index.md
@@ -107,7 +107,7 @@ iOS
### Details
1. Open `Cordova.plist`.
- - In Xcode, it is found at `AppName/Supporting Files/Cordova.plist`
+ - In Xcode, it is found at `AppName/Supporting <a href="../../cordova/file/fileobj/fileobj.html">File</a>s/Cordova.plist`
- In the directory, it is found at `AppName/Cordova.plist`
2. Add a new `String` value under the `ExternalHosts` key.
- We recommend using Xcode to avoid editing raw XML.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.0/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/index.md b/www/docs/en/1.8.0/index.md
index 1a07d88..0706f65 100644
--- a/www/docs/en/1.8.0/index.md
+++ b/www/docs/en/1.8.0/index.md
@@ -22,70 +22,70 @@ license: >
<h1>API Reference</h1>
<ul>
<li>
- <h2>Accelerometer</h2>
+ <h2><a href="cordova/accelerometer/accelerometer.html">Accelerometer</a></h2>
<span>Tap into the device's motion sensor.</span>
</li>
<li>
- <h2>Camera</h2>
- <span>Capture a photo using the device's camera.</span>
+ <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>
</li>
<li>
- <h2>Capture</h2>
- <span>Capture media files using device's media capture applications.</span>
+ <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>
</li>
<li>
- <h2>Compass</h2>
+ <h2><a href="cordova/compass/compass.html">Compass</a></h2>
<span>Obtain the direction that the device is pointing.</span>
</li>
<li>
- <h2>Connection</h2>
+ <h2><a href="cordova/connection/connection.html">Connection</a></h2>
<span>Quickly check the network state, and cellular network information.</span>
</li>
<li>
- <h2>Contacts</h2>
+ <h2><a href="cordova/contacts/Contact/contact.html">Contact</a>s</h2>
<span>Work with the devices contact database.</span>
</li>
<li>
- <h2>Device</h2>
+ <h2><a href="cordova/device/device.html">Device</a></h2>
<span>Gather device specific information.</span>
</li>
<li>
- <h2>Events</h2>
+ <h2><a href="cordova/events/events.html">Events</a></h2>
<span>Hook into native events through JavaScript.</span>
</li>
<li>
- <h2>File</h2>
+ <h2><a href="cordova/file/fileobj/fileobj.html">File</a></h2>
<span>Hook into native file system through JavaScript.</span>
</li>
<li>
- <h2>Geolocation</h2>
+ <h2><a href="cordova/geolocation/geolocation.html">Geolocation</a></h2>
<span>Make your application location aware.</span>
</li>
<li>
- <h2>Media</h2>
+ <h2><a href="cordova/media/media.html">Media</a></h2>
<span>Record and play back audio files.</span>
</li>
<li>
- <h2>Notification</h2>
+ <h2><a href="cordova/notification/notification.html">Notification</a></h2>
<span>Visual, audible, and tactile device notifications.</span>
</li>
<li>
- <h2>Storage</h2>
+ <h2><a href="cordova/storage/storage.html">Storage</a></h2>
<span>Hook into the devices native storage options.</span>
</li>
</ul>
<h1>Guides</h1>
<ul>
<li>
- <h2>Getting Started Guides</h2>
+ <h2><a href="guide/getting-started/index.html">Getting Started Guides</a></h2>
<span>Setup each SDK and create your first Cordova app.</span>
</li>
<li>
- <h2>Upgrading Guides</h2>
+ <h2><a href="guide/upgrading/index.html">Upgrading Guides</a></h2>
<span>Upgrade an application to the latest Cordova release.</span>
</li>
<li>
- <h2>Domain Whitelist Guide</h2>
+ <h2><a href="guide/whitelist/index.html">Domain Whitelist Guide</a></h2>
<span>Grant an application access to external domains.</span>
</li>
<li>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/acceleration/acceleration.md b/www/docs/en/1.8.1/cordova/accelerometer/acceleration/acceleration.md
index 75d3aad..fe40b82 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/acceleration/acceleration.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/acceleration/acceleration.md
@@ -21,7 +21,7 @@ license: >
Acceleration
============
-Contains `Accelerometer` data captured at a specific point in time.
+Contains `<a href="../accelerometer.html">Accelerometer</a>` 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 `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.
+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.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(acceleration) {
@@ -60,27 +60,27 @@ Quick Example
alert('onError!');
};
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+ navigator.<a href="../accelerometer.getCurrentAcceleration.html">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
-Full Example
+Full <a href="../../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Acceleration Example</title>
+ <title>Acceleration <a href="../../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../../events/events.deviceready.html">deviceready</a>", on<a href="../../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+ function on<a href="../../device/device.html">Device</a>Ready() {
+ navigator.<a href="../accelerometer.getCurrentAcceleration.html">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
}
// onSuccess: Get a snapshot of the current acceleration
@@ -101,7 +101,7 @@ Full Example
</script>
</head>
<body>
- <h1>Example</h1>
+ <h1><a href="../../storage/storage.opendatabase.html">Example</a></h1>
<p>getCurrentAcceleration</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.clearWatch.md b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.clearWatch.md
index e57c4aa..0fb6817 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.clearWatch.md
@@ -21,11 +21,11 @@ license: >
accelerometer.clearWatch
========================
-Stop watching the `Acceleration` referenced by the watch ID parameter.
+Stop watching the `<a href="acceleration/acceleration.html">Acceleration</a>` referenced by the watch ID parameter.
navigator.accelerometer.clearWatch(watchID);
-- __watchID__: The ID returned by `accelerometer.watchAcceleration`.
+- __watchID__: The ID returned by `accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>`.
Supported Platforms
-------------------
@@ -36,36 +36,36 @@ Supported Platforms
- Windows Phone 7 (Mango)
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
- var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ var watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
// ... later on ...
navigator.accelerometer.clearWatch(watchID);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Acceleration Example</title>
+ <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // The watch id references the current `watchAcceleration`
+ // The watch id references the current `watch<a href="acceleration/acceleration.html">Acceleration</a>`
var watchID = null;
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
startWatch();
}
@@ -76,7 +76,7 @@ Full Example
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
}
// Stop watching the acceleration
@@ -92,9 +92,9 @@ Full Example
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
- 'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
+ 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 />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index 57d2988..bdda006 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -18,19 +18,19 @@ license: >
under the License.
---
-accelerometer.getCurrentAcceleration
+accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>
====================================
Get the current acceleration along the x, y, and z axis.
- navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
+ navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>, <a href="parameters/accelerometerError.html">accelerometerError</a>);
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 `accelerometerSuccess` callback function.
+The acceleration is returned using the `<a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>` callback function.
Supported Platforms
-------------------
@@ -41,13 +41,13 @@ Supported Platforms
- Windows Phone 7 (Mango)
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
+ 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' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
@@ -55,35 +55,35 @@ Quick Example
alert('onError!');
};
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+ navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Acceleration Example</title>
+ <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+ function on<a href="../device/device.html">Device</a>Ready() {
+ navigator.accelerometer.getCurrent<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError);
}
// onSuccess: Get a snapshot of the current acceleration
//
function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
+ 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' +
'Timestamp: ' + acceleration.timestamp + '\n');
}
@@ -96,8 +96,8 @@ Full Example
</script>
</head>
<body>
- <h1>Example</h1>
- <p>getCurrentAcceleration</p>
+ <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
+ <p>getCurrent<a href="acceleration/acceleration.html">Acceleration</a></p>
</body>
</html>
@@ -106,4 +106,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 `getCurrentAcceleration` function will give you the last value reported from a Cordova `watchAccelerometer` call.
+- 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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.md b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.md
index 5aec54d..f7c4802 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.md
@@ -21,26 +21,26 @@ license: >
Accelerometer
=============
-> Captures device motion in the x, y, and z direction.
+> <a href="../media/capture/capture.html">Capture</a>s device motion in the x, y, and z direction.
Methods
-------
-- accelerometer.getCurrentAcceleration
-- accelerometer.watchAcceleration
-- accelerometer.clearWatch
+- 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>
Arguments
---------
-- accelerometerSuccess
-- accelerometerError
-- accelerometerOptions
+- <a href="parameters/accelerometerSuccess.html">accelerometerSuccess</a>
+- <a href="parameters/accelerometerError.html">accelerometerError</a>
+- <a href="parameters/accelerometerOptions.html">accelerometerOptions</a>
Objects (Read-Only)
-------------------
-- Acceleration
+- <a href="acceleration/acceleration.html">Acceleration</a>
Permissions
-----------
@@ -68,7 +68,7 @@ Permissions
### iOS
-#### App/Supporting Files/Cordova.plist
+#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.watchAcceleration.md b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.watchAcceleration.md
index dbf6fa3..aa3a13c 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -18,23 +18,23 @@ license: >
under the License.
---
-accelerometer.watchAcceleration
+accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>
===============================
At a regular interval, get the acceleration along the x, y, and z axis.
- var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
- accelerometerError,
- [accelerometerOptions]);
+ 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>]);
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.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 `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 returned watch ID references references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer.
+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.
Supported Platforms
-------------------
@@ -46,13 +46,13 @@ Supported Platforms
- Bada 1.2 & 2.x
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
+ 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' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
@@ -62,29 +62,29 @@ Quick Example
var options = { frequency: 3000 }; // Update every 3 seconds
- var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ var watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Acceleration Example</title>
+ <title><a href="acceleration/acceleration.html">Acceleration</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
- // The watch id references the current `watchAcceleration`
+ // The watch id references the current `watch<a href="acceleration/acceleration.html">Acceleration</a>`
var watchID = null;
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
startWatch();
}
@@ -95,14 +95,14 @@ Full Example
// Update acceleration every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ watchID = navigator.accelerometer.watch<a href="acceleration/acceleration.html">Acceleration</a>(onSuccess, onError, options);
}
// Stop watching the acceleration
//
function stopWatch() {
if (watchID) {
- navigator.accelerometer.clearWatch(watchID);
+ navigator.<a href="accelerometer.clearWatch.html">accelerometer.clearWatch</a>(watchID);
watchID = null;
}
}
@@ -111,9 +111,9 @@ Full Example
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
- element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
- 'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
+ 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 />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerOptions.md b/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerOptions.md
index 86fb292..d105d2d 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerOptions.md
+++ b/www/docs/en/1.8.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 `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
+- __frequency:__ How often to retrieve the `<a href="../acceleration/acceleration.html">Acceleration</a>` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerSuccess.md b/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerSuccess.md
index 67166dc..5f448d2 100644
--- a/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerSuccess.md
+++ b/www/docs/en/1.8.1/cordova/accelerometer/parameters/accelerometerSuccess.md
@@ -21,7 +21,7 @@ license: >
accelerometerSuccess
====================
-onSuccess callback function that provides the Acceleration information.
+onSuccess callback function that provides the <a href="../acceleration/acceleration.html">Acceleration</a> information.
function(acceleration) {
// Do something
@@ -30,14 +30,14 @@ onSuccess callback function that provides the Acceleration information.
Parameters
----------
-- __acceleration:__ The acceleration at a single moment in time. (Acceleration)
+- __acceleration:__ The acceleration at a single moment in time. (<a href="../acceleration/acceleration.html">Acceleration</a>)
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
+ 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' +
'Timestamp: ' + acceleration.timestamp + '\n');
};
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/camera/camera.getPicture.md b/www/docs/en/1.8.1/cordova/camera/camera.getPicture.md
index 9e07e8d..22f30c3 100644
--- a/www/docs/en/1.8.1/cordova/camera/camera.getPicture.md
+++ b/www/docs/en/1.8.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( cameraSuccess, cameraError, [ cameraOptions ] );
+ navigator.camera.getPicture( <a href="parameter/cameraSuccess.html">cameraSuccess</a>, <a href="parameter/cameraError.html">cameraError</a>, [ <a href="parameter/cameraOptions.html">cameraOptions</a> ] );
Description
-----------
-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.
+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.
-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.
+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.
-The return value will be sent to the `cameraSuccess` function, in one of the following formats, depending on the `cameraOptions` you specify:
+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:
- 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 `cameraSuccess` function, in one of the fol
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 (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
+- Save the data locally (`Local<a href="../storage/storage.html">Storage</a>`, [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, and images from the Photo Album will not be downscaled to a lower quality, even if a quality parameter is specified. _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.
+Note: The image quality of pictures taken using the camera on newer devices is quite good, and images from the Photo Album will not be downscaled to a lower quality, even if a quality parameter is specified. _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.
Supported Platforms
-------------------
@@ -66,13 +66,13 @@ Windows Phone 7 Quirks
Invoking the native camera application while your device is connected
via Zune will not work, and the error callback will be triggered.
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
Take photo and retrieve Base64-encoded image:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: Camera.DestinationType.DATA_URL
+ destinationType: <a href="camera.html">Camera</a>.DestinationType.DATA_URL
});
function onSuccess(imageData) {
@@ -87,7 +87,7 @@ Take photo and retrieve Base64-encoded image:
Take photo and retrieve image file location:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: Camera.DestinationType.FILE_URI });
+ destinationType: <a href="camera.html">Camera</a>.DestinationType.FILE_URI });
function onSuccess(imageURI) {
var image = document.getElementById('myImage');
@@ -99,13 +99,13 @@ Take photo and retrieve image file location:
}
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Capture Photo</title>
+ <title><a href="../media/capture/capture.html">Capture</a> Photo</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -115,11 +115,11 @@ Full Example
// Wait for Cordova to connect with the device
//
- document.addEventListener("deviceready",onDeviceReady,false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>",on<a href="../device/device.html">Device</a>Ready,false);
// Cordova is ready to be used!
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
pictureSource=navigator.camera.PictureSourceType;
destinationType=navigator.camera.DestinationType;
}
@@ -198,8 +198,8 @@ Full Example
</script>
</head>
<body>
- <button onclick="capturePhoto();">Capture Photo</button> <br>
- <button onclick="capturePhotoEdit();">Capture Editable Photo</button> <br>
+ <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="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/89392fa8/www/docs/en/1.8.1/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/camera/camera.md b/www/docs/en/1.8.1/cordova/camera/camera.md
index db122ab..fdafec0 100644
--- a/www/docs/en/1.8.1/cordova/camera/camera.md
+++ b/www/docs/en/1.8.1/cordova/camera/camera.md
@@ -26,7 +26,7 @@ Camera
Methods
-------
-- camera.getPicture
+- <a href="camera.getPicture.html">camera.getPicture</a>
Permissions
-----------
@@ -68,7 +68,7 @@ Permissions
### iOS
-#### App/Supporting Files/Cordova.plist
+#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/camera/parameter/CameraPopoverOptions.md b/www/docs/en/1.8.1/cordova/camera/parameter/CameraPopoverOptions.md
index 06bfea9..2efd55b 100644
--- a/www/docs/en/1.8.1/cordova/camera/parameter/CameraPopoverOptions.md
+++ b/www/docs/en/1.8.1/cordova/camera/parameter/CameraPopoverOptions.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-CameraPopoverOptions
+<a href="../camera.html">Camera</a>PopoverOptions
====================
Parameters only used by iOS to specify the anchor element location and arrow direction of popover used on iPad when selecting images from the library or album.
@@ -27,10 +27,10 @@ Parameters only used by iOS to specify the anchor element location and arrow dir
y : 32,
width : 320,
height : 480,
- arrowDir : Camera.PopoverArrowDirection.ARROW_ANY
+ arrowDir : <a href="../camera.html">Camera</a>.PopoverArrowDirection.ARROW_ANY
};
-CameraPopoverOptions
+<a href="../camera.html">Camera</a>PopoverOptions
--------------------
- __x:__ x pixel coordinate of element on the screen to anchor popover onto. (`Number`)
@@ -41,9 +41,9 @@ CameraPopoverOptions
- __height:__ height, in pixels, of the element on the screen to anchor popover onto. (`Number`)
-- __arrowDir:__ Direction the arrow on the popover should point. Defined in Camera.PopoverArrowDirection (`Number`)
+- __arrowDir:__ Direction the arrow on the popover should point. Defined in <a href="../camera.html">Camera</a>.PopoverArrowDirection (`Number`)
- Camera.PopoverArrowDirection = {
+ <a href="../camera.html">Camera</a>.PopoverArrowDirection = {
ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants
ARROW_DOWN : 2,
ARROW_LEFT : 4,
@@ -53,13 +53,13 @@ CameraPopoverOptions
Note that the size of the popover may change to adjust to the direction of the arrow and orientation of the screen. Make sure to account for orientation changes when specifying the anchor element location.
-Quick Example
+Quick <a href="../../storage/storage.opendatabase.html">Example</a>
-------------
- var popover = new CameraPopoverOptions(300,300,100,100,Camera.PopoverArrowDirection.ARROW_ANY);
- var options = { quality: 50, destinationType: Camera.DestinationType.DATA_URL,sourceType: Camera.PictureSource.SAVEDPHOTOALBUM, popoverOptions : popover };
+ var popover = new <a href="../camera.html">Camera</a>PopoverOptions(300,300,100,100,<a href="../camera.html">Camera</a>.PopoverArrowDirection.ARROW_ANY);
+ var options = { quality: 50, destinationType: <a href="../camera.html">Camera</a>.DestinationType.DATA_URL,sourceType: <a href="../camera.html">Camera</a>.PictureSource.SAVEDPHOTOALBUM, popoverOptions : popover };
- navigator.camera.getPicture(onSuccess, onFail, options);
+ navigator.<a href="../camera.getPicture.html">camera.getPicture</a>(onSuccess, onFail, options);
function onSuccess(imageData) {
var image = document.getElementById('myImage');
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/camera/parameter/cameraOptions.md b/www/docs/en/1.8.1/cordova/camera/parameter/cameraOptions.md
index e216e7d..0ddcfda 100644
--- a/www/docs/en/1.8.1/cordova/camera/parameter/cameraOptions.md
+++ b/www/docs/en/1.8.1/cordova/camera/parameter/cameraOptions.md
@@ -24,13 +24,13 @@ cameraOptions
Optional parameters to customize the camera settings.
{ quality : 75,
- destinationType : Camera.DestinationType.DATA_URL,
- sourceType : Camera.PictureSourceType.CAMERA,
+ destinationType : <a href="../camera.html">Camera</a>.DestinationType.DATA_URL,
+ sourceType : <a href="../camera.html">Camera</a>.PictureSourceType.CAMERA,
allowEdit : true,
- encodingType: Camera.EncodingType.JPEG,
+ encodingType: <a href="../camera.html">Camera</a>.EncodingType.JPEG,
targetWidth: 100,
targetHeight: 100,
- popoverOptions: CameraPopoverOptions };
+ popoverOptions: <a href="../camera.html">Camera</a>PopoverOptions };
Options
-------
@@ -39,14 +39,14 @@ Options
- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`)
- Camera.DestinationType = {
+ <a href="../camera.html">Camera</a>.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`)
- Camera.PictureSourceType = {
+ <a href="../camera.html">Camera</a>.PictureSourceType = {
PHOTOLIBRARY : 0,
CAMERA : 1,
SAVEDPHOTOALBUM : 2
@@ -56,7 +56,7 @@ Options
- __encodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`)
- Camera.EncodingType = {
+ <a href="../camera.html">Camera</a>.EncodingType = {
JPEG : 0, // Return JPEG encoded image
PNG : 1 // Return PNG encoded image
};
@@ -64,9 +64,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.MediaType (`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`)
- Camera.MediaType = {
+ <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type = {
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
@@ -74,14 +74,14 @@ Options
- __correctOrientation:__ Rotate the image to correct for the orientation of the device during capture. (`Boolean`)
- __saveToPhotoAlbum:__ Save the image to the photo album on the device after capture. (`Boolean`)
-- __popoverOptions:__ iOS only options to specify popover location in iPad. Defined in CameraPopoverOptions
+- __popoverOptions:__ iOS only options to specify popover location in iPad. Defined in <a href="../camera.html">Camera</a>PopoverOptions
Android Quirks
--------------
- Ignores the `allowEdit` parameter.
-- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
-- Camera.EncodingType is not supported.
+- <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.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
@@ -91,9 +91,9 @@ BlackBerry Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Application must have key injection permissions to close native Camera application after photo is taken.
+- Application must have key injection permissions to close native <a href="../camera.html">Camera</a> 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).
-- Camera.MediaType is not supported.
+- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
@@ -103,7 +103,7 @@ webOS Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Camera.MediaType is not supported.
+- <a href="../camera.html">Camera</a>.<a href="../../media/media.html">Media</a>Type is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/camera/parameter/cameraSuccess.md b/www/docs/en/1.8.1/cordova/camera/parameter/cameraSuccess.md
index ec04795..6083130 100644
--- a/www/docs/en/1.8.1/cordova/camera/parameter/cameraSuccess.md
+++ b/www/docs/en/1.8.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 `cameraOptions` used. (`String`)
+- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `<a href="cameraOptions.html">cameraOptions</a>` used. (`String`)
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
// Show image
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.clearWatch.md b/www/docs/en/1.8.1/cordova/compass/compass.clearWatch.md
index 8cee616..bdc64fe 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.clearWatch.md
+++ b/www/docs/en/1.8.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 `compass.watchHeading`.
+- __watchID__: The ID returned by `<a href="compass.watchHeading.html">compass.watchHeading</a>`.
Supported Platforms
-------------------
@@ -36,22 +36,22 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
- var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+ var watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
// ... later on ...
navigator.compass.clearWatch(watchID);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Compass Example</title>
+ <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -61,11 +61,11 @@ Full Example
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
startWatch();
}
@@ -76,7 +76,7 @@ Full Example
// Update compass every 3 seconds
var options = { frequency: 3000 };
- watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+ watchID = navigator.<a href="compass.watchHeading.html">compass.watchHeading</a>(onSuccess, onError, options);
}
// Stop watching the compass
@@ -97,8 +97,8 @@ Full Example
// onError: Failed to get the heading
//
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
+ 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);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.clearWatchFilter.md b/www/docs/en/1.8.1/cordova/compass/compass.clearWatchFilter.md
index 276c11f..9cf3e19 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.clearWatchFilter.md
+++ b/www/docs/en/1.8.1/cordova/compass/compass.clearWatchFilter.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-compass.clearWatchFilter
+<a href="compass.clearWatch.html">compass.clearWatch</a>Filter
========================
-No longer supported as of 1.6. See `compass.clearWatch`.
\ No newline at end of file
+No longer supported as of 1.6. See `<a href="compass.clearWatch.html">compass.clearWatch</a>`.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.getCurrentHeading.md b/www/docs/en/1.8.1/cordova/compass/compass.getCurrentHeading.md
index 26e4f99..51c97ee 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.getCurrentHeading.md
+++ b/www/docs/en/1.8.1/cordova/compass/compass.getCurrentHeading.md
@@ -23,14 +23,14 @@ compass.getCurrentHeading
Get the current compass heading.
- navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
+ navigator.compass.getCurrentHeading(<a href="parameters/compassSuccess.html">compassSuccess</a>, <a href="parameters/compassError.html">compassError</a>, <a href="parameters/compassOptions.html">compassOptions</a>);
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 CompassHeading object using the `compassSuccess` callback function.
+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.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(heading) {
@@ -49,29 +49,29 @@ Quick Example
};
function onError(error) {
- alert('CompassError: ' + error.code);
+ 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);
};
navigator.compass.getCurrentHeading(onSuccess, onError);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Compass Example</title>
+ <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
navigator.compass.getCurrentHeading(onSuccess, onError);
}
@@ -83,14 +83,14 @@ Full Example
// onError: Failed to get the heading
//
- function onError(compassError) {
- alert('Compass Error: ' + compassError.code);
+ 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);
}
</script>
</head>
<body>
- <h1>Example</h1>
+ <h1><a href="../storage/storage.opendatabase.html">Example</a></h1>
<p>getCurrentHeading</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.md b/www/docs/en/1.8.1/cordova/compass/compass.md
index c560ffd..3e0651e 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.md
+++ b/www/docs/en/1.8.1/cordova/compass/compass.md
@@ -26,19 +26,19 @@ Compass
Methods
-------
-- compass.getCurrentHeading
-- compass.watchHeading
-- compass.clearWatch
-- compass.watchHeadingFilter (obsolete)
-- compass.clearWatchFilter (obsolete)
+- <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)
Arguments
---------
-- compassSuccess
-- compassError
-- compassOptions
-- compassHeading
+- <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>
Permissions
-----------
@@ -59,7 +59,7 @@ Permissions
### iOS
-#### App/Supporting Files/Cordova.plist
+#### App/Supporting <a href="../file/fileobj/fileobj.html">File</a>s/Cordova.plist
<key>Plugins</key>
<dict>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.watchHeading.md b/www/docs/en/1.8.1/cordova/compass/compass.watchHeading.md
index 90b85c6..3014ab8 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.watchHeading.md
+++ b/www/docs/en/1.8.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(compassSuccess, compassError, [compassOptions]);
+ 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>]);
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 `compassOptions` 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 `<a href="parameters/compassOptions.html">compassOptions</a>` object.
-The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass.
+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.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- webOS
-Quick Example
+Quick <a href="../storage/storage.opendatabase.html">Example</a>
-------------
function onSuccess(heading) {
@@ -52,21 +52,21 @@ Quick Example
element.innerHTML = 'Heading: ' + heading.magneticHeading;
};
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
+ 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);
};
var options = { frequency: 3000 }; // Update every 3 seconds
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-Full Example
+Full <a href="../storage/storage.opendatabase.html">Example</a>
------------
<!DOCTYPE html>
<html>
<head>
- <title>Compass Example</title>
+ <title><a href="compass.html">Compass</a> <a href="../storage/storage.opendatabase.html">Example</a></title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -76,11 +76,11 @@ Full Example
// Wait for Cordova to load
//
- document.addEventListener("deviceready", onDeviceReady, false);
+ document.addEventListener("<a href="../events/events.deviceready.html">deviceready</a>", on<a href="../device/device.html">Device</a>Ready, false);
// Cordova is ready
//
- function onDeviceReady() {
+ function on<a href="../device/device.html">Device</a>Ready() {
startWatch();
}
@@ -98,7 +98,7 @@ Full Example
//
function stopWatch() {
if (watchID) {
- navigator.compass.clearWatch(watchID);
+ navigator.<a href="compass.clearWatch.html">compass.clearWatch</a>(watchID);
watchID = null;
}
}
@@ -112,8 +112,8 @@ Full Example
// onError: Failed to get the heading
//
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
+ 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);
}
</script>
@@ -128,6 +128,6 @@ Full Example
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 `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 `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 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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compass.watchHeadingFilter.md b/www/docs/en/1.8.1/cordova/compass/compass.watchHeadingFilter.md
index 991da30..f05a774 100644
--- a/www/docs/en/1.8.1/cordova/compass/compass.watchHeadingFilter.md
+++ b/www/docs/en/1.8.1/cordova/compass/compass.watchHeadingFilter.md
@@ -18,7 +18,7 @@ license: >
under the License.
---
-compass.watchHeadingFilter
+<a href="compass.watchHeading.html">compass.watchHeading</a>Filter
==========================
-No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality.
+No longer supported as of 1.6, see `<a href="compass.watchHeading.html">compass.watchHeading</a>` for equivalent functionality.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/compassError/compassError.md b/www/docs/en/1.8.1/cordova/compass/compassError/compassError.md
index 20d01c5..e356b45 100644
--- a/www/docs/en/1.8.1/cordova/compass/compassError/compassError.md
+++ b/www/docs/en/1.8.1/cordova/compass/compassError/compassError.md
@@ -18,10 +18,10 @@ license: >
under the License.
---
-CompassError
+<a href="../compass.html">Compass</a>Error
==========
-A `CompassError` object is returned to the `compassError` callback function when an error occurs.
+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.
Properties
----------
@@ -30,12 +30,12 @@ Properties
Constants
---------
-- `CompassError.COMPASS_INTERNAL_ERR`
-- `CompassError.COMPASS_NOT_SUPPORTED`
+- `<a href="../compass.html">Compass</a>Error.COMPASS_INTERNAL_ERR`
+- `<a href="../compass.html">Compass</a>Error.COMPASS_NOT_SUPPORTED`
Description
-----------
-The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
+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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/parameters/compassError.md b/www/docs/en/1.8.1/cordova/compass/parameters/compassError.md
index 3d2f523..44700bc 100644
--- a/www/docs/en/1.8.1/cordova/compass/parameters/compassError.md
+++ b/www/docs/en/1.8.1/cordova/compass/parameters/compassError.md
@@ -23,9 +23,9 @@ compassError
onError callback function for compass functions.
-Example
+<a href="../../storage/storage.opendatabase.html">Example</a>
-------
-function(CompassError) {
+function(<a href="../compassError/compassError.html"><a href="../compass.html">Compass</a>Error</a>) {
// Handle the error
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.1/cordova/compass/parameters/compassHeading.md b/www/docs/en/1.8.1/cordova/compass/parameters/compassHeading.md
index adae2f6..8293202 100644
--- a/www/docs/en/1.8.1/cordova/compass/parameters/compassHeading.md
+++ b/www/docs/en/1.8.1/cordova/compass/parameters/compassHeading.md
@@ -21,7 +21,7 @@ license: >
compassHeading
==========
-A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs.
+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.
Properties
----------
@@ -33,7 +33,7 @@ Properties
Description
-----------
-The `CompassHeading` object is returned to the user through the `compassSuccess` callback function.
+The `<a href="../compass.html">Compass</a>Heading` object is returned to the user through the `<a href="compassSuccess.html">compassSuccess</a>` callback function.
Android Quirks
--------------
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org