You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/12/18 16:40:09 UTC
svn commit: r1551982 [1/18] - in /cordova/site/public/docs/en: 3.0.0/ 3.3.0/
edge/
Author: agrieve
Date: Wed Dec 18 15:40:06 2013
New Revision: 1551982
URL: http://svn.apache.org/r1551982
Log:
Update docs to include note about Android's Project-CordovaLib (CB-5232)
Modified:
cordova/site/public/docs/en/3.0.0/guide_platforms_android_index.md.html
cordova/site/public/docs/en/3.3.0/_index.html
cordova/site/public/docs/en/3.3.0/config_ref_images.md.html
cordova/site/public/docs/en/3.3.0/config_ref_index.md.html
cordova/site/public/docs/en/3.3.0/cordova_accelerometer_accelerometer.md.html
cordova/site/public/docs/en/3.3.0/cordova_camera_camera.cleanup.md.html
cordova/site/public/docs/en/3.3.0/cordova_camera_camera.md.html
cordova/site/public/docs/en/3.3.0/cordova_compass_compass.md.html
cordova/site/public/docs/en/3.3.0/cordova_connection_connection.md.html
cordova/site/public/docs/en/3.3.0/cordova_contacts_contacts.md.html
cordova/site/public/docs/en/3.3.0/cordova_device_device.md.html
cordova/site/public/docs/en/3.3.0/cordova_events_events.md.html
cordova/site/public/docs/en/3.3.0/cordova_file_file.md.html
cordova/site/public/docs/en/3.3.0/cordova_geolocation_geolocation.md.html
cordova/site/public/docs/en/3.3.0/cordova_globalization_globalization.md.html
cordova/site/public/docs/en/3.3.0/cordova_inappbrowser_inappbrowser.md.html
cordova/site/public/docs/en/3.3.0/cordova_media_capture_capture.md.html
cordova/site/public/docs/en/3.3.0/cordova_media_media.md.html
cordova/site/public/docs/en/3.3.0/cordova_notification_notification.md.html
cordova/site/public/docs/en/3.3.0/cordova_splashscreen_splashscreen.md.html
cordova/site/public/docs/en/3.3.0/cordova_storage_storage.md.html
cordova/site/public/docs/en/3.3.0/guide_appdev_privacy_index.md.html
cordova/site/public/docs/en/3.3.0/guide_appdev_whitelist_index.md.html
cordova/site/public/docs/en/3.3.0/guide_cli_index.md.html
cordova/site/public/docs/en/3.3.0/guide_hybrid_plugins_index.md.html
cordova/site/public/docs/en/3.3.0/guide_hybrid_webviews_index.md.html
cordova/site/public/docs/en/3.3.0/guide_overview_index.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_amazonfireos_config.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_amazonfireos_index.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_amazonfireos_plugin.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_amazonfireos_webview.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_android_config.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_android_index.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_android_plugin.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_android_tools.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_android_upgrading.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_android_webview.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_blackberry10_config.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_blackberry10_index.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_blackberry10_plugin.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_blackberry10_tools.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_blackberry10_upgrading.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_index.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_ios_config.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_ios_index.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_ios_plugin.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_ios_tools.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_ios_upgrading.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_ios_webview.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_tizen_index.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_ubuntu_index.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_win8_index.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_win8_tools.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_win8_upgrading.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_wp7_index.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_wp8_index.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_wp8_plugin.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_wp8_tools.md.html
cordova/site/public/docs/en/3.3.0/guide_platforms_wp8_upgrading.md.html
cordova/site/public/docs/en/3.3.0/guide_support_index.md.html
cordova/site/public/docs/en/3.3.0/index.html
cordova/site/public/docs/en/3.3.0/plugin_ref_plugman.md.html
cordova/site/public/docs/en/3.3.0/plugin_ref_spec.md.html
cordova/site/public/docs/en/edge/_index.html
cordova/site/public/docs/en/edge/config_ref_images.md.html
cordova/site/public/docs/en/edge/config_ref_index.md.html
cordova/site/public/docs/en/edge/cordova_accelerometer_accelerometer.md.html
cordova/site/public/docs/en/edge/cordova_camera_camera.cleanup.md.html
cordova/site/public/docs/en/edge/cordova_camera_camera.md.html
cordova/site/public/docs/en/edge/cordova_compass_compass.md.html
cordova/site/public/docs/en/edge/cordova_connection_connection.md.html
cordova/site/public/docs/en/edge/cordova_contacts_contacts.md.html
cordova/site/public/docs/en/edge/cordova_device_device.md.html
cordova/site/public/docs/en/edge/cordova_events_events.md.html
cordova/site/public/docs/en/edge/cordova_file_file.md.html
cordova/site/public/docs/en/edge/cordova_geolocation_geolocation.md.html
cordova/site/public/docs/en/edge/cordova_globalization_globalization.md.html
cordova/site/public/docs/en/edge/cordova_inappbrowser_inappbrowser.md.html
cordova/site/public/docs/en/edge/cordova_media_capture_capture.md.html
cordova/site/public/docs/en/edge/cordova_media_media.md.html
cordova/site/public/docs/en/edge/cordova_notification_notification.md.html
cordova/site/public/docs/en/edge/cordova_splashscreen_splashscreen.md.html
cordova/site/public/docs/en/edge/cordova_storage_storage.md.html
cordova/site/public/docs/en/edge/guide_appdev_privacy_index.md.html
cordova/site/public/docs/en/edge/guide_appdev_whitelist_index.md.html
cordova/site/public/docs/en/edge/guide_cli_index.md.html
cordova/site/public/docs/en/edge/guide_hybrid_plugins_index.md.html
cordova/site/public/docs/en/edge/guide_hybrid_webviews_index.md.html
cordova/site/public/docs/en/edge/guide_overview_index.md.html
cordova/site/public/docs/en/edge/guide_platforms_amazonfireos_config.md.html
cordova/site/public/docs/en/edge/guide_platforms_amazonfireos_index.md.html
cordova/site/public/docs/en/edge/guide_platforms_amazonfireos_plugin.md.html
cordova/site/public/docs/en/edge/guide_platforms_amazonfireos_webview.md.html
cordova/site/public/docs/en/edge/guide_platforms_android_config.md.html
cordova/site/public/docs/en/edge/guide_platforms_android_index.md.html
cordova/site/public/docs/en/edge/guide_platforms_android_plugin.md.html
cordova/site/public/docs/en/edge/guide_platforms_android_tools.md.html
cordova/site/public/docs/en/edge/guide_platforms_android_upgrading.md.html
cordova/site/public/docs/en/edge/guide_platforms_android_webview.md.html
cordova/site/public/docs/en/edge/guide_platforms_blackberry10_config.md.html
cordova/site/public/docs/en/edge/guide_platforms_blackberry10_index.md.html
cordova/site/public/docs/en/edge/guide_platforms_blackberry10_plugin.md.html
cordova/site/public/docs/en/edge/guide_platforms_blackberry10_tools.md.html
cordova/site/public/docs/en/edge/guide_platforms_blackberry10_upgrading.md.html
cordova/site/public/docs/en/edge/guide_platforms_index.md.html
cordova/site/public/docs/en/edge/guide_platforms_ios_config.md.html
cordova/site/public/docs/en/edge/guide_platforms_ios_index.md.html
cordova/site/public/docs/en/edge/guide_platforms_ios_plugin.md.html
cordova/site/public/docs/en/edge/guide_platforms_ios_tools.md.html
cordova/site/public/docs/en/edge/guide_platforms_ios_upgrading.md.html
cordova/site/public/docs/en/edge/guide_platforms_ios_webview.md.html
cordova/site/public/docs/en/edge/guide_platforms_tizen_index.md.html
cordova/site/public/docs/en/edge/guide_platforms_ubuntu_index.md.html
cordova/site/public/docs/en/edge/guide_platforms_win8_index.md.html
cordova/site/public/docs/en/edge/guide_platforms_win8_tools.md.html
cordova/site/public/docs/en/edge/guide_platforms_win8_upgrading.md.html
cordova/site/public/docs/en/edge/guide_platforms_wp7_index.md.html
cordova/site/public/docs/en/edge/guide_platforms_wp8_index.md.html
cordova/site/public/docs/en/edge/guide_platforms_wp8_plugin.md.html
cordova/site/public/docs/en/edge/guide_platforms_wp8_tools.md.html
cordova/site/public/docs/en/edge/guide_platforms_wp8_upgrading.md.html
cordova/site/public/docs/en/edge/guide_support_index.md.html
cordova/site/public/docs/en/edge/index.html
cordova/site/public/docs/en/edge/plugin_ref_plugman.md.html
cordova/site/public/docs/en/edge/plugin_ref_spec.md.html
Modified: cordova/site/public/docs/en/3.0.0/guide_platforms_android_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.0.0/guide_platforms_android_index.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.0.0/guide_platforms_android_index.md.html (original)
+++ cordova/site/public/docs/en/3.0.0/guide_platforms_android_index.md.html Wed Dec 18 15:40:06 2013
@@ -98,7 +98,6 @@
<h1>Android Platform Guide</h1>
<small><select><option value="Android%2520Platform%2520Guide">Android Platform Guide</option>
<option value="Android%20Platform%20Guide_requirements_and_support">Â Â Â Â Â Â - Requirements and Support</option>
-<option value="Android%20Platform%20Guide_install_the_sdk">Â Â Â Â Â Â - Install the SDK</option>
<option value="Android%20Platform%20Guide_open_a_project_in_the_sdk">Â Â Â Â Â Â - Open a Project in the SDK</option>
<option value="Android%20Platform%20Guide_deploy_to_emulator">Â Â Â Â Â Â - Deploy to Emulator</option>
<option value="Android%20Platform%20Guide_deploy_to_device">Â Â Â Â Â Â - Deploy to Device
@@ -145,8 +144,14 @@
<h1><a name="Android%20Platform%20Guide">Android Platform Guide</a></h1>
<p>This guide shows how to set up your SDK development environment to
-deploy Cordova apps for Android devices. See the following for more
-detailed platform-specific information:</p>
+deploy Cordova apps for Android devices. It walks you through the process
+of installing the Android SDK, opening an Android project in Eclipse SDK,
+and deploying to an emulator or device. You will need to follow this guide
+to at least Install the Android SDK, regardless of which workflow you
+are following. (Both the <em>Web Project Dev</em> and <em>Native Platform Dev</em> workflows
+require the Android SDK to be installed and accessable via your PATH.)</p>
+
+<p>See the following for more detailed platform-specific information:</p>
<ul>
<li><a href="guide_platforms_android_config.md.html#Android%20Configuration">Android Configuration</a></li>
@@ -156,7 +161,7 @@ detailed platform-specific information:<
<li><a href="guide_platforms_android_tools.md.html#Android%20Command-line%20Tools">Android Command-line Tools</a></li>
</ul>
<p>The command-line tools above refer to versions prior to Cordova 3.0.
-See <a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a> for information about the
+See The Command-Line Interface for information about the
current interface.</p>
<h2>
@@ -177,19 +182,16 @@ NOTE, doc said:
-->
<p>Developers should use the <code>cordova</code> utility in conjunction with
-the Android SDK. See <a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a> for
+the Android SDK. See The Command-Line Interface for
information how to install it, add projects, then build and deploy a
project.</p>
-<h2>
-<a name="Android%20Platform%20Guide_install_the_sdk">Install the SDK</a>
-</h2>
-
<p>Install the Android SDK from
-<a class="external" href="http://developer.android.com/sdk/">developer.android.com/sdk</a>. You
-may be presented with a choice of where to install the SDK, otherwise
-move the downloaded <code>adt-bundle</code> tree to wherever you store
-development tools.</p>
+<a class="external" href="http://developer.android.com/sdk/">developer.android.com/sdk</a>. The android sdk
+is distributed as an 'adt-bundle-<os>-<arch>-<ver>' file.
+On windows, the adt-bundle is packaged with an installer.
+On OSX and Linux, simply unpack the 'adt-bundle' in the location you store development tools.
+<a class="external" href="http://developer.android.com/sdk/installing/bundle.html">More detailed information on Android SDK setup can be found here</a></ver></arch></os></p>
<p>For Cordova command-line tools to work, you need to include the SDK's
<code>tools</code> and <code>platform-tools</code> directories in your PATH environment. On
@@ -235,7 +237,7 @@ run:</p>
</h2>
<p>Use the <code>cordova</code> utility to set up a new project, as described in The
-Cordova <a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a>. For example, in a source-code directory:</p>
+Cordova The Command-Line Interface. For example, in a source-code directory:</p>
<pre class="prettyprint"><code> $ cordova create hello com.example.hello "HelloWorld"
$ cd hello
@@ -251,6 +253,7 @@ Cordova <a href="guide_cli_index.md.html
<li><p>Choose <strong>Android Project from Existing Code</strong> from the resulting dialog box, and press <strong>Next</strong>:
<img src="img/guide/platforms/android/eclipse_new_project.png" alt="" title=""></p></li>
<li><p>Navigate to <code>hello</code>, or whichever directory you created for the project, then to the <code>platforms/android</code> subdirectory.</p></li>
+<li><p>Make sure both <code>hello</code> and <code>hello-CordovaLib</code> projects are selected to be imported. The <code>hello-CordovaLib</code> project is needed as of Cordova 3.3.0 because Cordova is now used as an Android Library instead of a .jar file.</p></li>
<li><p>Press <strong>Finish</strong>.</p></li>
</ul>
<p>Once the Eclipse window opens, a red <strong>X</strong> may appear to indicate
@@ -312,7 +315,7 @@ application to the emulator from the com
<pre class="prettyprint"><code> $ cordova emulate android
</code></pre>
-<p>If instead you are working within Eclipse, right-click the project and
+<p>If instead you work within Eclipse, right-click the project and
choose <strong>Run As â Android Application</strong>. You may be asked to
specify an AVD if none are already open.</p>
Modified: cordova/site/public/docs/en/3.3.0/_index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.3.0/_index.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.3.0/_index.html (original)
+++ cordova/site/public/docs/en/3.3.0/_index.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
- <meta name="generator" content="joDoc">
-
- <title>Apache Cordova API Documentation</title>
-
- <link rel="stylesheet" type="text/css" href="index.css">
- <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
- <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
- </head>
- <body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -94,8 +92,7 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select>
- </small>
+</optgroup></select></small>
</div>
<div id="subheader">
<h1>Keyword Index</h1>
@@ -144,8 +141,6 @@
<div id="content">
-
-
<h1>Keyword Index</h1>
<div id="index">
@@ -172,7 +167,6 @@
<li><a href="guide_platforms_android_webview.md.html#Android%20WebViews">Android WebViews</a></li>
<li><a href="index.html#API%20Reference">API Reference</a></li>
</ul>
-
<h2>B</h2>
<ul>
@@ -185,7 +179,6 @@
<li><a href="guide_platforms_blackberry10_index.md.html#BlackBerry%2010%20Platform%20Guide">BlackBerry 10 Platform Guide</a></li>
<li><a href="guide_platforms_blackberry10_plugin.md.html#BlackBerry%2010%20Plugins">BlackBerry 10 Plugins</a></li>
</ul>
-
<h2>C</h2>
<ul>
@@ -238,7 +231,6 @@
<li><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></li>
<li><a href="cordova_geolocation_geolocation.md.html#Coordinates">Coordinates</a></li>
</ul>
-
<h2>D</h2>
<ul>
@@ -253,7 +245,6 @@
<li><a href="cordova_file_file.md.html#DirectoryEntry">DirectoryEntry</a></li>
<li><a href="cordova_file_file.md.html#DirectoryReader">DirectoryReader</a></li>
</ul>
-
<h2>E</h2>
<ul>
@@ -262,7 +253,6 @@
<li><a href="cordova_events_events.md.html#Events">Events</a></li>
<li><a href="cordova_inappbrowser_inappbrowser.md.html#executeScript">executeScript</a></li>
</ul>
-
<h2>F</h2>
<ul>
@@ -278,7 +268,6 @@
<li><a href="cordova_file_file.md.html#FileWriter">FileWriter</a></li>
<li><a href="cordova_file_file.md.html#Flags">Flags</a></li>
</ul>
-
<h2>G</h2>
<ul>
@@ -305,7 +294,6 @@
<li><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a></li>
<li><a href="index.html#Guides">Guides</a></li>
</ul>
-
<h2>I</h2>
<ul>
@@ -319,13 +307,11 @@
<li><a href="guide_platforms_ios_plugin.md.html#iOS%20Plugins">iOS Plugins</a></li>
<li><a href="guide_platforms_ios_webview.md.html#iOS%20WebViews">iOS WebViews</a></li>
</ul>
-
<h2>L</h2>
<ul>
<li><a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a></li>
</ul>
-
<h2>M</h2>
<ul>
@@ -348,7 +334,6 @@
<li><a href="cordova_events_events.md.html#menubutton">menubutton</a></li>
<li><a href="cordova_file_file.md.html#Metadata">Metadata</a></li>
</ul>
-
<h2>N</h2>
<ul>
@@ -359,7 +344,6 @@
<li><a href="cordova_notification_notification.md.html#notification.prompt">notification.prompt</a></li>
<li><a href="cordova_notification_notification.md.html#notification.vibrate">notification.vibrate</a></li>
</ul>
-
<h2>O</h2>
<ul>
@@ -367,7 +351,6 @@
<li><a href="cordova_events_events.md.html#online">online</a></li>
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
</ul>
-
<h2>P</h2>
<ul>
@@ -380,7 +363,6 @@
<li><a href="cordova_geolocation_geolocation.md.html#PositionError">PositionError</a></li>
<li><a href="guide_appdev_privacy_index.md.html#Privacy%20Guide">Privacy Guide</a></li>
</ul>
-
<h2>R</h2>
<ul>
@@ -388,7 +370,6 @@
<li><a href="cordova_file_file.md.html#requestFileSystem">requestFileSystem</a></li>
<li><a href="cordova_events_events.md.html#resume">resume</a></li>
</ul>
-
<h2>S</h2>
<ul>
@@ -400,7 +381,6 @@
<li><a href="cordova_events_events.md.html#startcallbutton">startcallbutton</a></li>
<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
</ul>
-
<h2>T</h2>
<ul>
@@ -408,7 +388,6 @@
<li><a href="config_ref_index.md.html#The%20config.xml%20File">The config.xml File</a></li>
<li><a href="guide_platforms_tizen_index.md.html#Tizen%20Platform%20Guide">Tizen Platform Guide</a></li>
</ul>
-
<h2>U</h2>
<ul>
@@ -420,14 +399,12 @@
<li><a href="guide_platforms_wp8_upgrading.md.html#Upgrading%20Windows%20Phone">Upgrading Windows Phone</a></li>
<li><a href="plugin_ref_plugman.md.html#Using%20Plugman%20to%20Manage%20Plugins">Using Plugman to Manage Plugins</a></li>
</ul>
-
<h2>V</h2>
<ul>
<li><a href="cordova_events_events.md.html#volumedownbutton">volumedownbutton</a></li>
<li><a href="cordova_events_events.md.html#volumeupbutton">volumeupbutton</a></li>
</ul>
-
<h2>W</h2>
<ul>
@@ -447,7 +424,6 @@
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script>
- <script type="text/javascript" src="prettify/prettify.js"></script>
- </body>
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
</html>
Modified: cordova/site/public/docs/en/3.3.0/config_ref_images.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.3.0/config_ref_images.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.3.0/config_ref_images.md.html (original)
+++ cordova/site/public/docs/en/3.3.0/config_ref_images.md.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
- <meta name="generator" content="joDoc">
-
- <title>Apache Cordova API Documentation</title>
-
- <link rel="stylesheet" type="text/css" href="index.css">
- <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
- <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
- </head>
- <body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -94,8 +92,7 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select>
- </small>
+</optgroup></select></small>
</div>
<div id="subheader">
<h1>Icons and Splash Screens</h1>
@@ -154,7 +151,9 @@ screen for various platforms, both when
(described in <a href="guide_cli_index.md.html#The%20Command-Line%20Interface">The Command-Line Interface</a>) or using platform-specific
SDK tools (detailed in the <a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a>).</p>
-<h2><a name="Icons%20and%20Splash%20Screens_configuring_icons_in_the_cli">Configuring Icons in the CLI</a></h2>
+<h2>
+<a name="Icons%20and%20Splash%20Screens_configuring_icons_in_the_cli">Configuring Icons in the CLI</a>
+</h2>
<p>When working in the CLI, icon source files are located within various
platform-specific subdirectories within the project's <code>www/res/icons</code>
@@ -201,7 +200,9 @@ devices' background tiling images used w
<pre class="prettyprint"><code> tizen/icon-128.png
</code></pre>
-<h2><a name="Icons%20and%20Splash%20Screens_configuring_splash_screens_in_the_cli">Configuring Splash Screens in the CLI</a></h2>
+<h2>
+<a name="Icons%20and%20Splash%20Screens_configuring_splash_screens_in_the_cli">Configuring Splash Screens in the CLI</a>
+</h2>
<p>Use the <a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a> API to enable display of an app's introductory
splash screen on many platforms. When working in the CLI, splash
@@ -248,7 +249,9 @@ Guides</a>.</p>
<p>Don't forget to install the SplashScreen plugin before trying to use the
<code>navigator.<a href="cordova_splashscreen_splashscreen.md.html#splashscreen.hide">splashscreen.hide</a>()</code> or <code>navigator.<a href="cordova_splashscreen_splashscreen.md.html#splashscreen.show">splashscreen.show</a>()</code> methods.</p>
-<h2><a name="Icons%20and%20Splash%20Screens_splash_screens_for_the_android_platform">Splash Screens for the Android Platform</a></h2>
+<h2>
+<a name="Icons%20and%20Splash%20Screens_splash_screens_for_the_android_platform">Splash Screens for the Android Platform</a>
+</h2>
<p>Place <a class="external" href="https://developer.android.com/tools/help/draw9patch.html">9-patch image</a>
files in the Android project's <code>platforms/android/res/drawable*</code> directories.</p>
@@ -261,7 +264,6 @@ files in the Android project's <code>pla
<li>medium (mdpi): at least 470 Ã 320</li>
<li>small (ldpi): at least 426 Ã 320</li>
</ul>
-
<p>If you want to use
the default splash screen images provided in Cordova, you'll need to copy the
png files from <code>platforms/android/www/res/screen/android</code> to
@@ -318,7 +320,9 @@ will be visible for the SplashScreenDela
This event-driven approach is highly recommended versus having the splash
screen visible for always a fixed duration.</p>
-<h2><a name="Icons%20and%20Splash%20Screens_splash_screens_for_the_ios_platform">Splash Screens for the iOS Platform</a></h2>
+<h2>
+<a name="Icons%20and%20Splash%20Screens_splash_screens_for_the_ios_platform">Splash Screens for the iOS Platform</a>
+</h2>
<p>Copy splash screen images into the iOS project's <code>Resources/splash</code>
directory. Only add those images for the devices you want to support,
@@ -333,8 +337,9 @@ such as iPad or iPhone. The size of each
<li>Default@2x~iphone.png (640x960 pixels)</li>
<li>Default~iphone.png (320x480 pixels)</li>
</ul>
-
-<h2><a name="Icons%20and%20Splash%20Screens_splash_screens_for_the_blackberry_10_platform">Splash Screens for the BlackBerry 10 Platform</a></h2>
+<h2>
+<a name="Icons%20and%20Splash%20Screens_splash_screens_for_the_blackberry_10_platform">Splash Screens for the BlackBerry 10 Platform</a>
+</h2>
<p>Add a rim:splash element to config.xml for each resolution and locale you wish
to support:</p>
@@ -345,7 +350,6 @@ to support:</p>
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script>
- <script type="text/javascript" src="prettify/prettify.js"></script>
- </body>
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
</html>
Modified: cordova/site/public/docs/en/3.3.0/config_ref_index.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.3.0/config_ref_index.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.3.0/config_ref_index.md.html (original)
+++ cordova/site/public/docs/en/3.3.0/config_ref_index.md.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
- <meta name="generator" content="joDoc">
-
- <title>Apache Cordova API Documentation</title>
-
- <link rel="stylesheet" type="text/css" href="index.css">
- <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
- <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
- </head>
- <body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -94,8 +92,7 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select>
- </small>
+</optgroup></select></small>
</div>
<div id="subheader">
<h1>The config.xml File</h1>
@@ -193,12 +190,13 @@ See the following sections for platform-
<li><a href="guide_platforms_android_config.md.html#Android%20Configuration">Android Configuration</a></li>
<li><a href="guide_platforms_blackberry10_config.md.html#BlackBerry%2010%20Configuration">BlackBerry 10 Configuration</a></li>
</ul>
-
<p>In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See <a href="config_ref_images.md.html#Icons%20and%20Splash%20Screens">Icons and Splash Screens</a> for more information.</p>
-<h2><a name="The%20config.xml%20File_core_configuration_elements">Core Configuration Elements</a></h2>
+<h2>
+<a name="The%20config.xml%20File_core_configuration_elements">Core Configuration Elements</a>
+</h2>
<p>This example shows the default <code>config.xml</code> generated by the CLI's
<code>create</code> command, described in <a href="guide_cli_index.md.html#The%20Command-Line%20Interface">The Command-Line Interface</a>:</p>
@@ -245,8 +243,9 @@ case-insensitive. Many preferences are
platforms, as listed at the top of this page. The following sections
detail preferences that apply to more than one platform.</p></li>
</ul>
-
-<h2><a name="The%20config.xml%20File_global_preferences">Global Preferences</a></h2>
+<h2>
+<a name="The%20config.xml%20File_global_preferences">Global Preferences</a>
+</h2>
<p>The following global preferences apply to all platforms:</p>
@@ -272,8 +271,9 @@ default settings (usually portrait-only)
<code>config.xml</code> file.</p>
</li>
</ul>
-
-<h2><a name="The%20config.xml%20File_multi_platform_preferences">Multi-Platform Preferences</a></h2>
+<h2>
+<a name="The%20config.xml%20File_multi_platform_preferences">Multi-Platform Preferences</a>
+</h2>
<p>The following preferences apply to more than one platform, but not to
all of them:</p>
@@ -315,8 +315,9 @@ keyboard, helping users navigate from on
<p>Applies to iOS and BlackBerry. </p>
</li>
</ul>
-
-<h2><a name="The%20config.xml%20File_the_feature_element">The feature Element</a></h2>
+<h2>
+<a name="The%20config.xml%20File_the_feature_element">The feature Element</a>
+</h2>
<p>If you use the CLI to build applications, you use the <code>plugin</code> command
to enable device APIs. This does not modify the top-level <code>config.xml</code>
@@ -352,7 +353,6 @@ the <a href="guide_hybrid_plugins_index.
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script>
- <script type="text/javascript" src="prettify/prettify.js"></script>
- </body>
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
</html>
Modified: cordova/site/public/docs/en/3.3.0/cordova_accelerometer_accelerometer.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.3.0/cordova_accelerometer_accelerometer.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.3.0/cordova_accelerometer_accelerometer.md.html (original)
+++ cordova/site/public/docs/en/3.3.0/cordova_accelerometer_accelerometer.md.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
- <meta name="generator" content="joDoc">
-
- <title>Apache Cordova API Documentation</title>
-
- <link rel="stylesheet" type="text/css" href="index.css">
- <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
- <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
- </head>
- <body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -94,8 +92,7 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select>
- </small>
+</optgroup></select></small>
</div>
<div id="subheader">
<h1>Accelerometer</h1>
@@ -180,29 +177,34 @@
<p>Captures device motion in the <em>x</em>, <em>y</em>, and <em>z</em> direction.</p>
</blockquote>
-<h2><a name="Accelerometer_methods">Methods</a></h2>
+<h2>
+<a name="Accelerometer_methods">Methods</a>
+</h2>
<ul>
<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a></li>
<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></li>
<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a></li>
</ul>
-
-<h2><a name="Accelerometer_arguments">Arguments</a></h2>
+<h2>
+<a name="Accelerometer_arguments">Arguments</a>
+</h2>
<ul>
<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a></li>
<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometerError">accelerometerError</a></li>
<li><a href="cordova_accelerometer_accelerometer.md.html#accelerometerOptions">accelerometerOptions</a></li>
</ul>
-
-<h2><a name="Accelerometer_objects_read_only">Objects (Read-Only)</a></h2>
+<h2>
+<a name="Accelerometer_objects_read_only">Objects (Read-Only)</a>
+</h2>
<ul>
<li><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></li>
</ul>
-
-<h2><a name="Accelerometer_accessing_the_feature">Accessing the Feature</a></h2>
+<h2>
+<a name="Accelerometer_accessing_the_feature">Accessing the Feature</a>
+</h2>
<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-Line%0AInterface">The Command-Line
@@ -260,12 +262,10 @@ platform-specific configuration settings
<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
</li>
</ul>
-
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
<hr>
-
<h1><a name="accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a></h1>
<p>Get the current acceleration along the <em>x</em>, <em>y</em>, and <em>z</em> axes.</p>
@@ -273,7 +273,9 @@ configuration. See <a href="guide_suppo
<pre class="prettyprint"><code>navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(<a href="cordova_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a>, <a href="cordova_accelerometer_accelerometer.md.html#accelerometerError">accelerometerError</a>);
</code></pre>
-<h2><a name="accelerometer.getCurrentAcceleration_description">Description</a></h2>
+<h2>
+<a name="accelerometer.getCurrentAcceleration_description">Description</a>
+</h2>
<p>The accelerometer is a motion sensor that detects the change (<em>delta</em>)
in movement relative to the current device orientation, in three
@@ -282,7 +284,9 @@ dimensions along the <em>x</em>, <em>y</
<p>These acceleration values are returned to the <code><a href="cordova_accelerometer_accelerometer.md.html#accelerometerSuccess">accelerometerSuccess</a></code>
callback function.</p>
-<h2><a name="accelerometer.getCurrentAcceleration_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="accelerometer.getCurrentAcceleration_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -293,8 +297,9 @@ callback function.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="accelerometer.getCurrentAcceleration_quick_example">Quick Example</a></h2>
+<h2>
+<a name="accelerometer.getCurrentAcceleration_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>function onSuccess(acceleration) {
alert('<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
@@ -310,7 +315,9 @@ function onError() {
navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
</code></pre>
-<h2><a name="accelerometer.getCurrentAcceleration_full_example">Full Example</a></h2>
+<h2>
+<a name="accelerometer.getCurrentAcceleration_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -354,16 +361,16 @@ navigator.<a href="cordova_accelerometer
</html>
</code></pre>
-<h2><a name="accelerometer.getCurrentAcceleration_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="accelerometer.getCurrentAcceleration_ios_quirks">iOS Quirks</a>
+</h2>
<ul>
<li><p>iOS doesn't recognize the concept of getting the current acceleration at any given point.</p></li>
<li><p>You must watch the acceleration and capture the data at given time intervals.</p></li>
<li><p>Thus, the <code>getCurrentAcceleration</code> function yields the last value reported from a <code>watchAccelerometer</code> call.</p></li>
</ul>
-
<hr>
-
<h1><a name="accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></h1>
<p>At a regular interval, get the acceleration along the <em>x</em>, <em>y</em>, and <em>z</em> axis.</p>
@@ -373,7 +380,9 @@ navigator.<a href="cordova_accelerometer
[<a href="cordova_accelerometer_accelerometer.md.html#accelerometerOptions">accelerometerOptions</a>]);
</code></pre>
-<h2><a name="accelerometer.watchAcceleration_description">Description</a></h2>
+<h2>
+<a name="accelerometer.watchAcceleration_description">Description</a>
+</h2>
<p>The accelerometer is a motion sensor that detects the change (delta)
in movement relative to the current position. The accelerometer can
@@ -389,7 +398,9 @@ interval in milliseconds via the <code>a
and can be used with <code><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a></code> to stop watching the
accelerometer.</p>
-<h2><a name="accelerometer.watchAcceleration_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="accelerometer.watchAcceleration_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -400,8 +411,9 @@ accelerometer.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="accelerometer.watchAcceleration_quick_example">Quick Example</a></h2>
+<h2>
+<a name="accelerometer.watchAcceleration_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>function onSuccess(acceleration) {
alert('<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
@@ -419,7 +431,9 @@ var options = { frequency: 3000 }; // U
var watchID = navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(onSuccess, onError, options);
</code></pre>
-<h2><a name="accelerometer.watchAcceleration_full_example">Full Example</a></h2>
+<h2>
+<a name="accelerometer.watchAcceleration_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -485,7 +499,9 @@ var watchID = navigator.<a href="cordova
</html>
</code></pre>
-<h2><a name="accelerometer.watchAcceleration_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="accelerometer.watchAcceleration_ios_quirks">iOS Quirks</a>
+</h2>
<p>The API calls the success callback function at the interval requested,
but restricts the range of requests to the device between 40ms and
@@ -494,7 +510,6 @@ but restricts the range of requests to t
only executes the success callback every 3 seconds.</p>
<hr>
-
<h1><a name="accelerometer.clearWatch">accelerometer.clearWatch</a></h1>
<p>Stop watching the <code><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></code> referenced by the <code>watchID</code> parameter.</p>
@@ -506,8 +521,9 @@ only executes the success callback every
<li>
<strong>watchID</strong>: The ID returned by <code><a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a></code>.</li>
</ul>
-
-<h2><a name="accelerometer.clearWatch_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="accelerometer.clearWatch_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -518,8 +534,9 @@ only executes the success callback every
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="accelerometer.clearWatch_quick_example">Quick Example</a></h2>
+<h2>
+<a name="accelerometer.clearWatch_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>var watchID = navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.watchAcceleration">accelerometer.watchAcceleration</a>(onSuccess, onError, options);
@@ -528,7 +545,9 @@ only executes the success callback every
navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.clearWatch">accelerometer.clearWatch</a>(watchID);
</code></pre>
-<h2><a name="accelerometer.clearWatch_full_example">Full Example</a></h2>
+<h2>
+<a name="accelerometer.clearWatch_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -597,12 +616,13 @@ navigator.<a href="cordova_accelerometer
</code></pre>
<hr>
-
<h1><a name="Acceleration">Acceleration</a></h1>
<p>Contains <code><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></code> data captured at a specific point in time.</p>
-<h2><a name="Acceleration_properties">Properties</a></h2>
+<h2>
+<a name="Acceleration_properties">Properties</a>
+</h2>
<ul>
<li>
@@ -618,15 +638,18 @@ navigator.<a href="cordova_accelerometer
<strong>timestamp</strong>: Creation timestamp in milliseconds. <em>(DOMTimeStamp)</em>
</li>
</ul>
-
-<h2><a name="Acceleration_description">Description</a></h2>
+<h2>
+<a name="Acceleration_description">Description</a>
+</h2>
<p>An <code><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></code> object is populated and returned by any of the API's
<code><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></code> methods. <a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> values include the effect of
gravity (9.81 m/s^2), so that when a device lies flat and facing up,
<em>x</em>, <em>y</em>, and <em>z</em> values returned should be <code>0</code>, <code>0</code>, and <code>9.81</code>.</p>
-<h2><a name="Acceleration_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="Acceleration_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS </li>
@@ -637,8 +660,9 @@ gravity (9.81 m/s^2), so that when a dev
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="Acceleration_quick_example">Quick Example</a></h2>
+<h2>
+<a name="Acceleration_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>function onSuccess(acceleration) {
alert('<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
@@ -654,7 +678,9 @@ function onError() {
navigator.<a href="cordova_accelerometer_accelerometer.md.html#accelerometer.getCurrentAcceleration">accelerometer.getCurrentAcceleration</a>(onSuccess, onError);
</code></pre>
-<h2><a name="Acceleration_full_example">Full Example</a></h2>
+<h2>
+<a name="Acceleration_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -699,7 +725,6 @@ navigator.<a href="cordova_accelerometer
</code></pre>
<hr>
-
<h1><a name="accelerometerSuccess">accelerometerSuccess</a></h1>
<p>onSuccess callback function that provides the <code><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></code> information.</p>
@@ -709,14 +734,17 @@ navigator.<a href="cordova_accelerometer
}
</code></pre>
-<h2><a name="accelerometerSuccess_parameters">Parameters</a></h2>
+<h2>
+<a name="accelerometerSuccess_parameters">Parameters</a>
+</h2>
<ul>
<li>
<strong>acceleration</strong>: The acceleration at a single moment in time. (<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a>)</li>
</ul>
-
-<h2><a name="accelerometerSuccess_example">Example</a></h2>
+<h2>
+<a name="accelerometerSuccess_example">Example</a>
+</h2>
<pre class="prettyprint"><code>function onSuccess(acceleration) {
alert('<a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a> X: ' + acceleration.x + '\n' +
@@ -727,7 +755,6 @@ navigator.<a href="cordova_accelerometer
</code></pre>
<hr>
-
<h1><a name="accelerometerError">accelerometerError</a></h1>
<p>onError callback function for acceleration functions.</p>
@@ -738,23 +765,22 @@ navigator.<a href="cordova_accelerometer
</code></pre>
<hr>
-
<h1><a name="accelerometerOptions">accelerometerOptions</a></h1>
<p>An optional parameter to customize the retrieval of accelerometer values.</p>
-<h2><a name="accelerometerOptions_options">Options</a></h2>
+<h2>
+<a name="accelerometerOptions_options">Options</a>
+</h2>
<ul>
<li>
<strong>frequency</strong>: How often to retrieve the <code><a href="cordova_accelerometer_accelerometer.md.html#Acceleration">Acceleration</a></code> in milliseconds. <em>(Number)</em> (Default: 10000)</li>
</ul>
-
- </div>
+</div>
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script>
- <script type="text/javascript" src="prettify/prettify.js"></script>
- </body>
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
</html>
Modified: cordova/site/public/docs/en/3.3.0/cordova_camera_camera.cleanup.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.3.0/cordova_camera_camera.cleanup.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.3.0/cordova_camera_camera.cleanup.md.html (original)
+++ cordova/site/public/docs/en/3.3.0/cordova_camera_camera.cleanup.md.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
- <meta name="generator" content="joDoc">
-
- <title>Apache Cordova API Documentation</title>
-
- <link rel="stylesheet" type="text/css" href="index.css">
- <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
- <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
- </head>
- <body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -94,8 +92,7 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select>
- </small>
+</optgroup></select></small>
</div>
<div id="subheader">
<h1>camera.cleanup</h1>
@@ -153,20 +150,25 @@ storage.</p>
<pre class="prettyprint"><code>navigator.<a href="cordova_camera_camera.cleanup.md.html#camera.cleanup">camera.cleanup</a>( <a href="cordova_camera_camera.md.html#cameraSuccess">cameraSuccess</a>, <a href="cordova_camera_camera.md.html#cameraError">cameraError</a> );
</code></pre>
-<h2><a name="camera.cleanup_description">Description</a></h2>
+<h2>
+<a name="camera.cleanup_description">Description</a>
+</h2>
<p>Removes intermediate image files that are kept in temporary storage
after calling <code><a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a></code>. Applies only when the value of
<code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.sourceType</code> equals <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.CAMERA</code> and the
<code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.destinationType</code> equals <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.DestinationType.FILE_URI</code>.</p>
-<h2><a name="camera.cleanup_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="camera.cleanup_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>iOS</li>
</ul>
-
-<h2><a name="camera.cleanup_example">Example</a></h2>
+<h2>
+<a name="camera.cleanup_example">Example</a>
+</h2>
<pre class="prettyprint"><code>navigator.<a href="cordova_camera_camera.cleanup.md.html#camera.cleanup">camera.cleanup</a>(onSuccess, onFail);
@@ -183,7 +185,6 @@ function onFail(message) {
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script>
- <script type="text/javascript" src="prettify/prettify.js"></script>
- </body>
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
</html>
Modified: cordova/site/public/docs/en/3.3.0/cordova_camera_camera.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.3.0/cordova_camera_camera.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.3.0/cordova_camera_camera.md.html (original)
+++ cordova/site/public/docs/en/3.3.0/cordova_camera_camera.md.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
- <meta name="generator" content="joDoc">
-
- <title>Apache Cordova API Documentation</title>
-
- <link rel="stylesheet" type="text/css" href="index.css">
- <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
- <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
- </head>
- <body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -94,8 +92,7 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select>
- </small>
+</optgroup></select></small>
</div>
<div id="subheader">
<h1>Camera</h1>
@@ -194,14 +191,17 @@ obtaining the user's permission (e.g., b
<strong>OK</strong> and <strong>No Thanks</strong>). For more information, please see the
<a href="guide_appdev_privacy_index.md.html#Privacy%20Guide">Privacy Guide</a>.</p>
-<h2><a name="Camera_methods">Methods</a></h2>
+<h2>
+<a name="Camera_methods">Methods</a>
+</h2>
<ul>
<li><a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a></li>
<li><a href="cordova_camera_camera.cleanup.md.html#camera.cleanup">camera.cleanup</a></li>
</ul>
-
-<h2><a name="Camera_accessing_the_feature">Accessing the Feature</a></h2>
+<h2>
+<a name="Camera_accessing_the_feature">Accessing the Feature</a>
+</h2>
<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-Line%0AInterface">The Command-Line
@@ -279,12 +279,10 @@ platform-specific configuration settings
<p>Reference: <a class="external" href="https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures">Application Manifest for Tizen Web Application</a></p>
</li>
</ul>
-
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
<hr>
-
<h1><a name="camera.getPicture">camera.getPicture</a></h1>
<p>Takes a photo using the camera, or retrieves a photo from the device's
@@ -296,7 +294,9 @@ reposition the file selection popover.</
<pre class="prettyprint"><code>navigator.<a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a>( <a href="cordova_camera_camera.md.html#cameraSuccess">cameraSuccess</a>, <a href="cordova_camera_camera.md.html#cameraError">cameraError</a>, [ <a href="cordova_camera_camera.md.html#cameraOptions">cameraOptions</a> ] );
</code></pre>
-<h2><a name="camera.getPicture_description">Description</a></h2>
+<h2>
+<a name="camera.getPicture_description">Description</a>
+</h2>
<p>The <code><a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a></code> function opens the device's default camera
application that allows users to snap pictures. This behavior occurs
@@ -319,7 +319,6 @@ one of the following formats, depending
<li><p>A <code>String</code> containing the base64-encoded photo image.</p></li>
<li><p>A <code>String</code> representing the image file location on local storage (default).</p></li>
</ul>
-
<p>You can do whatever you want with the encoded image or URI, for
example:</p>
@@ -328,14 +327,15 @@ example:</p>
<li><p>Save the data locally (<code>LocalStorage</code>, <a class="external" href="http://brianleroux.github.com/lawnchair/">Lawnchair</a>, etc.)</p></li>
<li><p>Post the data to a remote server</p></li>
</ul>
-
<p><strong>NOTE</strong>: Photo resolution on newer devices is quite good. Photos
selected from the device's gallery are not downscaled to a lower
quality, even if a <code>quality</code> parameter is specified. To avoid common
memory problems, set <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.destinationType</code> to <code>FILE_URI</code> rather
than <code>DATA_URL</code>.</p>
-<h2><a name="camera.getPicture_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="camera.getPicture_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -346,14 +346,17 @@ than <code>DATA_URL</code>.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="camera.getPicture_amazon_fire_os_quirks">Amazon Fire OS Quirks</a></h2>
+<h2>
+<a name="camera.getPicture_amazon_fire_os_quirks">Amazon Fire OS Quirks</a>
+</h2>
<p>Amazon Fire OS uses intents to launch the camera activity on the device to capture
images, and on phones with low memory, the Cordova activity may be killed. In this
scenario, the image may not appear when the cordova activity is restored.</p>
-<h2><a name="camera.getPicture_android_quirks">Android Quirks</a></h2>
+<h2>
+<a name="camera.getPicture_android_quirks">Android Quirks</a>
+</h2>
<p><em>Android 4.4 only</em>: Android 4.4 introduced a new <a class="external" href="https://developer.android.com/guide/topics/providers/document-provider.html"></a><a href="cordova_storage_storage.md.html#Storage">Storage</a> Access Framework that makes it
easier for users to browse and open documents across all of their preferred document storage providers.
@@ -366,7 +369,9 @@ if they go through the "Gallery" app fir
images, and on phones with low memory, the Cordova activity may be killed. In this
scenario, the image may not appear when the Cordova activity is restored.</p>
-<h2><a name="camera.getPicture_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="camera.getPicture_ios_quirks">iOS Quirks</a>
+</h2>
<p>Including a JavaScript <code>alert()</code> in either of the callback functions
can cause problems. Wrap the alert within a <code>setTimeout()</code> to allow
@@ -378,18 +383,24 @@ displays:</p>
}, 0);
</code></pre>
-<h2><a name="camera.getPicture_windows_phone_7_quirks">Windows Phone 7 Quirks</a></h2>
+<h2>
+<a name="camera.getPicture_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
+</h2>
<p>Invoking the native camera application while the device is connected
via Zune does not work, and triggers an error callback.</p>
-<h2><a name="camera.getPicture_tizen_quirks">Tizen Quirks</a></h2>
+<h2>
+<a name="camera.getPicture_tizen_quirks">Tizen Quirks</a>
+</h2>
<p>Tizen only supports a <code>destinationType</code> of
<code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.DestinationType.FILE_URI</code> and a <code>sourceType</code> of
<code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY</code>.</p>
-<h2><a name="camera.getPicture_quick_example">Quick Example</a></h2>
+<h2>
+<a name="camera.getPicture_quick_example">Quick Example</a>
+</h2>
<p>Take a photo and retrieve it as a base64-encoded image:</p>
@@ -422,7 +433,9 @@ function onFail(message) {
}
</code></pre>
-<h2><a name="camera.getPicture_full_example">Full Example</a></h2>
+<h2>
+<a name="camera.getPicture_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -531,7 +544,6 @@ function onFail(message) {
</code></pre>
<hr>
-
<h1><a name="cameraSuccess">cameraSuccess</a></h1>
<p>onSuccess callback function that provides the image data.</p>
@@ -541,15 +553,18 @@ function onFail(message) {
}
</code></pre>
-<h2><a name="cameraSuccess_parameters">Parameters</a></h2>
+<h2>
+<a name="cameraSuccess_parameters">Parameters</a>
+</h2>
<ul>
<li>
<strong>imageData</strong>: Base64 encoding of the image data, <em>or</em> the image file URI, depending on <code><a href="cordova_camera_camera.md.html#cameraOptions">cameraOptions</a></code> in effect. <em>(String)</em>
</li>
</ul>
-
-<h2><a name="cameraSuccess_example">Example</a></h2>
+<h2>
+<a name="cameraSuccess_example">Example</a>
+</h2>
<pre class="prettyprint"><code>// Show image
//
@@ -560,7 +575,6 @@ function cameraCallback(imageData) {
</code></pre>
<hr>
-
<h1><a name="cameraError">cameraError</a></h1>
<p>onError callback function that provides an error message.</p>
@@ -570,16 +584,16 @@ function cameraCallback(imageData) {
}
</code></pre>
-<h2><a name="cameraError_parameters">Parameters</a></h2>
+<h2>
+<a name="cameraError_parameters">Parameters</a>
+</h2>
<ul>
<li>
<strong>message</strong>: The message is provided by the device's native code. <em>(String)</em>
</li>
</ul>
-
<hr>
-
<h1><a name="cameraOptions">cameraOptions</a></h1>
<p>Optional parameters to customize the camera settings.</p>
@@ -595,7 +609,9 @@ function cameraCallback(imageData) {
saveToPhotoAlbum: false };
</code></pre>
-<h2><a name="cameraOptions_options">Options</a></h2>
+<h2>
+<a name="cameraOptions_options">Options</a>
+</h2>
<ul>
<li><p><strong>quality</strong>: Quality of the saved image, expressed as a range of 0-100, where 100 is typically full resolution with no loss from file compression. <em>(Number)</em> (Note that information about the camera's resolution is unavailable.)</p></li>
@@ -655,24 +671,27 @@ function cameraCallback(imageData) {
</code></pre>
</li>
</ul>
-
-<h2><a name="cameraOptions_amazon_fire_osquirks">Amazon Fire OSQuirks</a></h2>
+<h2>
+<a name="cameraOptions_amazon_fire_osquirks">Amazon Fire OSQuirks</a>
+</h2>
<ul>
<li><p>Any <code>cameraDirection</code> value results in a back-facing photo.</p></li>
<li><p>Ignores the <code>allowEdit</code> parameter.</p></li>
<li><p><code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY</code> and <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM</code> both display the same photo album.</p></li>
</ul>
-
-<h2><a name="cameraOptions_android_quirks">Android Quirks</a></h2>
+<h2>
+<a name="cameraOptions_android_quirks">Android Quirks</a>
+</h2>
<ul>
<li><p>Any <code>cameraDirection</code> value results in a back-facing photo.</p></li>
<li><p>Ignores the <code>allowEdit</code> parameter.</p></li>
<li><p><code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.PHOTOLIBRARY</code> and <code><a href="cordova_camera_camera.md.html#Camera">Camera</a>.PictureSourceType.SAVEDPHOTOALBUM</code> both display the same photo album.</p></li>
</ul>
-
-<h2><a name="cameraOptions_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
+<h2>
+<a name="cameraOptions_blackberry_10_quirks">BlackBerry 10 Quirks</a>
+</h2>
<ul>
<li><p>Ignores the <code>quality</code> parameter.</p></li>
@@ -682,31 +701,32 @@ function cameraCallback(imageData) {
<li><p>Ignores the <code>correctOrientation</code> parameter.</p></li>
<li><p>Ignores the <code>cameraDirection</code> parameter.</p></li>
</ul>
-
-<h2><a name="cameraOptions_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="cameraOptions_ios_quirks">iOS Quirks</a>
+</h2>
<ul>
<li><p>Set <code>quality</code> below 50 to avoid memory errors on some devices.</p></li>
<li><p>When using <code>destinationType.FILE_URI</code>, photos are saved in the application's temporary directory. You may delete the contents of this directory using the <code>navigator.fileMgr</code> APIs if storage space is a concern.</p></li>
</ul>
-
-<h2><a name="cameraOptions_tizen_quirks">Tizen Quirks</a></h2>
+<h2>
+<a name="cameraOptions_tizen_quirks">Tizen Quirks</a>
+</h2>
<ul>
<li><p>options not supported</p></li>
<li><p>always returns a FILE URI</p></li>
</ul>
-
-<h2><a name="cameraOptions_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a></h2>
+<h2>
+<a name="cameraOptions_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
<ul>
<li><p>Ignores the <code>allowEdit</code> parameter.</p></li>
<li><p>Ignores the <code>correctOrientation</code> parameter.</p></li>
<li><p>Ignores the <code>cameraDirection</code> parameter.</p></li>
</ul>
-
<hr>
-
<h1><a name="CameraPopoverOptions">CameraPopoverOptions</a></h1>
<p>iOS-only parameters that specify the anchor element location and arrow
@@ -721,7 +741,9 @@ or album.</p>
};
</code></pre>
-<h2><a name="CameraPopoverOptions_camerapopoveroptions">CameraPopoverOptions</a></h2>
+<h2>
+<a name="CameraPopoverOptions_camerapopoveroptions">CameraPopoverOptions</a>
+</h2>
<ul>
<li><p><strong>x</strong>: x pixel coordinate of screen element onto which to anchor the popover. <em>(Number)</em></p></li>
@@ -741,13 +763,14 @@ or album.</p>
</code></pre>
</li>
</ul>
-
<p>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.</p>
-<h2><a name="CameraPopoverOptions_quick_example">Quick Example</a></h2>
+<h2>
+<a name="CameraPopoverOptions_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code> var popover = new <a href="cordova_camera_camera.md.html#CameraPopoverOptions">CameraPopoverOptions</a>(300, 300, 100, 100, <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PopoverArrowDirection.ARROW_ANY);
var options = {
@@ -770,25 +793,28 @@ location.</p>
</code></pre>
<hr>
-
<h1><a name="CameraPopoverHandle">CameraPopoverHandle</a></h1>
<p>A handle to the popover dialog created by <code><a href="cordova_camera_camera.md.html#camera.getPicture">camera.getPicture</a></code>.</p>
-<h2><a name="CameraPopoverHandle_methods">Methods</a></h2>
+<h2>
+<a name="CameraPopoverHandle_methods">Methods</a>
+</h2>
<ul>
<li>
<strong>setPosition</strong>: Set the position of the popover.</li>
</ul>
-
-<h2><a name="CameraPopoverHandle_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="CameraPopoverHandle_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>iOS</li>
</ul>
-
-<h2><a name="CameraPopoverHandle_setposition">setPosition</a></h2>
+<h2>
+<a name="CameraPopoverHandle_setposition">setPosition</a>
+</h2>
<p>Set the position of the popover.</p>
@@ -798,14 +824,17 @@ location.</p>
<li>
<code>cameraPopoverOptions</code>: the <code><a href="cordova_camera_camera.md.html#CameraPopoverOptions">CameraPopoverOptions</a></code> that specify the new position</li>
</ul>
-
-<h2><a name="CameraPopoverHandle_quick_example">Quick Example</a></h2>
+<h2>
+<a name="CameraPopoverHandle_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code> var cameraPopoverOptions = new <a href="cordova_camera_camera.md.html#CameraPopoverOptions">CameraPopoverOptions</a>(300, 300, 100, 100, <a href="cordova_camera_camera.md.html#Camera">Camera</a>.PopoverArrowDirection.ARROW_ANY);
cameraPopoverHandle.setPosition(cameraPopoverOptions);
</code></pre>
-<h2><a name="CameraPopoverHandle_full_example">Full Example</a></h2>
+<h2>
+<a name="CameraPopoverHandle_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code> function onSuccess(imageData) {
// Do stuff with the image!
@@ -830,7 +859,6 @@ location.</p>
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script>
- <script type="text/javascript" src="prettify/prettify.js"></script>
- </body>
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
</html>
Modified: cordova/site/public/docs/en/3.3.0/cordova_compass_compass.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.3.0/cordova_compass_compass.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.3.0/cordova_compass_compass.md.html (original)
+++ cordova/site/public/docs/en/3.3.0/cordova_compass_compass.md.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
- <meta name="generator" content="joDoc">
-
- <title>Apache Cordova API Documentation</title>
-
- <link rel="stylesheet" type="text/css" href="index.css">
- <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
- <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
- </head>
- <body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -94,8 +92,7 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select>
- </small>
+</optgroup></select></small>
</div>
<div id="subheader">
<h1>Compass</h1>
@@ -189,7 +186,9 @@
<p>Obtains the direction that the device is pointing.</p>
</blockquote>
-<h2><a name="Compass_methods">Methods</a></h2>
+<h2>
+<a name="Compass_methods">Methods</a>
+</h2>
<ul>
<li><a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a></li>
@@ -200,8 +199,9 @@
<li>
<a href="cordova_compass_compass.md.html#compass.clearWatchFilter">compass.clearWatchFilter</a> (obsolete)</li>
</ul>
-
-<h2><a name="Compass_arguments">Arguments</a></h2>
+<h2>
+<a name="Compass_arguments">Arguments</a>
+</h2>
<ul>
<li><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></li>
@@ -209,8 +209,9 @@
<li><a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a></li>
<li><a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a></li>
</ul>
-
-<h2><a name="Compass_accessing_the_feature">Accessing the Feature</a></h2>
+<h2>
+<a name="Compass_accessing_the_feature">Accessing the Feature</a>
+</h2>
<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-Line%0AInterface">The Command-Line
@@ -290,12 +291,10 @@ platform-specific configuration settings
<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
</li>
</ul>
-
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
<hr>
-
<h1><a name="compass.getCurrentHeading">compass.getCurrentHeading</a></h1>
<p>Get the current compass heading.</p>
@@ -303,7 +302,9 @@ configuration. See <a href="guide_suppo
<pre class="prettyprint"><code>navigator.<a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a>(<a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a>, <a href="cordova_compass_compass.md.html#compassError">compassError</a>, <a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a>);
</code></pre>
-<h2><a name="compass.getCurrentHeading_description">Description</a></h2>
+<h2>
+<a name="compass.getCurrentHeading_description">Description</a>
+</h2>
<p>The compass is a sensor that detects the direction or heading that the
device is pointed, typically from the top of the device. It measures
@@ -312,7 +313,9 @@ the heading in degrees from 0 to 359.99,
<p>The compass heading information is returned via a <code>CompassHeading</code>
object using the <code><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></code> callback function.</p>
-<h2><a name="compass.getCurrentHeading_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="compass.getCurrentHeading_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -323,8 +326,9 @@ object using the <code><a href="cordova_
<li>Windows Phone 7 and 8 (if available in hardware)</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="compass.getCurrentHeading_quick_example">Quick Example</a></h2>
+<h2>
+<a name="compass.getCurrentHeading_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>function onSuccess(heading) {
alert('Heading: ' + heading.magneticHeading);
@@ -337,7 +341,9 @@ function onError(error) {
navigator.<a href="cordova_compass_compass.md.html#compass.getCurrentHeading">compass.getCurrentHeading</a>(onSuccess, onError);
</code></pre>
-<h2><a name="compass.getCurrentHeading_full_example">Full Example</a></h2>
+<h2>
+<a name="compass.getCurrentHeading_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -379,7 +385,6 @@ navigator.<a href="cordova_compass_compa
</code></pre>
<hr>
-
<h1><a name="compass.watchHeading">compass.watchHeading</a></h1>
<p>At a regular interval, get the compass heading in degrees.</p>
@@ -387,7 +392,9 @@ navigator.<a href="cordova_compass_compa
<pre class="prettyprint"><code>var watchID = navigator.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(<a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a>, <a href="cordova_compass_compass.md.html#compassError">compassError</a>, [<a href="cordova_compass_compass.md.html#compassOptions">compassOptions</a>]);
</code></pre>
-<h2><a name="compass.watchHeading_description">Description</a></h2>
+<h2>
+<a name="compass.watchHeading_description">Description</a>
+</h2>
<p>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
@@ -402,7 +409,9 @@ object.</p>
<p>The returned watch ID references the compass watch interval. The watch
ID can be used with <code><a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></code> to stop watching the compass.</p>
-<h2><a name="compass.watchHeading_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="compass.watchHeading_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -413,8 +422,9 @@ ID can be used with <code><a href="cordo
<li>Windows Phone 7 and 8 (if available in hardware)</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="compass.watchHeading_quick_example">Quick Example</a></h2>
+<h2>
+<a name="compass.watchHeading_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>function onSuccess(heading) {
var element = document.getElementById('heading');
@@ -432,7 +442,9 @@ var options = {
var watchID = navigator.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(onSuccess, onError, options);
</code></pre>
-<h2><a name="compass.watchHeading_full_example">Full Example</a></h2>
+<h2>
+<a name="compass.watchHeading_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -497,7 +509,9 @@ var watchID = navigator.<a href="cordova
</html>
</code></pre>
-<h2><a name="compass.watchHeading_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="compass.watchHeading_ios_quirks">iOS Quirks</a>
+</h2>
<p>In iOS <code><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></code> can also get the device's current
heading when it changes by a specified number of degrees. Each time
@@ -516,7 +530,6 @@ changes. Watching heading changes with a
with time intervals.</p>
<hr>
-
<h1><a name="compass.clearWatch">compass.clearWatch</a></h1>
<p>Stop watching the compass referenced by the watch ID parameter.</p>
@@ -528,8 +541,9 @@ with time intervals.</p>
<li>
<strong>watchID</strong>: The ID returned by <code><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></code>.</li>
</ul>
-
-<h2><a name="compass.clearWatch_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="compass.clearWatch_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -540,8 +554,9 @@ with time intervals.</p>
<li>Windows Phone 7 and 8 (if available in hardware)</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="compass.clearWatch_quick_example">Quick Example</a></h2>
+<h2>
+<a name="compass.clearWatch_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>var watchID = navigator.<a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a>(onSuccess, onError, options);
@@ -550,7 +565,9 @@ with time intervals.</p>
navigator.<a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a>(watchID);
</code></pre>
-<h2><a name="compass.clearWatch_full_example">Full Example</a></h2>
+<h2>
+<a name="compass.clearWatch_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -616,19 +633,16 @@ navigator.<a href="cordova_compass_compa
</code></pre>
<hr>
-
<h1><a name="compass.watchHeadingFilter">compass.watchHeadingFilter</a></h1>
<p>No longer supported as of 1.6, see <code><a href="cordova_compass_compass.md.html#compass.watchHeading">compass.watchHeading</a></code> for equivalent functionality.</p>
<hr>
-
<h1><a name="compass.clearWatchFilter">compass.clearWatchFilter</a></h1>
<p>No longer supported as of 1.6. See <code><a href="cordova_compass_compass.md.html#compass.clearWatch">compass.clearWatch</a></code>.</p>
<hr>
-
<h1><a name="compassSuccess">compassSuccess</a></h1>
<p>onSuccess callback function that provides the compass heading information via a <code><a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a></code> object.</p>
@@ -638,15 +652,18 @@ navigator.<a href="cordova_compass_compa
}
</code></pre>
-<h2><a name="compassSuccess_parameters">Parameters</a></h2>
+<h2>
+<a name="compassSuccess_parameters">Parameters</a>
+</h2>
<ul>
<li>
<strong>heading</strong>: The heading information. <em>(<a href="cordova_compass_compass.md.html#compassHeading">compassHeading</a>)</em>
</li>
</ul>
-
-<h2><a name="compassSuccess_example">Example</a></h2>
+<h2>
+<a name="compassSuccess_example">Example</a>
+</h2>
<pre class="prettyprint"><code>function onSuccess(heading) {
alert('Heading: ' + heading.magneticHeading);
@@ -654,12 +671,13 @@ navigator.<a href="cordova_compass_compa
</code></pre>
<hr>
-
<h1><a name="compassError">compassError</a></h1>
<p>onError callback function for compass functions.</p>
-<h2><a name="compassError_example">Example</a></h2>
+<h2>
+<a name="compassError_example">Example</a>
+</h2>
<pre class="prettyprint"><code>function(<a href="cordova_compass_compass.md.html#CompassError">CompassError</a>) {
// Handle the error
@@ -667,50 +685,55 @@ navigator.<a href="cordova_compass_compa
</code></pre>
<hr>
-
<h1><a name="compassOptions">compassOptions</a></h1>
<p>An optional parameter to customize the retrieval of the compass.</p>
-<h2><a name="compassOptions_options">Options</a></h2>
+<h2>
+<a name="compassOptions_options">Options</a>
+</h2>
<ul>
<li><p><strong>frequency</strong>: How often to retrieve the compass heading in milliseconds. <em>(Number)</em> (Default: 100)</p></li>
<li><p><strong>filter</strong>: The change in degrees required to initiate a watchHeading success callback. <em>(Number)</em></p></li>
</ul>
-
-<h2><a name="compassOptions_amazon_fire_os_quirks">Amazon Fire OS Quirks</a></h2>
+<h2>
+<a name="compassOptions_amazon_fire_os_quirks">Amazon Fire OS Quirks</a>
+</h2>
<ul>
<li>
<code>filter</code> is not supported.</li>
</ul>
-
-<h2><a name="compassOptions_android_quirks">Android Quirks</a></h2>
+<h2>
+<a name="compassOptions_android_quirks">Android Quirks</a>
+</h2>
<ul>
<li>No support for <code>filter</code>.</li>
</ul>
-
-<h2><a name="compassOptions_tizen_quirks">Tizen Quirks</a></h2>
+<h2>
+<a name="compassOptions_tizen_quirks">Tizen Quirks</a>
+</h2>
<ul>
<li>No support for <code>filter</code>.</li>
</ul>
-
-<h2><a name="compassOptions_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a></h2>
+<h2>
+<a name="compassOptions_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
<ul>
<li>No support for <code>filter</code>.</li>
</ul>
-
<hr>
-
<h1><a name="compassHeading">compassHeading</a></h1>
<p>A <code>CompassHeading</code> object is returned to the <code><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></code> callback function.</p>
-<h2><a name="compassHeading_properties">Properties</a></h2>
+<h2>
+<a name="compassHeading_properties">Properties</a>
+</h2>
<ul>
<li><p><strong>magneticHeading</strong>: The heading in degrees from 0-359.99 at a single moment in time. <em>(Number)</em></p></li>
@@ -718,53 +741,60 @@ navigator.<a href="cordova_compass_compa
<li><p><strong>headingAccuracy</strong>: The deviation in degrees between the reported heading and the true heading. <em>(Number)</em></p></li>
<li><p><strong>timestamp</strong>: The time at which this heading was determined. <em>(milliseconds)</em></p></li>
</ul>
-
-<h2><a name="compassHeading_description">Description</a></h2>
+<h2>
+<a name="compassHeading_description">Description</a>
+</h2>
<p>The <code>CompassHeading</code> object is returned to the <code><a href="cordova_compass_compass.md.html#compassSuccess">compassSuccess</a></code> callback function.</p>
-<h2><a name="compassHeading_amazon_fire_os_quirks">Amazon Fire OS Quirks</a></h2>
+<h2>
+<a name="compassHeading_amazon_fire_os_quirks">Amazon Fire OS Quirks</a>
+</h2>
<ul>
<li><p><code>trueHeading</code> is not supported, but reports the same value as <code>magneticHeading</code></p></li>
<li><p><code>headingAccuracy</code> is always 0 because there is no difference between the <code>magneticHeading</code> and <code>trueHeading</code></p></li>
</ul>
-
-<h2><a name="compassHeading_android_quirks">Android Quirks</a></h2>
+<h2>
+<a name="compassHeading_android_quirks">Android Quirks</a>
+</h2>
<ul>
<li><p>The <code>trueHeading</code> property is not supported, but reports the same value as <code>magneticHeading</code>.</p></li>
<li><p>The <code>headingAccuracy</code> property is always 0 because there is no difference between the <code>magneticHeading</code> and <code>trueHeading</code>.</p></li>
</ul>
-
-<h2><a name="compassHeading_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="compassHeading_ios_quirks">iOS Quirks</a>
+</h2>
<ul>
<li><p>The <code>trueHeading</code> property is only returned for location services enabled via <code>navigator.geolocation.watchLocation()</code>.</p></li>
<li><p>For iOS 4 devices and above, heading factors in the device's current orientation, and does not reference its absolute position, for apps that supports that orientation.</p></li>
</ul>
-
<hr>
-
<h1><a name="CompassError">CompassError</a></h1>
<p>A <code><a href="cordova_compass_compass.md.html#CompassError">CompassError</a></code> object is returned to the <code><a href="cordova_compass_compass.md.html#compassError">compassError</a></code> callback function when an error occurs.</p>
-<h2><a name="CompassError_properties">Properties</a></h2>
+<h2>
+<a name="CompassError_properties">Properties</a>
+</h2>
<ul>
<li>
<strong>code</strong>: One of the predefined error codes listed below.</li>
</ul>
-
-<h2><a name="CompassError_constants">Constants</a></h2>
+<h2>
+<a name="CompassError_constants">Constants</a>
+</h2>
<ul>
<li><code><a href="cordova_compass_compass.md.html#CompassError">CompassError</a>.COMPASS_INTERNAL_ERR</code></li>
<li><code><a href="cordova_compass_compass.md.html#CompassError">CompassError</a>.COMPASS_NOT_SUPPORTED</code></li>
</ul>
-
-<h2><a name="CompassError_description">Description</a></h2>
+<h2>
+<a name="CompassError_description">Description</a>
+</h2>
<p>When an error occurs, the <code><a href="cordova_compass_compass.md.html#CompassError">CompassError</a></code> object is passed as a
parameter to a <code><a href="cordova_compass_compass.md.html#compassError">compassError</a></code> callback function.</p>
@@ -773,7 +803,6 @@ parameter to a <code><a href="cordova_co
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script>
- <script type="text/javascript" src="prettify/prettify.js"></script>
- </body>
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
</html>