You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/07/18 21:28:25 UTC
[01/12] Version 3.0.0rc1
Updated Branches:
refs/heads/master 8f78f9c2f -> 17ffa3e52
Updated Tags: refs/tags/3.0.0rc1 [created] 17ffa3e52
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/project-settings/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/project-settings/index.md b/docs/en/3.0.0rc1/guide/project-settings/index.md
new file mode 100644
index 0000000..51af63d
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/project-settings/index.md
@@ -0,0 +1,78 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Configuration Reference
+
+You can set various application configuration parameters using a platform-agnostic configuration file, `config.xml`.
+This file is based on the W3C [Packaged Web Apps (Widgets)](http://www.w3.org/TR/widgets/) specification.
+
+The location of the `config.xml` file is different depending on the platform. The contents, in general, are not.
+
+## Platform-Specific Properties
+
+As with any abstraction layer, Apache Cordova cannot be a perfect silver bullet. As such, some native and platform-specific
+properties, characteristics and behaviours are encapsulated as much as possible as `<preference>` elements inside the
+`config.xml` file. The following sub-sections linked to are guides which go into more details about these preferences.
+
+- iOS Configuration
+- Android Configuration
+- BlackBerry Configuration
+- Windows Phone 7 Configuration
+- Windows Phone 8 Configuration
+- Windows 8 Configuration
+- FirefoxOS Configuration
+
+## config.xml Elements
+
+The [Apache Cordova](http://cordova.io) project strives abstract away native platform specifics via web-inspired and web-based
+abstractions that are heavily standards driven and adopted by the web community. Please take a few minutes to familiarize
+yourself with the [config.xml specification](http://www.w3.org/TR/widgets/), to understand the type of application metadata the
+Apache Cordova project aims to abstract and provide simple entry points for.
+
+An example:
+
+ <widget>
+ <preference name="MySetting" value="true" />
+ <plugins>
+ <plugin name="MyPlugin" value="MyPluginClass" />
+ </plugins>
+ <access origin="*" />
+ <content src="index.html" />
+ </widget>
+
+A list of supported elements across major platforms which are supported in Apache Cordova follow.
+
+### `<plugin>`
+
+These elements map to native APIs that the application accesses. At
+runtime, the Apache Cordova framework checks the `<plugin>` elements
+and maps them to native code to enable your Cordova application to
+access device APIs otherwise unavailable to typical web-based
+applications.
+
+### `<access>`
+
+These elements define how your whitelist works. Please see the
+Domain Whitelist Guide for more information.
+
+### `<content>`
+
+This element defines your application's start page relative to the
+project's standard web assets root folder. This element is optional,
+the default is `index.html`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/upgrading/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/upgrading/index.md b/docs/en/3.0.0rc1/guide/upgrading/index.md
new file mode 100644
index 0000000..e365fec
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/upgrading/index.md
@@ -0,0 +1,29 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Upgrading Guides
+
+> Learn how to upgrade an application to the latest Apache Cordova release.
+
+- Upgrading Android
+- Upgrading BlackBerry
+- Upgrading iOS
+- Upgrading Windows Phone
+- Upgrading Windows 8
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/webviews/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/webviews/index.md b/docs/en/3.0.0rc1/guide/webviews/index.md
new file mode 100644
index 0000000..937db59
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/webviews/index.md
@@ -0,0 +1,26 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Embedding WebViews
+
+> Implement the Cordova WebView in your own project.
+
+- Android WebViews
+- iOS WebViews
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/whitelist/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/whitelist/index.md b/docs/en/3.0.0rc1/guide/whitelist/index.md
new file mode 100644
index 0000000..6307b3f
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/whitelist/index.md
@@ -0,0 +1,164 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Domain Whitelist Guide
+
+## Overview
+
+Domain whitelisting is a security model that controls access to
+outside domains, such as `http://google.com`. Apache Cordova's
+default security policy allows access to any site. Before moving your
+application to production, you should review its whitelist and declare
+access to specific network domains and subdomains.
+
+## Specification
+
+Domain whitelisting lays the groundwork for the [W3C Widget Access][1] specification. In the Widget Access specification, the `<access>` element is used to declare access to specific network domains. In the future, Apache Cordova will abstract the platform whitelisting implementations to the W3C Widget Access specification. However, for now each platform must implement its own domain whitelisting.
+
+## Syntax
+
+Access to [google.com][2]:
+
+ http://google.com
+
+Access to the secure [google.com][3] (`https://`):
+
+ https://google.com
+
+Access to the subdomain [maps.google.com][4]:
+
+ http://maps.google.com
+
+Access to all the subdomains on [google.com][2] (e.g. [mail.google.com][5] and [docs.google.com][6]):
+
+ http://*.google.com
+
+Access to all domains (e.g. [google.com][2] and [developer.mozilla.org][7]):
+
+ *
+
+## Android
+
+### Details
+
+The whitelisting rules are found in `res/xml/config.xml` and declared
+with the element `<access origin="..." />`.
+
+Android fully supports whitelisting syntax.
+
+### Syntax
+
+Access to [google.com][2]:
+
+ <access origin="http://google.com" />
+
+## BlackBerry
+
+### Details
+
+The whitelisting rules are found in `www/config.xml` and declared with the element `<access uri="..." />`.
+
+For a complete reference, see the [BlackBerry WebWorks Access Element documentation][8].
+
+### Syntax
+
+Access to [google.com][2]:
+
+ <access uri="http://google.com" subdomains="false" />
+
+Access to [maps.google.com][4]:
+
+ <access uri="http://maps.google.com" subdomains="false" />
+
+Access to all the subdomains on [google.com][2]:
+
+ <access uri="http://google.com" subdomains="true" />
+
+Access to all domains, including `file://` protocol:
+
+ <access uri="*" subdomains="true" />
+
+iOS
+---
+
+### Details
+
+The whitelisting rules are found in `AppName/config.xml` and declared with the element `<access origin="..." />`.
+
+iOS fully supports whitelisting syntax.
+
+__NOTE:__ origins specified without a protocol, such as
+`www.apache.org` rather than `http://www.apache.org`, default to all
+of the `http`, `https`, `ftp`, and `ftps` schemes.
+
+### Syntax
+
+Wildcards on iOS (`*`) are more flexible than the [W3C Widget Access][1] specification.
+
+Access to all subdomains and TLDs (`.com`, `.net`, etc):
+
+ *.google.*
+
+## Windows Phone (7 & 8)
+
+The whitelisting rules are found in `config.xml` and declared with the element `<access origin="..." />`.
+
+Android fully supports whitelisting syntax.
+
+### Syntax
+
+Access to [google.com][2]:
+
+ <access origin="http://google.com" />
+
+## Tizen
+
+### Details
+
+The application root directory's `config.xml` file specifies domain
+whitelisting rules, using the `<access origin="..." />` element.
+For a complete reference, see the [Tizen Accessing External Network Resources documentation][10].
+
+### Syntax
+
+Access to [google.com][2]:
+
+ <access origin="http://google.com" subdomains="false" />
+
+Access to the secure [google.com][3] (`https://`):
+
+ <access origin="https://google.com" subdomains="false" />
+
+Access to all the subdomains on [google.com][2]:
+
+ <access origin="http://google.com" subdomains="true" />
+
+Access to all domains, including `file://` protocol:
+
+ <access origin="*" subdomains="true" />
+
+[1]: http://www.w3.org/TR/widgets-access/
+[2]: http://google.com
+[3]: https://google.com
+[4]: http://maps.google.com
+[5]: http://mail.google.com
+[6]: http://docs.google.com
+[7]: http://developer.mozilla.org
+[8]: https://developer.blackberry.com/html5/documentation/ww_developing/Access_element_834677_11.html
+[9]: https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_4#8814682_CreatingaProject-AccessingExternalNetworkResources
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/index.md b/docs/en/3.0.0rc1/index.md
new file mode 100644
index 0000000..afd255f
--- /dev/null
+++ b/docs/en/3.0.0rc1/index.md
@@ -0,0 +1,134 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+<div id="home">
+
+ <h1>Guides</h1>
+ <ul>
+ <li>
+ <h2>Overview</h2>
+ <span>Start here if you are new to Cordova.</span>
+ </li>
+ <li>
+ <h2>The Command-line Interface</h2>
+ <span>Create, build, and deploy from the command-line.</span>
+ </li>
+ <li>
+ <h2>Platform Guides</h2>
+ <span>Set up each SDK to create your first app.</span>
+ </li>
+ <li>
+ <h2>Upgrading Guides</h2>
+ <span>Upgrade an application to the latest release.</span>
+ </li>
+ <li>
+ <h2>Configuration Reference</h2>
+ <span>Customize the features of your app.</span>
+ </li>
+ <li>
+ <h2>Embedding WebViews</h2>
+ <span>Implement the Cordova WebView in your project.</span>
+ </li>
+ <li>
+ <h2>Plugin Development Guide</h2>
+ <span>Develop your first plugin.</span>
+ </li>
+ <li>
+ <h2>Privacy Guide</h2>
+ <span>Learn about important mobile privacy issues.</span>
+ </li>
+ <li>
+ <h2>Domain Whitelist Guide</h2>
+ <span>Grant an application access to external domains.</span>
+ </li>
+ <li>
+ <h2><a href="_index.html">Keyword Index</a></h2>
+ <span>Full index of the documentation.</span>
+ </li>
+ </ul>
+
+ <h1>API Reference</h1>
+ <ul>
+ <li>
+ <h2>Accelerometer</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>
+ </li>
+ <li>
+ <h2>Capture</h2>
+ <span>Capture media files using device's media capture applications.</span>
+ </li>
+ <li>
+ <h2>Compass</h2>
+ <span>Obtain the direction that the device is pointing.</span>
+ </li>
+ <li>
+ <h2>Connection</h2>
+ <span>Quickly check the network state, and cellular network information.</span>
+ </li>
+ <li>
+ <h2>Contacts</h2>
+ <span>Work with the devices contact database.</span>
+ </li>
+ <li>
+ <h2>Device</h2>
+ <span>Gather device specific information.</span>
+ </li>
+ <li>
+ <h2>Events</h2>
+ <span>Hook into native events through JavaScript.</span>
+ </li>
+ <li>
+ <h2>File</h2>
+ <span>Hook into native file system through JavaScript.</span>
+ </li>
+ <li>
+ <h2>Geolocation</h2>
+ <span>Make your application location aware.</span>
+ </li>
+ <li>
+ <h2>Globalization</h2>
+ <span>Enable representation of objects specific to a locale.</span>
+ </li>
+ <li>
+ <h2>InAppBrowser</h2>
+ <span>Launch URLs in another in-app browser instance.</span>
+ </li>
+ <li>
+ <h2>Media</h2>
+ <span>Record and play back audio files.</span>
+ </li>
+ <li>
+ <h2>Notification</h2>
+ <span>Visual, audible, and tactile device notifications.</span>
+ </li>
+ <li>
+ <h2>Splashscreen</h2>
+ <span>Show and hide the applications splash screen.</span>
+ </li>
+ <li>
+ <h2>Storage</h2>
+ <span>Hook into the devices native storage options.</span>
+ </li>
+ </ul>
+
+</div>
[09/12] Version 3.0.0rc1
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/directoryentry/directoryentry.md b/docs/en/3.0.0rc1/cordova/file/directoryentry/directoryentry.md
new file mode 100644
index 0000000..de01dd5
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/directoryentry/directoryentry.md
@@ -0,0 +1,390 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+DirectoryEntry
+==============
+
+This object represents a directory on a file system, as defined by the
+[W3C Directories and Systems](http://www.w3.org/TR/file-system-api/)
+specification.
+
+Properties
+----------
+
+- __isFile__: Always false. _(boolean)_
+- __isDirectory__: Always true. _(boolean)_
+- __name__: The name of the `DirectoryEntry`, excluding the path leading to it. _(DOMString)_
+- __fullPath__: The full absolute path from the root to the `DirectoryEntry`. _(DOMString)_
+
+__NOTE:__ The following attribute is defined by the W3C specification,
+but is _not_ supported:
+
+- __filesystem__: The file system on which the `DirectoryEntry` resides. _(FileSystem)_
+
+Methods
+-------
+
+The following methods can be invoked on a `DirectoryEntry` object:
+
+- __getMetadata__: Look up metadata about a directory.
+- __setMetadata__: Set metadata on a directory.
+- __moveTo__: Move a directory to a different location on the file system.
+- __copyTo__: Copy a directory to a different location on the file system.
+- __toURL__: Return a URL to help locate a directory.
+- __remove__: Delete a directory. The directory must be empty.
+- __getParent__: Look up the parent directory.
+- __createReader__: Create a new `DirectoryReader` that can read entries from a directory.
+- __getDirectory__: Create or look up a directory.
+- __getFile__: Create or look up a file.
+- __removeRecursively__: Delete a directory and all of its contents.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+getMetadata
+-----------
+
+Look up metadata about a directory.
+
+__Parameters:__
+
+- __successCallback__: A callback function to execute with a `Metadata` object. _(Function)_
+- __errorCallback__: A callback function to execute if an error occurs when retrieving the `Metadata`. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(metadata) {
+ console.log("Last Modified: " + metadata.modificationTime);
+ }
+
+ function fail(error) {
+ alert(error.code);
+ }
+
+ // Request the metadata object for this entry
+ entry.getMetadata(success, fail);
+
+setMetadata
+----------------
+
+Set metadata on a directory.
+__Currently works only on iOS.__ - this will set the extended attributes of a directory.
+
+__Parameters:__
+
+- __successCallback__: A callback that executes when the metadata is successfully set. _(Function)_
+- __errorCallback__: A callback that executes when the metadata fails to be set. _(Function)_
+- __metadataObject__: An object that contains the metadata's keys and values. _(Object)_
+
+__Quick Example__
+
+ function success() {
+ console.log("The metadata was successfully set.");
+ }
+
+ function fail() {
+ alert("There was an error in setting the metadata");
+ }
+
+ // Set the metadata
+ entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
+
+__iOS Quirk__
+
+- Only the `com.apple.MobileBackup` extended attribute is supported. Set the value to `1` to prevent the directory from being backed up to iCloud. Set the value to `0` to re-enable the directory to be backed up to iCloud.
+
+__Quick Example__
+
+ function setFolderMetadata(localFileSystem, subFolder, metadataKey, metadataValue)
+ {
+ var onSetMetadataWin = function() {
+ console.log("success setting metadata")
+ }
+ var onSetMetadataFail = function() {
+ console.log("error setting metadata")
+ }
+
+ var onGetDirectoryWin = function(parent) {
+ var data = {};
+ data[metadataKey] = metadataValue;
+ parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
+ }
+ var onGetDirectoryFail = function() {
+ console.log("error getting dir")
+ }
+
+ var onFSWin = function(fileSystem) {
+ fileSystem.root.getDirectory(subFolder, {create: true, exclusive: false}, onGetDirectoryWin, onGetDirectoryFail);
+ }
+
+ var onFSFail = function(evt) {
+ console.log(evt.target.error.code);
+ }
+
+ window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
+ }
+
+ setFolderMetadata(LocalFileSystem.PERSISTENT, "Backups", "com.apple.MobileBackup", 1);
+
+moveTo
+------
+
+Move a directory to a different location on the file system. An error results if the app attempts to:
+
+- move a directory inside itself or to any child at any depth.
+- move a directory into its parent if a name different from its current directory is not provided.
+- move a directory to a path occupied by a file.
+- move a directory to a path occupied by a directory that is not empty.
+
+Moving a directory on top of an existing empty directory attempts to
+delete and replace that directory.
+
+__Parameters:__
+
+- __parent__: The parent directory to which to move the directory. _(DirectoryEntry)_
+- __newName__: The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
+- __successCallback__: A callback that executes with the `DirectoryEntry` object for the new directory. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to move the directory. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(entry) {
+ console.log("New Path: " + entry.fullPath);
+ }
+
+ function fail(error) {
+ alert(error.code);
+ }
+
+ function moveDir(entry) {
+ var parent = document.getElementById('parent').value,
+ parentName = parent.substring(parent.lastIndexOf('/')+1),
+ newName = document.getElementById('newName').value,
+ parentEntry = new DirectoryEntry(parentName, parent);
+
+ // move the directory to a new directory and rename it
+ entry.moveTo(parentEntry, newName, success, fail);
+ }
+
+copyTo
+------
+
+Copy a directory to a different location on the file system. An error results if the app attempts to:
+
+- copy a directory inside itself at any depth.
+- copy a directory into its parent if a name different from its current directory is not provided.
+
+Directory copies are always recursive, and copy all contents of the directory.
+
+__Parameters:__
+
+- __parent__: The parent directory to which to copy the directory. _(DirectoryEntry)_
+- __newName__: The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
+- __successCallback__: A callback that executes with the `DirectoryEntry` object for the new directory. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to copy the underlying directory. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function win(entry) {
+ console.log("New Path: " + entry.fullPath);
+ }
+
+ function fail(error) {
+ alert(error.code);
+ }
+
+ function copyDir(entry) {
+ var parent = document.getElementById('parent').value,
+ parentName = parent.substring(parent.lastIndexOf('/')+1),
+ newName = document.getElementById('newName').value,
+ parentEntry = new DirectoryEntry(parentName, parent);
+
+ // copy the directory to a new directory and rename it
+ entry.copyTo(parentEntry, newName, success, fail);
+ }
+
+toURL
+-----
+
+Returns a URL that can be used to locate the directory.
+
+__Quick Example__
+
+ // Get the URL for this directory
+ var dirURL = entry.toURL();
+ console.log(dirURL);
+
+remove
+------
+
+Deletes a directory. An error results if the app attempts to:
+
+- delete a directory that is not empty.
+- delete the root directory of a filesystem.
+
+__Parameters:__
+
+- __successCallback__: A callback that executes after the directory is deleted. Invoked with no parameters. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to delete the directory. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(entry) {
+ console.log("Removal succeeded");
+ }
+
+ function fail(error) {
+ alert('Error removing directory: ' + error.code);
+ }
+
+ // remove this directory
+ entry.remove(success, fail);
+
+getParent
+---------
+
+Look up the parent `DirectoryEntry` containing the directory.
+
+__Parameters:__
+
+- __successCallback__: A callback that is passed the directory's parent `DirectoryEntry`. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to retrieve the parent `DirectoryEntry`. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(parent) {
+ console.log("Parent Name: " + parent.name);
+ }
+
+ function fail(error) {
+ alert('Failed to get parent directory: ' + error.code);
+ }
+
+ // Get the parent DirectoryEntry
+ entry.getParent(success, fail);
+
+createReader
+------------
+
+Creates a new DirectoryReader to read entries in a directory.
+
+__Quick Example__
+
+ // create a directory reader
+ var directoryReader = entry.createReader();
+
+getDirectory
+------------
+
+Creates or looks up an existing directory. An error results if the app attempts to:
+
+- create a directory whose immediate parent does not yet exist.
+
+__Parameters:__
+
+- __path__: The path to the directory to be looked up or created. Either an absolute path, or a relative path from this `DirectoryEntry`. _(DOMString)_
+- __options__: Options to specify whether the directory is to be created if it doesn't exist. _(Flags)_
+- __successCallback__: A callback that executes with a `DirectoryEntry` object. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when creating or looking up the directory. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(parent) {
+ console.log("Parent Name: " + parent.name);
+ }
+
+ function fail(error) {
+ alert("Unable to create new directory: " + error.code);
+ }
+
+ // Retrieve an existing directory, or create it if it does not already exist
+ entry.getDirectory("newDir", {create: true, exclusive: false}, success, fail);
+
+getFile
+-------
+
+Creates or looks up a file. An error results if the app attempts to:
+
+- create a file whose immediate parent does not yet exist.
+
+__Parameters:__
+
+- __path__: The path to the file to be looked up or created. Either an absolute path, or a relative path from this `DirectoryEntry`. _(DOMString)_
+- __options__: Options to specify whether the file is created if it doesn't exist. _(Flags)_
+- __successCallback__: A callback that is passed a `FileEntry` object. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when creating or looking up the file. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(parent) {
+ console.log("Parent Name: " + parent.name);
+ }
+
+ function fail(error) {
+ alert("Failed to retrieve file: " + error.code);
+ }
+
+ // Retrieve an existing file, or create it if it does not exist
+ entry.getFile("newFile.txt", {create: true, exclusive: false}, success, fail);
+
+removeRecursively
+-----------------
+
+Deletes a directory and all of its contents. In the event of an error (such as trying to delete
+a directory containing a file that cannot be removed), some of the contents of the directory may
+be deleted. An error results if the app attempts to:
+
+- delete the root directory of a filesystem.
+
+__Parameters:__
+
+- __successCallback__: A callback that executes after the `DirectoryEntry` has been deleted. Invoked with no parameters. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to delete the `DirectoryEntry`. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(parent) {
+ console.log("Remove Recursively Succeeded");
+ }
+
+ function fail(error) {
+ alert("Failed to remove directory or it's contents: " + error.code);
+ }
+
+ // remove the directory and all it's contents
+ entry.removeRecursively(success, fail);
+
+BlackBerry Quirks
+-----------------
+
+May fail with a `ControlledAccessException` in the following cases:
+
+- An app attempts to access a directory created by a previous installation of the app.
+
+> Solution: ensure temporary directories are cleaned manually, or by the application prior to reinstallation.
+
+- If the device is connected by USB.
+
+> Solution: disconnect the USB cable from the device and run again.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/directoryreader/directoryreader.md b/docs/en/3.0.0rc1/cordova/file/directoryreader/directoryreader.md
new file mode 100644
index 0000000..b37edb9
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/directoryreader/directoryreader.md
@@ -0,0 +1,69 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+DirectoryReader
+===============
+
+An object that lists files and directories within a directory, as
+defined in the
+[W3C Directories and Systems](http://www.w3.org/TR/file-system-api/)
+specification.
+
+Methods
+-------
+
+- __readEntries__: Read the entries in a directory.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+readEntries
+-----------
+
+Read the entries in this directory.
+
+__Parameters:__
+
+- __successCallback__: A callback that is passed an array of `FileEntry` and `DirectoryEntry` objects. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when retrieving the directory listing. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(entries) {
+ var i;
+ for (i=0; i<entries.length; i++) {
+ console.log(entries[i].name);
+ }
+ }
+
+ function fail(error) {
+ alert("Failed to list directory contents: " + error.code);
+ }
+
+ // Get a directory reader
+ var directoryReader = dirEntry.createReader();
+
+ // Get a list of all the entries in the directory
+ directoryReader.readEntries(success,fail);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/file.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/file.md b/docs/en/3.0.0rc1/cordova/file/file.md
new file mode 100644
index 0000000..52c24ba
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/file.md
@@ -0,0 +1,83 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+File
+==========
+
+> An API to read, write and navigate file system hierarchies, based on the [W3C File API](http://www.w3.org/TR/FileAPI).
+
+Objects
+-------
+
+- DirectoryEntry
+- DirectoryReader
+- File
+- FileEntry
+- FileError
+- FileReader
+- FileSystem
+- FileTransfer
+- FileTransferError
+- FileUploadOptions
+- FileUploadResult
+- FileWriter
+- Flags
+- LocalFileSystem
+- Metadata
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="File" value="org.apache.cordova.FileUtils" />
+ <plugin name="FileTransfer" value="org.apache.cordova.FileTransfer" />
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="File" value="org.apache.cordova.file.FileManager" />
+ <plugin name="FileTransfer" value="org.apache.cordova.http.FileTransfer" />
+
+#### www/config.xml
+
+ <feature id="blackberry.io.file" required="true" version="1.0.0.0" />
+ <feature id="blackberry.utils" required="true" version="1.0.0.0" />
+ <feature id="blackberry.io.dir" required="true" version="1.0.0.0" />
+ <rim:permissions>
+ <rim:permit>access_shared</rim:permit>
+ </rim:permissions>
+
+### iOS
+
+#### config.xml
+
+ <plugin name="File" value="CDVFile" />
+ <plugin name="FileTransfer" value="CDVFileTransfer" />
+
+### Windows Phone
+
+ No permissions are required.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/fileentry/fileentry.md b/docs/en/3.0.0rc1/cordova/file/fileentry/fileentry.md
new file mode 100644
index 0000000..f362833
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/fileentry/fileentry.md
@@ -0,0 +1,323 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+FileEntry
+==========
+
+Represents a file on a file system, as defined in the
+[W3C Directories and Systems](http://www.w3.org/TR/file-system-api/)
+specification.
+
+Properties
+----------
+
+- __isFile__: Always true. _(boolean)_
+- __isDirectory__: Always false. _(boolean)_
+- __name__: The name of the `FileEntry`, excluding the path leading to it. _(DOMString)_
+- __fullPath__: The full absolute path from the root to the `FileEntry`. _(DOMString)_
+
+__NOTE:__ The following attribute is defined by the W3C specification,
+but is _not_ supported:
+
+- __filesystem__: The file system on which the `FileEntry` resides. _(FileSystem)_
+
+Methods
+-------
+
+- __getMetadata__: Look up metadata about a file.
+- __setMetadata__: Set metadata on a file.
+- __moveTo__: Move a file to a different location on the file system.
+- __copyTo__: Copy a file to a different location on the file system.
+- __toURL__: Return a URL that can be used to locate a file.
+- __remove__: Delete a file.
+- __getParent__: Look up the parent directory.
+- __createWriter__: Creates a `FileWriter` object that can be used to write to a file.
+- __file__: Creates a `File` object containing file properties.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+getMetadata
+----------------
+
+Look up metadata about a file.
+
+__Parameters:__
+
+- __successCallback__: A callback that is passed a `Metadata` object. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when retrieving the `Metadata`. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(metadata) {
+ console.log("Last Modified: " + metadata.modificationTime);
+ }
+
+ function fail(error) {
+ alert(error.code);
+ }
+
+ // Request the metadata object for this entry
+ entry.getMetadata(success, fail);
+
+setMetadata
+----------------
+
+Set metadata on a file.
+
+__Currently works only on iOS.__
+- this will set the extended attributes of a file.
+
+__Parameters:__
+
+- __successCallback__: A callback that executes when the metadata is set. _(Function)_
+- __errorCallback__: A callback that executes when the metadata is not successfully set. _(Function)_
+- __metadataObject__: An object that contains the metadata's keys and values. _(Object)_
+
+__Quick Example__
+
+ function success() {
+ console.log("The metadata was successfully set.");
+ }
+
+ function fail() {
+ alert("There was an error in setting the metadata");
+ }
+
+ // Set the metadata
+ entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
+
+__iOS Quirk__
+
+- Only the `com.apple.MobileBackup` extended attribute is supported. Set the value to `1` to prevent the file from being backed up to iCloud. Set the value to `0` to re-enable the file to be backed up to iCloud.
+
+__Quick Example__
+
+ function setFileMetadata(localFileSystem, filePath, metadataKey, metadataValue)
+ {
+ var onSetMetadataWin = function() {
+ console.log("success setting metadata")
+ }
+ var onSetMetadataFail = function() {
+ console.log("error setting metadata")
+ }
+
+ var onGetFileWin = function(parent) {
+ var data = {};
+ data[metadataKey] = metadataValue;
+ parent.setMetadata(onSetMetadataWin, onSetMetadataFail, data);
+ }
+ var onGetFileFail = function() {
+ console.log("error getting file")
+ }
+
+ var onFSWin = function(fileSystem) {
+ fileSystem.root.getFile(filePath, {create: true, exclusive: false}, onGetFileWin, onGetFileFail);
+ }
+
+ var onFSFail = function(evt) {
+ console.log(evt.target.error.code);
+ }
+
+ window.requestFileSystem(localFileSystem, 0, onFSWin, onFSFail);
+ }
+
+ setFileMetadata(LocalFileSystem.PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1);
+
+moveTo
+------
+
+Move a file to a different location on the file system. An error
+results if the app attempts to:
+
+- move a file into its parent if a name different from its current one isn't provided;
+- move a file to a path occupied by a directory;
+
+In addition, moving a file on top of an existing file attempts to
+delete and replace that file.
+
+__Parameters:__
+
+- __parent__: The parent directory to which to move the file. _(DirectoryEntry)_
+- __newName__: The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
+- __successCallback__: A callback that is passed the new files `FileEntry` object. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to move the file. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(entry) {
+ console.log("New Path: " + entry.fullPath);
+ }
+
+ function fail(error) {
+ alert(error.code);
+ }
+
+ function moveFile(entry) {
+ var parent = document.getElementById('parent').value,
+ parentName = parent.substring(parent.lastIndexOf('/')+1),
+ parentEntry = new DirectoryEntry(parentName, parent);
+
+ // move the file to a new directory and rename it
+ entry.moveTo(parentEntry, "newFile.txt", success, fail);
+ }
+
+copyTo
+------
+
+Copy a file to a new location on the file system. An error results if
+the app attempts to:
+
+- copy a file into its parent if a name different from its current one is not provided.
+
+__Parameters:__
+
+- __parent__: The parent directory to which to copy the file. _(DirectoryEntry)_
+- __newName__: The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
+- __successCallback__: A callback that is passed the new file's `FileEntry` object. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to copy the file. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function win(entry) {
+ console.log("New Path: " + entry.fullPath);
+ }
+
+ function fail(error) {
+ alert(error.code);
+ }
+
+ function copyFile(entry) {
+ var parent = document.getElementById('parent').value,
+ parentName = parent.substring(parent.lastIndexOf('/')+1),
+ parentEntry = new DirectoryEntry(parentName, parent);
+
+ // copy the file to a new directory and rename it
+ entry.copyTo(parentEntry, "file.copy", success, fail);
+ }
+
+toURL
+-----
+
+Returns a URL that can be used to locate the file.
+
+__Quick Example__
+
+ // Request the URL for this entry
+ var fileURL = entry.toURL();
+ console.log(fileURL);
+
+remove
+------
+
+Deletes a file.
+
+__Parameters:__
+
+- __successCallback__: A callback that executes after the file has been deleted. Invoked with no parameters. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to delete the file. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(entry) {
+ console.log("Removal succeeded");
+ }
+
+ function fail(error) {
+ alert('Error removing file: ' + error.code);
+ }
+
+ // remove the file
+ entry.remove(success, fail);
+
+getParent
+---------
+
+Look up the parent `DirectoryEntry` containing the file.
+
+__Parameters:__
+
+- __successCallback__: A callback that is passed the file's parent `DirectoryEntry`. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when attempting to retrieve the parent `DirectoryEntry`. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(parent) {
+ console.log("Parent Name: " + parent.name);
+ }
+
+ function fail(error) {
+ alert(error.code);
+ }
+
+ // Get the parent DirectoryEntry
+ entry.getParent(success, fail);
+
+createWriter
+------------
+
+Create a `FileWriter` object associated with the file represented by the `FileEntry`.
+
+__Parameters:__
+
+- __successCallback__: A callback that is passed a `FileWriter` object. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs while attempting to create the FileWriter. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(writer) {
+ writer.write("Some text to the file");
+ }
+
+ function fail(error) {
+ alert(error.code);
+ }
+
+ // create a FileWriter to write to the file
+ entry.createWriter(success, fail);
+
+file
+----
+
+Return a `File` object that represents the current state of the file
+that this `FileEntry` represents.
+
+__Parameters:__
+
+- __successCallback__: A callback that is passed a `File` object. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when creating the `File` object, such as when the file no longer exists. Invoked with a `FileError` object. _(Function)_
+
+__Quick Example__
+
+ function success(file) {
+ console.log("File size: " + file.size);
+ }
+
+ function fail(error) {
+ alert("Unable to retrieve file properties: " + error.code);
+ }
+
+ // obtain properties of a file
+ entry.file(success, fail);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/fileerror/fileerror.md b/docs/en/3.0.0rc1/cordova/file/fileerror/fileerror.md
new file mode 100644
index 0000000..c34c6be
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/fileerror/fileerror.md
@@ -0,0 +1,51 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+FileError
+========
+
+A `FileError` object is set when an error occurs in any of the File API methods.
+
+Properties
+----------
+
+- __code__: One of the predefined error codes listed below.
+
+Constants
+---------
+
+- `FileError.NOT_FOUND_ERR`
+- `FileError.SECURITY_ERR`
+- `FileError.ABORT_ERR`
+- `FileError.NOT_READABLE_ERR`
+- `FileError.ENCODING_ERR`
+- `FileError.NO_MODIFICATION_ALLOWED_ERR`
+- `FileError.INVALID_STATE_ERR`
+- `FileError.SYNTAX_ERR`
+- `FileError.INVALID_MODIFICATION_ERR`
+- `FileError.QUOTA_EXCEEDED_ERR`
+- `FileError.TYPE_MISMATCH_ERR`
+- `FileError.PATH_EXISTS_ERR`
+
+Description
+-----------
+
+The `FileError` object is the only parameter provided to any of the
+File API's error callbacks. To determine the type of error, compare
+its `code` property to any of the listings above.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/fileobj/fileobj.md b/docs/en/3.0.0rc1/cordova/file/fileobj/fileobj.md
new file mode 100644
index 0000000..0825889
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/fileobj/fileobj.md
@@ -0,0 +1,83 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+File
+====
+
+This object contains attributes of a single file.
+
+Properties
+----------
+
+- __name__: The name of the file. _(DOMString)_
+- __fullPath__: The full path of the file including the file name. _(DOMString)_
+- __type__: The mime type of the file. _(DOMString)_
+- __lastModifiedDate__: The last time the file was modified. _(Date)_
+- __size__: The size of the file in bytes. _(long)_
+
+Methods
+-------
+
+- __slice__: Select only a portion of the file to be read.
+
+Details
+-------
+
+The `File` object contains attributes of a single file. You can get
+an instance of a `File` object by calling a `FileEntry` object's
+`file()` method.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+slice
+--------------
+
+Return a new `File` object, for which `FileReader` returns only the
+specified portion of the file. Negative values for `start` or `end`
+are measured from the end of the file. Indexes are positioned
+relative to the current slice. (See the full example below.)
+
+__Parameters:__
+
+- __start__: The index of the first byte to read, inclusive.
+- __end__: The index of the byte after the last one to read.
+
+__Quick Example__
+
+ var slicedFile = file.slice(10, 30);
+
+__Full Example__
+
+ var slice1 = file.slice(100, 400);
+ var slice2 = slice1.slice(20, 35);
+
+ var slice3 = file.slice(120, 135);
+ // slice2 and slice3 are equivalent.
+
+__Supported Platforms__
+
+- Android
+- iOS
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/filereader/filereader.md b/docs/en/3.0.0rc1/cordova/file/filereader/filereader.md
new file mode 100644
index 0000000..19d408d
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/filereader/filereader.md
@@ -0,0 +1,259 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+FileReader
+==========
+
+The `FileReader` allows basic access to a file.
+
+Properties
+----------
+
+- __readyState__: One of the reader's three possible states, either `EMPTY`, `LOADING` or `DONE`.
+- __result__: The contents of the file that have been read. _(DOMString)_
+- __error__: An object containing errors. _(FileError)_
+- __onloadstart__: Called when the read starts. _(Function)_
+- __onload__: Called when the read has successfully completed. _(Function)_
+- __onabort__: Called when the read has been aborted. For instance, by invoking the `abort()` method. _(Function)_
+- __onerror__: Called when the read has failed. _(Function)_
+- __onloadend__: Called when the request has completed (either in success or failure). _(Function)_
+
+__NOTE:__ The following porperty is not supported:
+
+- __onprogress__: Called while reading the file, reporting progress in terms of `progress.loaded`/`progress.total`. _(Function)_
+
+Methods
+-------
+
+- __abort__: Aborts reading file.
+- __readAsDataURL__: Read file and return data as a base64-encoded data URL.
+- __readAsText__: Reads text file.
+- __readAsBinaryString__: Reads file as binary and returns a binary string.
+- __readAsArrayBuffer__: Reads file as an `ArrayBuffer`.
+
+Details
+-------
+
+The `FileReader` object offers a way to read files from the device's
+file system. Files can be read as text or as a base64 data-encoded
+string. Event listeners receive the `loadstart`, `progress`, `load`,
+`loadend`, `error`, and `abort` events.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Read As Data URL
+----------------
+
+__Parameters:__
+
+- __file__: the file object to read.
+
+Quick Example
+-------------
+
+ function win(file) {
+ var reader = new FileReader();
+ reader.onloadend = function (evt) {
+ console.log("read success");
+ console.log(evt.target.result);
+ };
+ reader.readAsDataURL(file);
+ };
+
+ var fail = function (evt) {
+ console.log(error.code);
+ };
+
+ entry.file(win, fail);
+
+Read As Text
+------------
+
+__Parameters:__
+
+- __file__: the file object to read.
+- __encoding__: the encoding to use to encode the file's content. Default is UTF8.
+
+Quick Example
+-------------
+
+ function win(file) {
+ var reader = new FileReader();
+ reader.onloadend = function (evt) {
+ console.log("read success");
+ console.log(evt.target.result);
+ };
+ reader.readAsText(file);
+ };
+
+ var fail = function (evt) {
+ console.log(error.code);
+ };
+
+ entry.file(win, fail);
+
+Abort Quick Example
+-------------------
+
+ function win(file) {
+ var reader = new FileReader();
+ reader.onloadend = function(evt) {
+ console.log("read success");
+ console.log(evt.target.result);
+ };
+ reader.readAsText(file);
+ reader.abort();
+ };
+
+ function fail(error) {
+ console.log(error.code);
+ }
+
+ entry.file(win, fail);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>FileReader Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
+ }
+
+ function gotFS(fileSystem) {
+ fileSystem.root.getFile("readme.txt", null, gotFileEntry, fail);
+ }
+
+ function gotFileEntry(fileEntry) {
+ fileEntry.file(gotFile, fail);
+ }
+
+ function gotFile(file){
+ readDataUrl(file);
+ readAsText(file);
+ }
+
+ function readDataUrl(file) {
+ var reader = new FileReader();
+ reader.onloadend = function(evt) {
+ console.log("Read as data URL");
+ console.log(evt.target.result);
+ };
+ reader.readAsDataURL(file);
+ }
+
+ function readAsText(file) {
+ var reader = new FileReader();
+ reader.onloadend = function(evt) {
+ console.log("Read as text");
+ console.log(evt.target.result);
+ };
+ reader.readAsText(file);
+ }
+
+ function fail(evt) {
+ console.log(evt.target.error.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Read File</p>
+ </body>
+ </html>
+
+iOS Quirks
+----------
+- The __encoding__ parameter is not supported, and UTF8 encoding is always in effect.
+
+Read As Binary String
+---------------------
+
+Currently supported on iOS and Android only.
+
+__Parameters:__
+
+- __file__: the file object to read.
+
+Quick Example
+-------------
+
+ function win(file) {
+ var reader = new FileReader();
+ reader.onloadend = function (evt) {
+ console.log("read success");
+ console.log(evt.target.result);
+ };
+ reader.readAsBinaryString(file);
+ };
+
+ var fail = function (evt) {
+ console.log(error.code);
+ };
+
+ entry.file(win, fail);
+
+Read As Array Buffer
+--------------------
+
+Currently supported on iOS and Android only.
+
+__Parameters:__
+
+- __file__: the file object to read.
+
+Quick Example
+-------------
+
+ function win(file) {
+ var reader = new FileReader();
+ reader.onloadend = function (evt) {
+ console.log("read success");
+ console.log(new Uint8Array(evt.target.result));
+ };
+ reader.readAsArrayBuffer(file);
+ };
+
+ var fail = function (evt) {
+ console.log(error.code);
+ };
+
+ entry.file(win, fail);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/filesystem/filesystem.md b/docs/en/3.0.0rc1/cordova/file/filesystem/filesystem.md
new file mode 100644
index 0000000..d3abc80
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/filesystem/filesystem.md
@@ -0,0 +1,95 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+FileSystem
+==========
+
+This object represents a file system.
+
+Properties
+----------
+
+- __name__: The name of the file system. _(DOMString)_
+- __root__: The root directory of the file system. _(DirectoryEntry)_
+
+Details
+-------
+
+The `FileSystem` object represents information about the file system.
+The name of the file system is unique across the list of exposed
+file systems. The root property contains a `DirectoryEntry` object
+that represents the file system's root directory.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+File System Quick Example
+-------------------------
+
+ function onSuccess(fileSystem) {
+ console.log(fileSystem.name);
+ console.log(fileSystem.root.name);
+ }
+
+ // request the persistent file system
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, null);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>File System Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
+ }
+
+ function onFileSystemSuccess(fileSystem) {
+ console.log(fileSystem.name);
+ console.log(fileSystem.root.name);
+ }
+
+ function fail(evt) {
+ console.log(evt.target.error.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>File System</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/filetransfer/filetransfer.md b/docs/en/3.0.0rc1/cordova/file/filetransfer/filetransfer.md
new file mode 100644
index 0000000..403990a
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/filetransfer/filetransfer.md
@@ -0,0 +1,303 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+FileTransfer
+==========
+
+The `FileTransfer` object allows you to upload or download files to
+and from a server.
+
+Properties
+----------
+
+- __onprogress__: Called with a `ProgressEvent` whenever a new chunk of data is transferred. _(Function)_
+
+Methods
+-------
+
+- __upload__: sends a file to a server.
+- __download__: downloads a file from server.
+- __abort__: Aborts an in-progress transfer.
+
+Details
+-------
+
+The `FileTransfer` object provides a way to upload files to a remote
+server using an HTTP multi-part POST request. Both HTTP and HTTPS
+protocols are supported. Optional parameters can be specified by
+passing a `FileUploadOptions` object to the `upload()` method. On
+successful upload, a `FileUploadResult` object is passed to the
+success callback. If an error occurs, a `FileTransferError` object is
+passed to the error callback. It is also possible (only on iOS and
+Android) to download a file from a remote server and save it on the
+device.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+upload
+--------------
+
+__Parameters:__
+
+- __filePath__: Full path of the file on the device.
+- __server__: URL of the server to receive the file, as encoded by `encodeURI()`.
+- __successCallback__: A callback that is passed a `Metadata` object. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs retrieving the `Metadata`. Invoked with a `FileTransferError` object. _(Function)_
+- __options__: Optional parameters such as file name and mimetype.
+- __trustAllHosts__: Optional parameter, defaults to `false`. If set to true, it accepts all security certificates. This is useful since Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
+
+__Quick Example__
+
+ // !! Assumes variable fileURI contains a valid URI to a text file on the device
+
+ var win = function (r) {
+ console.log("Code = " + r.responseCode);
+ console.log("Response = " + r.response);
+ console.log("Sent = " + r.bytesSent);
+ }
+
+ var fail = function (error) {
+ alert("An error has occurred: Code = " + error.code);
+ console.log("upload error source " + error.source);
+ console.log("upload error target " + error.target);
+ }
+
+ var options = new FileUploadOptions();
+ options.fileKey = "file";
+ options.fileName = fileURI.substr(fileURI.lastIndexOf('/') + 1);
+ options.mimeType = "text/plain";
+
+ var params = {};
+ params.value1 = "test";
+ params.value2 = "param";
+
+ options.params = params;
+
+ var ft = new FileTransfer();
+ ft.upload(fileURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
+
+__Full Example__
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>File Transfer Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Retrieve image file location from specified source
+ navigator.camera.getPicture(
+ uploadPhoto,
+ function(message) { alert('get picture failed'); },
+ {
+ quality : 50,
+ destinationType : navigator.camera.DestinationType.FILE_URI,
+ sourceType : navigator.camera.PictureSourceType.PHOTOLIBRARY
+ }
+ );
+ }
+
+ function uploadPhoto(imageURI) {
+ var options = new FileUploadOptions();
+ options.fileKey="file";
+ options.fileName=imageURI.substr(imageURI.lastIndexOf('/')+1);
+ options.mimeType="image/jpeg";
+
+ var params = {};
+ params.value1 = "test";
+ params.value2 = "param";
+
+ options.params = params;
+
+ var ft = new FileTransfer();
+ ft.upload(imageURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
+ }
+
+ function win(r) {
+ console.log("Code = " + r.responseCode);
+ console.log("Response = " + r.response);
+ console.log("Sent = " + r.bytesSent);
+ }
+
+ function fail(error) {
+ alert("An error has occurred: Code = " + error.code);
+ console.log("upload error source " + error.source);
+ console.log("upload error target " + error.target);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Upload File</p>
+ </body>
+ </html>
+
+__Setting Upload Headers__
+
+Supported on Android and iOS
+
+ function win(r) {
+ console.log("Code = " + r.responseCode);
+ console.log("Response = " + r.response);
+ console.log("Sent = " + r.bytesSent);
+ }
+
+ function fail(error) {
+ alert("An error has occurred: Code = " + error.code);
+ console.log("upload error source " + error.source);
+ console.log("upload error target " + error.target);
+ }
+
+ var uri = encodeURI("http://some.server.com/upload.php");
+
+ var options = new FileUploadOptions();
+ options.fileKey="file";
+ options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
+ options.mimeType="text/plain";
+
+ var headers={'headerParam':'headerValue'};
+
+ options.headers = headers;
+
+ var ft = new FileTransfer();
+ ft.upload(fileURI, uri, win, fail, options);
+
+__Android Quirks__
+
+Set the `chunkedMode` option to `false` to prevent problems uploading
+to a Nginx server.
+
+download
+--------------
+
+__Parameters:__
+
+- __source__: URL of the server to download the file, as encoded by `encodeURI()`.
+- __target__: Full path of the file on the device.
+- __successCallback__: A callback that is passed a `FileEntry` object. _(Function)_
+- __errorCallback__: A callback that executes if an error occurs when retrieving the `Metadata`. Invoked with a `FileTransferError` object. _(Function)_
+- __trustAllHosts__: Optional parameter, defaults to `false`. If set to `true` then it will accept all security certificates. This is useful as Android rejects self signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
+- __options__: Optional parameters, currently only supports headers (such as Authorization (Basic Authentication), etc).
+
+__Quick Example__
+
+ // !! Assumes filePath is a valid path on the device
+
+ var fileTransfer = new FileTransfer();
+ var uri = encodeURI("http://some.server.com/download.php");
+
+ fileTransfer.download(
+ uri,
+ filePath,
+ function(entry) {
+ console.log("download complete: " + entry.fullPath);
+ },
+ function(error) {
+ console.log("download error source " + error.source);
+ console.log("download error target " + error.target);
+ console.log("upload error code" + error.code);
+ },
+ false,
+ {
+ headers: {
+ "Authorization": "Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=="
+ }
+ }
+ );
+
+abort
+--------------
+
+Aborts an in-progress transfer. The onerror callback is passed a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
+
+__Supported Platforms__
+
+- Android
+- iOS
+
+__Quick Example__
+
+ // !! Assumes variable fileURI contains a valid URI to a text file on the device
+
+ var win = function(r) {
+ console.log("Code = " + r.responseCode);
+ console.log("Response = " + r.response);
+ console.log("Sent = " + r.bytesSent);
+ }
+
+ var fail = function(error) {
+ alert("An error has occurred: Code = " + error.code);
+ console.log("upload error source " + error.source);
+ console.log("upload error target " + error.target);
+ }
+
+ var options = new FileUploadOptions();
+ options.fileKey="file";
+ options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
+ options.mimeType="text/plain";
+
+ var params = {};
+ params.value1 = "test";
+ params.value2 = "param";
+
+ options.params = params;
+
+ var ft = new FileTransfer();
+ ft.upload(fileURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
+ ft.abort(win, fail);
+
+onprogress
+--------------
+
+Called with a ProgressEvent whenever a new chunk of data is transferred.
+
+__Supported Platforms__
+
+- Android
+- iOS
+
+__Example__
+
+ fileTransfer.onprogress = function(progressEvent) {
+ if (progressEvent.lengthComputable) {
+ loadingStatus.setPercentage(progressEvent.loaded / progressEvent.total);
+ } else {
+ loadingStatus.increment();
+ }
+ };
+ fileTransfer.download(...); // or fileTransfer.upload(...);
+
+__Quirks__
+- On both Android an iOS, lengthComputable is false for downloads that use gzip encoding.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/filetransfererror/filetransfererror.md b/docs/en/3.0.0rc1/cordova/file/filetransfererror/filetransfererror.md
new file mode 100644
index 0000000..abb135f
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/filetransfererror/filetransfererror.md
@@ -0,0 +1,45 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+FileTransferError
+========
+
+A `FileTransferError` object is passed to an error callback when an error occurs.
+
+Properties
+----------
+
+- __code__: One of the predefined error codes listed below. (Number)
+- __source__: URI to the source. (String)
+- __target__: URI to the target. (String)
+- __http_status__: HTTP status code. This attribute is only available when a response code is received from the HTTP connection. (Number)
+
+Constants
+---------
+
+- `FileTransferError.FILE_NOT_FOUND_ERR`
+- `FileTransferError.INVALID_URL_ERR`
+- `FileTransferError.CONNECTION_ERR`
+- `FileTransferError.ABORT_ERR`
+
+Description
+-----------
+
+The `FileTransferError` object is passed to the error callback when an
+error occurs when uploading or downloading a file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/fileuploadoptions/fileuploadoptions.md b/docs/en/3.0.0rc1/cordova/file/fileuploadoptions/fileuploadoptions.md
new file mode 100644
index 0000000..e0e6fe2
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -0,0 +1,47 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+FileUploadOptions
+========
+
+A `FileUploadOptions` object can be passed to the `FileTransfer`
+object's `upload()` method to specify additional parameters to the
+upload script.
+
+Properties
+----------
+
+- __fileKey__: The name of the form element. Defaults to `file`. (DOMString)
+- __fileName__: The file name to use when saving the file on the server. Defaults to `image.jpg`. (DOMString)
+- __mimeType__: The mime type of the data to upload. Defaults to `image/jpeg`. (DOMString)
+- __params__: A set of optional key/value pairs to pass in the HTTP request. (Object)
+- __chunkedMode__: Whether to upload the data in chunked streaming mode. Defaults to `true`. (Boolean)
+- __headers__: A map of header name/header values. Use an array to specify more than one value. (Object)
+
+Description
+-----------
+
+A `FileUploadOptions` object can be passed to the `FileTransfer`
+object's `upload()` method to specify additional parameters to the
+upload script.
+
+WP7 Quirk
+---------
+
+- __chunkedMode:__: Ignored on WP7.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/fileuploadresult/fileuploadresult.md b/docs/en/3.0.0rc1/cordova/file/fileuploadresult/fileuploadresult.md
new file mode 100644
index 0000000..4d9305a
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/fileuploadresult/fileuploadresult.md
@@ -0,0 +1,42 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+FileUploadResult
+========
+
+A `FileUploadResult` object is passed to the success callback of the
+`FileTransfer` object's `upload()` method.
+
+Properties
+----------
+
+- __bytesSent__: The number of bytes sent to the server as part of the upload. (long)
+- __responseCode__: The HTTP response code returned by the server. (long)
+- __response__: The HTTP response returned by the server. (DOMString)
+
+Description
+-----------
+
+The `FileUploadResult` object is returned via the success callback of
+the `FileTransfer` object's `upload()` method.
+
+iOS Quirks
+----------
+
+- Does not support `responseCode` or `bytesSent`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/filewriter/filewriter.md b/docs/en/3.0.0rc1/cordova/file/filewriter/filewriter.md
new file mode 100644
index 0000000..8ab6a12
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/filewriter/filewriter.md
@@ -0,0 +1,233 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+FileWriter
+==========
+
+As object that allows you to create and write data to a file.
+
+Properties
+----------
+
+- __readyState__: One of the three possible states, either `INIT`, `WRITING`, or `DONE`.
+- __fileName__: The name of the file to be written. _(DOMString)_
+- __length__: The length of the file to be written. _(long)_
+- __position__: The current position of the file pointer. _(long)_
+- __error__: An object containing errors. _(FileError)_
+- __onwritestart__: Called when the write starts. _(Function)_
+- __onwrite__: Called when the request has completed successfully. _(Function)_
+- __onabort__: Called when the write has been aborted. For instance, by invoking the abort() method. _(Function)_
+- __onerror__: Called when the write has failed. _(Function)_
+- __onwriteend__: Called when the request has completed (either in success or failure). _(Function)_
+
+The following property is _not_ supported:
+
+- __onprogress__: Called while writing the file, reporting progress in terms of `progress.loaded`/`progress.total`. _(Function)_
+Methods
+-------
+
+- __abort__: Aborts writing the file.
+- __seek__: Moves the file pointer to the specified byte.
+- __truncate__: Shortens the file to the specified length.
+- __write__: Writes data to the file.
+
+Details
+-------
+
+The `FileWriter` object offers a way to write UTF-8 encoded files to
+the device file system. Applications respond to `writestart`,
+`progress`, `write`, `writeend`, `error`, and `abort` events.
+
+Each `FileWriter` corresponds to a single file, to which data can be
+written many times. The `FileWriter` maintains the file's `position`
+and `length` attributes, which allow the app to `seek` and `write`
+anywhere in the file. By default, the `FileWriter` writes to the
+beginning of the file, overwriting existing data. Set the optional
+`append` boolean to `true` in the `FileWriter`'s constructor to
+write to the end of the file.
+
+Text data is supported by all platforms listed below. Text is encoded as UTF-8 before being written to the filesystem. Some platforms also support binary data, which can be passed in as either an ArrayBuffer or a Blob.
+
+Supported Platforms
+-------------------
+
+Text and Binary Support:
+
+- Android
+- iOS
+
+Text-only Support:
+
+- BlackBerry WebWorks (OS 5.0 and higher)
+- Windows Phone 7 and 8
+- Windows 8
+
+Seek Quick Example
+------------------------------
+
+ function win(writer) {
+ // fast forwards file pointer to end of file
+ writer.seek(writer.length);
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
+
+ entry.createWriter(win, fail);
+
+Truncate Quick Example
+--------------------------
+
+ function win(writer) {
+ writer.truncate(10);
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
+
+ entry.createWriter(win, fail);
+
+Write Quick Example
+-------------------
+
+ function win(writer) {
+ writer.onwrite = function(evt) {
+ console.log("write success");
+ };
+ writer.write("some sample text");
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
+
+ entry.createWriter(win, fail);
+
+Binary Write Quick Example
+--------------------------
+
+ function win(writer) {
+ var data = new ArrayBuffer(5),
+ dataView = new Int8Array(data);
+ for (i=0; i < 5; i++) {
+ dataView[i] = i;
+ }
+ writer.onwrite = function(evt) {
+ console.log("write success");
+ };
+ writer.write(data);
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
+
+ entry.createWriter(win, fail);
+
+Append Quick Example
+--------------------
+
+ function win(writer) {
+ writer.onwrite = function(evt) {
+ console.log("write success");
+ };
+ writer.seek(writer.length);
+ writer.write("appended text");
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
+
+ entry.createWriter(win, fail);
+
+Abort Quick Example
+-------------------
+
+ function win(writer) {
+ writer.onwrite = function(evt) {
+ console.log("write success");
+ };
+ writer.write("some sample text");
+ writer.abort();
+ };
+
+ var fail = function(evt) {
+ console.log(error.code);
+ };
+
+ entry.createWriter(win, fail);
+
+Full Example
+------------
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>FileWriter Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
+ }
+
+ function gotFS(fileSystem) {
+ fileSystem.root.getFile("readme.txt", {create: true, exclusive: false}, gotFileEntry, fail);
+ }
+
+ function gotFileEntry(fileEntry) {
+ fileEntry.createWriter(gotFileWriter, fail);
+ }
+
+ function gotFileWriter(writer) {
+ writer.onwriteend = function(evt) {
+ console.log("contents of file now 'some sample text'");
+ writer.truncate(11);
+ writer.onwriteend = function(evt) {
+ console.log("contents of file now 'some sample'");
+ writer.seek(4);
+ writer.write(" different text");
+ writer.onwriteend = function(evt){
+ console.log("contents of file now 'some different text'");
+ }
+ };
+ };
+ writer.write("some sample text");
+ }
+
+ function fail(error) {
+ console.log(error.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Write File</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/flags/flags.md b/docs/en/3.0.0rc1/cordova/file/flags/flags.md
new file mode 100644
index 0000000..504f323
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/flags/flags.md
@@ -0,0 +1,49 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Flags
+=====
+
+Supplies arguments to the `DirectoryEntry` object's `getFile()` and
+`getDirectory()` methods, which look up or create files and
+directories, respectively.
+
+Properties
+----------
+
+- __create__: Indicates that the file or directory should be created if it does not already exist. _(boolean)_
+- __exclusive__: Has has no effect by itself, but when used with `create` causes the file or directory creation to fail if the target path already exists. _(boolean)_
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // Get the data directory, creating it if it doesn't exist.
+ dataDir = fileSystem.root.getDirectory("data", {create: true});
+
+ // Create the lock file, if and only if it doesn't exist.
+ lockFile = dataDir.getFile("lockfile.txt", {create: true, exclusive: true});
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/localfilesystem/localfilesystem.md b/docs/en/3.0.0rc1/cordova/file/localfilesystem/localfilesystem.md
new file mode 100644
index 0000000..099d4b2
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/localfilesystem/localfilesystem.md
@@ -0,0 +1,110 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+LocalFileSystem
+===============
+
+This object provides a way to obtain root file systems.
+
+Methods
+----------
+
+- __requestFileSystem__: Requests a filesystem. _(Function)_
+- __resolveLocalFileSystemURI__: Retrieve a `DirectoryEntry` or `FileEntry` using local URI. _(Function)_
+
+Constants
+---------
+
+- `LocalFileSystem.PERSISTENT`: Used for storage that should not be removed by the user agent without application or user permission.
+- `LocalFileSystem.TEMPORARY`: Used for storage with no guarantee of persistence.
+
+Details
+-------
+
+The `LocalFileSystem` object methods are defined on the `window` object.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Request File System Quick Example
+---------------------------------
+
+ function onSuccess(fileSystem) {
+ console.log(fileSystem.name);
+ }
+
+ // request the persistent file system
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);
+
+Resolve Local File System URI Quick Example
+-------------------------------------------
+
+ function onSuccess(fileEntry) {
+ console.log(fileEntry.name);
+ }
+
+ window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Local File System Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
+ window.resolveLocalFileSystemURI("file:///example.txt", onResolveSuccess, fail);
+ }
+
+ function onFileSystemSuccess(fileSystem) {
+ console.log(fileSystem.name);
+ }
+
+ function onResolveSuccess(fileEntry) {
+ console.log(fileEntry.name);
+ }
+
+ function fail(evt) {
+ console.log(evt.target.error.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Local File System</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/file/metadata/metadata.md b/docs/en/3.0.0rc1/cordova/file/metadata/metadata.md
new file mode 100644
index 0000000..bfa3a46
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/file/metadata/metadata.md
@@ -0,0 +1,54 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Metadata
+==========
+
+An interface that supplies information about the state of a file or directory.
+
+Properties
+----------
+
+- __modificationTime__: The time when the file or directory was last modified. _(Date)_
+
+Details
+-------
+
+The `Metadata` object represents information about the state of a file
+or directory. Calling a `DirectoryEntry` or `FileEntry` object's
+`getMetadata()` method results in a `Metadata` instance.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ function win(metadata) {
+ console.log("Last Modified: " + metadata.modificationTime);
+ }
+
+ // Request the metadata object for this entry
+ entry.getMetadata(win, null);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/geolocation/Coordinates/coordinates.md b/docs/en/3.0.0rc1/cordova/geolocation/Coordinates/coordinates.md
new file mode 100644
index 0000000..d44af4e
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/geolocation/Coordinates/coordinates.md
@@ -0,0 +1,126 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Coordinates
+===========
+
+A set of properties that describe the geographic coordinates of a position.
+
+Properties
+----------
+
+* __latitude__: Latitude in decimal degrees. _(Number)_
+* __longitude__: Longitude in decimal degrees. _(Number)_
+* __altitude__: Height of the position in meters above the ellipsoid. _(Number)_
+* __accuracy__: Accuracy level of the latitude and longitude coordinates in meters. _(Number)_
+* __altitudeAccuracy__: Accuracy level of the altitude coordinate in meters. _(Number)_
+* __heading__: Direction of travel, specified in degrees counting clockwise relative to the true north. _(Number)_
+* __speed__: Current ground speed of the device, specified in meters per second. _(Number)_
+
+Description
+-----------
+
+The `Coordinates` object is attached to the `Position` object that is
+available to callback functions in requests for the current position.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // onSuccess Callback
+ //
+ var onSuccess = function(position) {
+ alert('Latitude: ' + position.coords.latitude + '\n' +
+ 'Longitude: ' + position.coords.longitude + '\n' +
+ 'Altitude: ' + position.coords.altitude + '\n' +
+ 'Accuracy: ' + position.coords.accuracy + '\n' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
+ 'Heading: ' + position.coords.heading + '\n' +
+ 'Speed: ' + position.coords.speed + '\n' +
+ 'Timestamp: ' + position.timestamp + '\n');
+ };
+
+ // onError Callback
+ //
+ var onError = function() {
+ alert('onError!');
+ };
+
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Geolocation Position Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ }
+
+ // Display `Position` properties from the geolocation
+ //
+ function onSuccess(position) {
+ var div = document.getElementById('myDiv');
+
+ div.innerHTML = 'Latitude: ' + position.coords.latitude + '<br/>' +
+ 'Longitude: ' + position.coords.longitude + '<br/>' +
+ 'Altitude: ' + position.coords.altitude + '<br/>' +
+ 'Accuracy: ' + position.coords.accuracy + '<br/>' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br/>' +
+ 'Heading: ' + position.coords.heading + '<br/>' +
+ 'Speed: ' + position.coords.speed + '<br/>';
+ }
+
+ // Show an alert if there is a problem getting the geolocation
+ //
+ function onError() {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <div id="myDiv"></div>
+ </body>
+ </html>
+
+Android Quirks
+-------------
+
+__altitudeAccuracy__: Not supported by Android devices, returning `null`.
[08/12] Version 3.0.0rc1
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/geolocation/Position/position.md b/docs/en/3.0.0rc1/cordova/geolocation/Position/position.md
new file mode 100644
index 0000000..9d864dd
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/geolocation/Position/position.md
@@ -0,0 +1,118 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Position
+========
+
+Contains `Position` coordinates and timestamp, created by the geolocation API.
+
+Properties
+----------
+
+- __coords__: A set of geographic coordinates. _(Coordinates)_
+- __timestamp__: Creation timestamp for `coords`. _(Date)_
+
+Description
+-----------
+
+The `Position` object is created and populated by Cordova, and returned to the user through a callback function.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // onSuccess Callback
+ //
+ var onSuccess = function(position) {
+ alert('Latitude: ' + position.coords.latitude + '\n' +
+ 'Longitude: ' + position.coords.longitude + '\n' +
+ 'Altitude: ' + position.coords.altitude + '\n' +
+ 'Accuracy: ' + position.coords.accuracy + '\n' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
+ 'Heading: ' + position.coords.heading + '\n' +
+ 'Speed: ' + position.coords.speed + '\n' +
+ 'Timestamp: ' + position.timestamp + '\n');
+ };
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ }
+
+ // onSuccess Geolocation
+ //
+ function onSuccess(position) {
+ var element = document.getElementById('geolocation');
+ element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
+ 'Longitude: ' + position.coords.longitude + '<br />' +
+ 'Altitude: ' + position.coords.altitude + '<br />' +
+ 'Accuracy: ' + position.coords.accuracy + '<br />' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
+ 'Heading: ' + position.coords.heading + '<br />' +
+ 'Speed: ' + position.coords.speed + '<br />' +
+ 'Timestamp: ' + position.timestamp + '<br />';
+ }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="geolocation">Finding geolocation...</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/geolocation/PositionError/positionError.md b/docs/en/3.0.0rc1/cordova/geolocation/PositionError/positionError.md
new file mode 100755
index 0000000..07200d5
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/geolocation/PositionError/positionError.md
@@ -0,0 +1,60 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+PositionError
+========
+
+A `PositionError` object is passed to the `geolocationError` callback when an error occurs.
+
+Properties
+----------
+
+- __code__: One of the predefined error codes listed below.
+- __message__: Error message describing the details of the error encountered.
+
+Constants
+---------
+
+- `PositionError.PERMISSION_DENIED`
+- `PositionError.POSITION_UNAVAILABLE`
+- `PositionError.TIMEOUT`
+
+Description
+-----------
+
+The `PositionError` object is passed to the `geolocationError`
+callback function when an error occurs with geolocation.
+
+### `PositionError.PERMISSION_DENIED`
+
+Returned when the user does not allow your application to retrieve
+position information. This is dependent on the platform.
+
+### `PositionError.POSITION_UNAVAILABLE`
+
+Returned when the device is unable to retrieve a position. In general
+this means the device has no network connectivity and/or cannot get a
+satellite fix.
+
+### `PositionError.TIMEOUT`
+
+Returned when the device is unable to retrieve a position within the
+time specified in the `geolocationOptions`' `timeout` property. When
+used with `geolocation.watchPosition`, this error could be passed to
+the `geolocationError` callback every `timeout` milliseconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/geolocation/geolocation.clearWatch.md b/docs/en/3.0.0rc1/cordova/geolocation/geolocation.clearWatch.md
new file mode 100644
index 0000000..80509b9
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/geolocation/geolocation.clearWatch.md
@@ -0,0 +1,119 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+geolocation.clearWatch
+======================
+
+Stop watching for changes to the device's location referenced by the
+`watchID` parameter.
+
+ navigator.geolocation.clearWatch(watchID);
+
+Parameters
+----------
+
+- __watchID__: The id of the `watchPosition` interval to clear. (String)
+
+Description
+-----------
+
+The `geolocation.clearWatch` stops watching changes to the device's
+location by clearing the `geolocation.watchPosition` referenced by
+`watchID`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // Options: watch for changes in position, and use the most
+ // accurate position acquisition method available.
+ //
+ var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { enableHighAccuracy: true });
+
+ // ...later on...
+
+ navigator.geolocation.clearWatch(watchID);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ var watchID = null;
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Get the most accurate position updates available on the
+ // device.
+ var options = { enableHighAccuracy: true };
+ watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
+ }
+
+ // onSuccess Geolocation
+ //
+ function onSuccess(position) {
+ var element = document.getElementById('geolocation');
+ element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
+ 'Longitude: ' + position.coords.longitude + '<br />' +
+ '<hr />' + element.innerHTML;
+ }
+
+ // clear the watch that was started earlier
+ //
+ function clearWatch() {
+ if (watchID != null) {
+ navigator.geolocation.clearWatch(watchID);
+ watchID = null;
+ }
+ }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="geolocation">Watching geolocation...</p>
+ <button onclick="clearWatch();">Clear Watch</button>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/3.0.0rc1/cordova/geolocation/geolocation.getCurrentPosition.md
new file mode 100644
index 0000000..cb32f3f
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -0,0 +1,129 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+geolocation.getCurrentPosition
+==============================
+
+Returns the device's current position as a `Position` object.
+
+ navigator.geolocation.getCurrentPosition(geolocationSuccess,
+ [geolocationError],
+ [geolocationOptions]);
+
+Parameters
+----------
+
+- __geolocationSuccess__: The callback that is passed the current position.
+- __geolocationError__: _(Optional)_ The callback that executes if an error occurs.
+- __geolocationOptions__: _(Optional)_ The geolocation options.
+
+Description
+-----------
+
+`geolocation.getCurrentPosition` is an asynchronous function. It
+returns the device's current position to the `geolocationSuccess`
+callback with a `Position` object as the parameter. If there is an
+error, the `geolocationError` callback is passed a
+`PositionError` object.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // onSuccess Callback
+ // This method accepts a Position object, which contains the
+ // current GPS coordinates
+ //
+ var onSuccess = function(position) {
+ alert('Latitude: ' + position.coords.latitude + '\n' +
+ 'Longitude: ' + position.coords.longitude + '\n' +
+ 'Altitude: ' + position.coords.altitude + '\n' +
+ 'Accuracy: ' + position.coords.accuracy + '\n' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
+ 'Heading: ' + position.coords.heading + '\n' +
+ 'Speed: ' + position.coords.speed + '\n' +
+ 'Timestamp: ' + position.timestamp + '\n');
+ };
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ }
+
+ // onSuccess Geolocation
+ //
+ function onSuccess(position) {
+ var element = document.getElementById('geolocation');
+ element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
+ 'Longitude: ' + position.coords.longitude + '<br />' +
+ 'Altitude: ' + position.coords.altitude + '<br />' +
+ 'Accuracy: ' + position.coords.accuracy + '<br />' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
+ 'Heading: ' + position.coords.heading + '<br />' +
+ 'Speed: ' + position.coords.speed + '<br />' +
+ 'Timestamp: ' + position.timestamp + '<br />';
+ }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="geolocation">Finding geolocation...</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/geolocation/geolocation.md b/docs/en/3.0.0rc1/cordova/geolocation/geolocation.md
new file mode 100644
index 0000000..f2444c5
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/geolocation/geolocation.md
@@ -0,0 +1,104 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Geolocation
+===========
+
+> The `geolocation` object provides access to location data based on the device's GPS sensor or inferred from network signals.
+
+`Geolocation` provides information about the device's location, such as
+latitude and longitude. Common sources of location information include
+Global Positioning System (GPS) and location inferred from network
+signals such as IP address, RFID, WiFi and Bluetooth MAC addresses,
+and GSM/CDMA cell IDs. There is no guarantee that the API returns the
+device's actual location.
+
+This API is based on the
+[W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html),
+and only executes on devices that don't already provide an implementation.
+
+**Important privacy note:** Collection and use of geolocation data raises important privacy issues. Your app's privacy policy should discuss how the app uses geolocation data, whether it is shared with any other parties, and the level of precision of the data (for example, coarse, fine, ZIP code level, etc.). Geolocation data is generally considered sensitive because it can reveal a person's whereabouts and, if stored, the history of his or her travels. Therefore, in addition to your app's privacy policy, you should strongly consider providing a just-in-time notice prior to your app accessing geolocation data (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for "OK" and "No Thanks"). For more information, please see the Privacy Guide.
+
+Methods
+-------
+
+- geolocation.getCurrentPosition
+- geolocation.watchPosition
+- geolocation.clearWatch
+
+Arguments
+---------
+
+- geolocationSuccess
+- geolocationError
+- geolocationOptions
+
+Objects (Read-Only)
+-------------------
+
+- Position
+- PositionError
+- Coordinates
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Geolocation" value="org.apache.cordova.GeoBroker" />
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+ <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+ <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Geolocation" value="org.apache.cordova.geolocation.Geolocation" />
+
+#### www/config.xml
+
+ <rim:permissions>
+ <rim:permit>read_geolocation</rim:permit>
+ </rim:permissions>
+
+### iOS
+
+#### config.xml
+
+ <plugin name="Geolocation" value="CDVLocation" />
+
+### Windows Phone
+
+#### Properties/WPAppManifest.xml
+
+ <Capabilities>
+ <Capability Name="ID_CAP_LOCATION" />
+ </Capabilities>
+
+Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+
+### Tizen
+
+ No permissions are required.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/geolocation/geolocation.watchPosition.md b/docs/en/3.0.0rc1/cordova/geolocation/geolocation.watchPosition.md
new file mode 100644
index 0000000..08ec663
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/geolocation/geolocation.watchPosition.md
@@ -0,0 +1,132 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+geolocation.watchPosition
+=========================
+
+Watches for changes to the device's current position.
+
+ var watchId = navigator.geolocation.watchPosition(geolocationSuccess,
+ [geolocationError],
+ [geolocationOptions]);
+
+Parameters
+----------
+
+- __geolocationSuccess__: The callback that is passed the current position.
+- __geolocationError__: (Optional) The callback that executes if an error occurs.
+- __geolocationOptions__: (Optional) The geolocation options.
+
+Returns
+-------
+
+- __String__: returns a watch id that references the watch position interval. The watch id should be used with `geolocation.clearWatch` to stop watching for changes in position.
+
+Description
+-----------
+
+`geolocation.watchPosition` is an asynchronous function. It returns
+the device's current position when a change in position is detected.
+When the device retrieves a new location, the `geolocationSuccess`
+callback executes with a `Position` object as the parameter. If
+there is an error, the `geolocationError` callback executes with a
+`PositionError` object as the parameter.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // onSuccess Callback
+ // This method accepts a `Position` object, which contains
+ // the current GPS coordinates
+ //
+ function onSuccess(position) {
+ var element = document.getElementById('geolocation');
+ element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
+ 'Longitude: ' + position.coords.longitude + '<br />' +
+ '<hr />' + element.innerHTML;
+ }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Options: throw an error if no update is received every 30 seconds.
+ //
+ var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ var watchID = null;
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Throw an error if no update is received every 30 seconds
+ var options = { timeout: 30000 };
+ watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
+ }
+
+ // onSuccess Geolocation
+ //
+ function onSuccess(position) {
+ var element = document.getElementById('geolocation');
+ element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
+ 'Longitude: ' + position.coords.longitude + '<br />' +
+ '<hr />' + element.innerHTML;
+ }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="geolocation">Watching geolocation...</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocation.options.md b/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocation.options.md
new file mode 100644
index 0000000..74353f4
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocation.options.md
@@ -0,0 +1,39 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+geolocationOptions
+==================
+
+Optional parameters to customize the retrieval of the geolocation
+`Position`.
+
+ { maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };
+
+Options
+-------
+
+- __enableHighAccuracy__: Provides a hint that the application needs the best possible results. By default, the device attempts to retrieve a `Position` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
+- __timeout__: The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback executes. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback is passed a `PositionError.TIMEOUT` error code. (Note that when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds!) _(Number)_
+- __maximumAge__: Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
+
+Android Quirks
+--------------
+
+Android 2.x emulators do not return a geolocation result unless the `enableHighAccuracy` option is set to `true`.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocationError.md b/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocationError.md
new file mode 100644
index 0000000..c087165
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocationError.md
@@ -0,0 +1,33 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+geolocationError
+================
+
+The user's callback function that executes when there is an error for
+geolocation functions.
+
+ function(error) {
+ // Handle the error
+ }
+
+Parameters
+----------
+
+- __error__: The error returned by the device. _(PositionError)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocationSuccess.md b/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocationSuccess.md
new file mode 100644
index 0000000..8df414a
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/geolocation/parameters/geolocationSuccess.md
@@ -0,0 +1,49 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+geolocationSuccess
+==================
+
+The user's callback function that executes when a geolocation position
+becomes available (when called from `geolocation.getCurrentPosition`),
+or when the position changes (when called from
+`geolocation.watchPosition`).
+
+ function(position) {
+ // Do something
+ }
+
+Parameters
+----------
+
+- __position__: The geolocation position returned by the device. _(Position)_
+
+Example
+-------
+
+ function geolocationSuccess(position) {
+ alert('Latitude: ' + position.coords.latitude + '\n' +
+ 'Longitude: ' + position.coords.longitude + '\n' +
+ 'Altitude: ' + position.coords.altitude + '\n' +
+ 'Accuracy: ' + position.coords.accuracy + '\n' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
+ 'Heading: ' + position.coords.heading + '\n' +
+ 'Speed: ' + position.coords.speed + '\n' +
+ 'Timestamp: ' + position.timestamp + '\n');
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/GlobalizationError/globalizationerror.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/GlobalizationError/globalizationerror.md b/docs/en/3.0.0rc1/cordova/globalization/GlobalizationError/globalizationerror.md
new file mode 100644
index 0000000..70504c3
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -0,0 +1,94 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+GlobalizationError
+============
+
+An object representing a error from the Globalization API.
+
+Properties
+----------
+
+- __code__: One of the following codes representing the error type _(Number)_
+ - GlobalizationError.UNKNOWN\_ERROR: 0
+ - GlobalizationError.FORMATTING\_ERROR: 1
+ - GlobalizationError.PARSING\_ERROR: 2
+ - GlobalizationError.PATTERN\_ERROR: 3
+- __message__: A text message that includes the error's explanation and/or details _(String)_
+
+Description
+-----------
+
+This object is created and populated by Cordova, and returned to a callback in the case of an error.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+
+Quick Example
+-------------
+
+When the following error callback executes, it displays a
+popup dialog with the text similar to `code: 3` and `message:`
+
+ function errorCallback(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ };
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>GlobalizationError Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function successCallback(date) {
+ alert('month:' + date.month +
+ ' day:' + date.day +
+ ' year:' + date.year + '\n');
+ }
+
+ function errorCallback(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ };
+
+ function checkError() {
+ navigator.globalization.stringToDate(
+ 'notADate',
+ successCallback,
+ errorCallback,
+ {selector:'foobar'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkError()">Click for error</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.dateToString.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.dateToString.md
new file mode 100644
index 0000000..8b8f690
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.dateToString.md
@@ -0,0 +1,97 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.dateToString
+===========
+
+Returns a date formatted as a string according to the client's locale and timezone.
+
+ navigator.globalization.dateToString(date, successCallback, errorCallback, options);
+
+Description
+-----------
+
+Returns the formatted date `String` via a `value` property accessible
+from the object passed as a parameter to the `successCallback`.
+
+The inbound `date` parameter should be of type `Date`.
+
+If there is an error formatting the date, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.FORMATTING\_ERROR`.
+
+The `options` parameter is optional, and its default values are:
+
+ {formatLength:'short', selector:'date and time'}
+
+The `options.formatLength` can be `short`, `medium`, `long`, or `full`.
+
+The `options.selector` can be `date`, `time` or `date and time`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 8
+
+Quick Example
+-------------
+
+If the browser is set to the `en\_US` locale, this displays a popup
+dialog with text similar to `date: 9/25/2012 4:21PM` using the default
+options:
+
+ navigator.globalization.dateToString(
+ new Date(),
+ function (date) { alert('date: ' + date.value + '\n'); },
+ function () { alert('Error getting dateString\n'); },
+ { formatLength: 'short', selector: 'date and time' }
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>dateToString Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDateString() {
+ navigator.globalization.dateToString(
+ new Date(),
+ function (date) {alert('date: ' + date.value + '\n');},
+ function () {alert('Error getting dateString\n');,
+ {formatLength:'short', selector:'date and time'}}
+ );
+ }
+ </script>
+ </head>
+ <body>
+ <button onclick="checkDateString()">Click for date string</button>
+ </body>
+ </html>
+
+Windows Phone 8 Quirks
+--------------
+
+- The `formatLength` option supports only `short` and `full` values.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.getCurrencyPattern.md
new file mode 100644
index 0000000..119549c
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.getCurrencyPattern.md
@@ -0,0 +1,112 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.getCurrencyPattern
+===========
+
+Returns a pattern string to format and parse currency values according
+to the client's user preferences and ISO 4217 currency code.
+
+ navigator.globalization.getCurrencyPattern(currencyCode, successCallback, errorCallback);
+
+Description
+-----------
+
+Returns the pattern to the `successCallback` with a `properties` object
+as a parameter. That object should contain the following properties:
+
+- __pattern__: The currency pattern to format and parse currency values. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_
+- __code__: The ISO 4217 currency code for the pattern. _(String)_
+- __fraction__: The number of fractional digits to use when parsing and formatting currency. _(Number)_
+- __rounding__: The rounding increment to use when parsing and formatting. _(Number)_
+- __decimal__: The decimal symbol to use for parsing and formatting. _(String)_
+- __grouping__: The grouping symbol to use for parsing and formatting. _(String)_
+
+The inbound `currencyCode` parameter should be a `String` of one of
+the ISO 4217 currency codes, for example 'USD'.
+
+If there is an error obtaining the pattern, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.FORMATTING\_ERROR`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+
+Quick Example
+-------------
+
+When the browser is set to the `en\_US` locale and the selected
+currency is United States Dollars, this example displays a popup
+dialog with text similar to the results that follow:
+
+ navigator.globalization.getCurrencyPattern(
+ 'USD',
+ function (pattern) {
+ alert('pattern: ' + pattern.pattern + '\n' +
+ 'code: ' + pattern.code + '\n' +
+ 'fraction: ' + pattern.fraction + '\n' +
+ 'rounding: ' + pattern.rounding + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
+ 'grouping: ' + pattern.grouping);
+ },
+ function () { alert('Error getting pattern\n'); }
+ );
+
+Expected result:
+
+ pattern: $#,##0.##;($#,##0.##)
+ code: USD
+ fraction: 2
+ rounding: 0
+ decimal: .
+ grouping: ,
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>getCurrencyPattern Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkPattern() {
+ navigator.globalization.getCurrencyPattern(
+ 'USD',
+ function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
+ 'code: ' + pattern.code + '\n' +
+ 'fraction: ' + pattern.fraction + '\n' +
+ 'rounding: ' + pattern.rounding + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
+ 'grouping: ' + pattern.grouping);},
+ function () {alert('Error getting pattern\n');}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkPattern()">Click for pattern</button>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.getDateNames.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.getDateNames.md
new file mode 100644
index 0000000..2b1833f
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.getDateNames.md
@@ -0,0 +1,102 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.getDateNames
+===========
+
+Returns an array of the names of the months or days of the week,
+depending on the client's user preferences and calendar.
+
+ navigator.globalization.getDateNames(successCallback, errorCallback, options);
+
+Description
+-----------
+
+Returns the array of names to the `successCallback` with a
+`properties` object as a parameter. That object contains a `value`
+property with an `Array` of `String` values. The array features names
+starting from either the first month in the year or the first day of
+the week, depending on the option selected.
+
+If there is an error obtaining the names, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
+
+The `options` parameter is optional, and its default values are:
+
+ {type:'wide', item:'months'}
+
+The value of `options.type` can be `narrow` or `wide`.
+
+The value of `options.item` can be `months` or `days`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 8
+
+Quick Example
+-------------
+
+When the browser is set to the `en\_US` locale, this example displays
+a series of twelve popup dialogs, one per month, with text similar to
+`month: January`:
+
+ navigator.globalization.getDateNames(
+ function (names) {
+ for (var i = 0; i < names.value.length; i++) {
+ alert('month: ' + names.value[i] + '\n');
+ }
+ },
+ function () { alert('Error getting names\n'); },
+ { type: 'wide', item: 'months' }
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>getDateNames Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDateNames() {
+ navigator.globalization.getDateNames(
+ function (names) {
+ for (var i=0; i<names.value.length; i++) {
+ alert('month: ' + names.value[i] + '\n');
+ }
+ },
+ function () {alert('Error getting names\n');},
+ {type:'wide', item:'months'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkDateNames()">Click for date names</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.getDatePattern.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.getDatePattern.md
new file mode 100644
index 0000000..651a0d2
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.getDatePattern.md
@@ -0,0 +1,105 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.getDatePattern
+===========
+
+Returns a pattern string to format and parse dates according to the
+client's user preferences.
+
+ navigator.globalization.getDatePattern(successCallback, errorCallback, options);
+
+Description
+-----------
+
+Returns the pattern to the `successCallback`. The object passed in as
+a parameter contains the following properties:
+
+- __pattern__: The date and time pattern to format and parse dates. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_
+- __timezone__: The abbreviated name of the time zone on the client. _(String)_
+- __utc\_offset__: The current difference in seconds between the client's time zone and coordinated universal time. _(Number)_
+- __dst\_offset__: The current daylight saving time offset in seconds between the client's non-daylight saving's time zone and the client's daylight saving's time zone. _(Number)_
+
+If there is an error obtaining the pattern, the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.PATTERN\_ERROR`.
+
+The `options` parameter is optional, and defaults to the following values:
+
+ {formatLength:'short', selector:'date and time'}
+
+The `options.formatLength` can be `short`, `medium`, `long`, or
+`full`. The `options.selector` can be `date`, `time` or `date and
+time`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 8
+
+Quick Example
+-------------
+
+When the browser is set to the `en\_US` locale, this example displays
+a popup dialog with text such as `pattern: M/d/yyyy h:mm a`:
+
+ function checkDatePattern() {
+ navigator.globalization.getDatePattern(
+ function (date) { alert('pattern: ' + date.pattern + '\n'); },
+ function () { alert('Error getting pattern\n'); },
+ { formatLength: 'short', selector: 'date and time' }
+ );
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>getDatePattern Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDatePattern() {
+ navigator.globalization.getDatePattern(
+ function (date) {alert('pattern: ' + date.pattern + '\n');},
+ function () {alert('Error getting pattern\n');},
+ {formatLength:'short', selector:'date and time'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkDatePattern()">Click for pattern</button>
+ </body>
+ </html>
+
+Windows Phone 8 Quirks
+--------------
+
+- The `formatLength` supports only `short` and `full` values.
+- The `pattern` for `date and time` pattern returns only full datetime format.
+- The `timezone` returns the full time zone name.
+- The `dst_offset` property is not supported, and always returns zero.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.getFirstDayOfWeek.md
new file mode 100644
index 0000000..4fdc260
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -0,0 +1,82 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.getFirstDayOfWeek
+===========
+
+Returns the first day of the week according to the client's user
+preferences and calendar.
+
+ navigator.globalization.getFirstDayOfWeek(successCallback, errorCallback);
+
+Description
+-----------
+
+The days of the week are numbered starting from 1, where 1 is assumed
+to be Sunday. Returns the day to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `Number` value.
+
+If there is an error obtaining the pattern, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 8
+
+Quick Example
+-------------
+
+When the browser is set to the `en\_US` locale, this displays a
+popup dialog with text similar to `day: 1`.
+
+ navigator.globalization.getFirstDayOfWeek(
+ function (day) {alert('day: ' + day.value + '\n');},
+ function () {alert('Error getting day\n');}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>getFirstDayOfWeek Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkFirstDay() {
+ navigator.globalization.getFirstDayOfWeek(
+ function (day) {alert('day: ' + day.value + '\n');},
+ function () {alert('Error getting day\n');}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkFirstDay()">Click for first day of week</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.getLocaleName.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.getLocaleName.md
new file mode 100644
index 0000000..f25f9e8
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.getLocaleName.md
@@ -0,0 +1,83 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.getLocaleName
+===========
+
+Get the string identifier for the client's current locale setting.
+
+ navigator.globalization.getLocaleName(successCallback, errorCallback);
+
+
+Description
+-----------
+
+Returns the locale identifier string to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `String` value.
+
+If there is an error getting the locale, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 8
+
+Quick Example
+-------------
+
+When the browser is set to the `en\_US` locale, this displays a popup
+dialog with the text `locale: en\_US`.
+
+ navigator.globalization.getLocaleName(
+ function (locale) {alert('locale: ' + locale.value + '\n');},
+ function () {alert('Error getting locale\n');}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>getLocaleName Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkLocale() {
+ navigator.globalization.getLocaleName(
+ function (locale) {alert('locale: ' + locale.value + '\n');},
+ function () {alert('Error getting locale\n');}
+ );
+ }
+ </script>
+ </head>
+ <body>
+ <button onclick="checkLocale()">Click for locale</button>
+ </body>
+ </html>
+
+Windows Phone 8 Quirks
+---------------------
+- Returns the two-letter code defined in ISO 3166 for the current country/region.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.getNumberPattern.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.getNumberPattern.md
new file mode 100644
index 0000000..9477b44
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.getNumberPattern.md
@@ -0,0 +1,125 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.getNumberPattern
+===========
+
+Returns a pattern string to format and parse numbers according to the client's user preferences.
+
+ navigator.globalization.getNumberPattern(successCallback, errorCallback, options);
+
+Description
+-----------
+
+Returns the pattern to the `successCallback` with a `properties` object
+as a parameter. That object contains the following properties:
+
+- __pattern__: The number pattern to format and parse numbers. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_
+- __symbol__: The symbol to use when formatting and parsing, such as a percent or currency symbol. _(String)_
+- __fraction__: The number of fractional digits to use when parsing and formatting numbers. _(Number)_
+- __rounding__: The rounding increment to use when parsing and formatting. _(Number)_
+- __positive__: The symbol to use for positive numbers when parsing and formatting. _(String)_
+- __negative__: The symbol to use for negative numbers when parsing and formatting. _(String)_
+- __decimal__: The decimal symbol to use for parsing and formatting. _(String)_
+- __grouping__: The grouping symbol to use for parsing and formatting. _(String)_
+
+If there is an error obtaining the pattern, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.PATTERN\_ERROR`.
+
+The `options` parameter is optional, and default values are:
+
+ {type:'decimal'}
+
+The `options.type` can be `decimal`, `percent`, or `currency`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 8
+
+Quick Example
+-------------
+
+When the browser is set to the `en\_US` locale, this should display a
+popup dialog with text similar to the results that follow:
+
+ navigator.globalization.getNumberPattern(
+ function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
+ 'symbol: ' + pattern.symbol + '\n' +
+ 'fraction: ' + pattern.fraction + '\n' +
+ 'rounding: ' + pattern.rounding + '\n' +
+ 'positive: ' + pattern.positive + '\n' +
+ 'negative: ' + pattern.negative + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
+ 'grouping: ' + pattern.grouping);},
+ function () {alert('Error getting pattern\n');},
+ {type:'decimal'}
+ );
+
+Results:
+
+ pattern: #,##0.###
+ symbol: .
+ fraction: 0
+ rounding: 0
+ positive:
+ negative: -
+ decimal: .
+ grouping: ,
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>getNumberPattern Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkPattern() {
+ navigator.globalization.getNumberPattern(
+ function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
+ 'symbol: ' + pattern.symbol + '\n' +
+ 'fraction: ' + pattern.fraction + '\n' +
+ 'rounding: ' + pattern.rounding + '\n' +
+ 'positive: ' + pattern.positive + '\n' +
+ 'negative: ' + pattern.negative + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
+ 'grouping: ' + pattern.grouping);},
+ function () {alert('Error getting pattern\n');},
+ {type:'decimal'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkPattern()">Click for pattern</button>
+ </body>
+ </html>
+
+Windows Phone 8 Quirks
+----------------
+- The `pattern` property is not supported, and retuens an empty string.
+- The `fraction` property is not supported, and returns zero.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.getPreferredLanguage.md
new file mode 100644
index 0000000..660472d
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.getPreferredLanguage.md
@@ -0,0 +1,83 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.getPreferredLanguage
+===========
+
+Get the string identifier for the client's current language.
+
+ navigator.globalization.getPreferredLanguage(successCallback, errorCallback);
+
+
+Description
+-----------
+
+Returns the language identifier string to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `String` value.
+
+If there is an error getting the language, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 8
+
+Quick Example
+-------------
+
+When the browser is set to the `en\_US` locale, this should display a
+popup dialog with the text `language: English`:
+
+ navigator.globalization.getPreferredLanguage(
+ function (language) {alert('language: ' + language.value + '\n');},
+ function () {alert('Error getting language\n');}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>getPreferredLanguage Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkLanguage() {
+ navigator.globalization.getPreferredLanguage(
+ function (language) {alert('language: ' + language.value + '\n');},
+ function () {alert('Error getting language\n');}
+ );
+ }
+ </script>
+ </head>
+ <body>
+ <button onclick="checkLanguage()">Click for language</button>
+ </body>
+ </html>
+
+Windows Phone 8 Quirks
+-------
+- Returns the ISO 639-1 two-letter code for the current language.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.isDayLightSavingsTime.md
new file mode 100644
index 0000000..97577f6
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -0,0 +1,87 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.isDayLightSavingsTime
+===========
+
+Indicates whether daylight savings time is in effect for a given date
+using the client's time zone and calendar.
+
+ navigator.globalization.isDayLightSavingsTime(date, successCallback, errorCallback);
+
+Description
+-----------
+
+Indicates whether or not daylight savings time is in effect to the
+`successCallback` with a `properties` object as a parameter. That object
+should have a `dst` property with a `Boolean` value. A `true` value
+indicates that daylight savings time is in effect for the given date,
+and `false` indicates that it is not.
+
+The inbound parameter `date` should be of type `Date`.
+
+If there is an error reading the date, then the `errorCallback`
+executes. The error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 8
+
+Quick Example
+-------------
+
+During the summer, and if the browser is set to a DST-enabled
+timezone, this should display a popup dialog with text similar to
+`dst: true`:
+
+ navigator.globalization.isDayLightSavingsTime(
+ new Date(),
+ function (date) {alert('dst: ' + date.dst + '\n');},
+ function () {alert('Error getting names\n');}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>isDayLightSavingsTime Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDayLightSavings() {
+ navigator.globalization.isDayLightSavingsTime(
+ new Date(),
+ function (date) {alert('dst: ' + date.dst + '\n');},
+ function () {alert('Error getting names\n');}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkDayLightSavings()">Click for daylight savings</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.md
new file mode 100644
index 0000000..b473ec9
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.md
@@ -0,0 +1,63 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Globalization
+======
+
+Obtains information and performs operations specific to the user's
+locale and timezone.
+
+Objects
+-------
+
+- GlobalizationError
+
+Methods
+-------
+
+- globalization.getPreferredLanguage
+- globalization.getLocaleName
+- globalization.dateToString
+- globalization.stringToDate
+- globalization.getDatePattern
+- globalization.getDateNames
+- globalization.isDayLightSavingsTime
+- globalization.getFirstDayOfWeek
+- globalization.numberToString
+- globalization.stringToNumber
+- globalization.getNumberPattern
+- globalization.getCurrencyPattern
+
+Variable Scope
+--------------
+
+The `globalization` object is a child of the `navigator` object, and
+therefore has global scope.
+
+ // The global globalization object
+ var globalization = navigator.globalization;
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Globalization" value="org.apache.cordova.Globalization" />
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.numberToString.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.numberToString.md
new file mode 100644
index 0000000..84857dc
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.numberToString.md
@@ -0,0 +1,90 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.numberToString
+===========
+
+Returns a number formatted as a string according to the client's user preferences.
+
+ navigator.globalization.numberToString(number, successCallback, errorCallback, options);
+
+Description
+-----------
+
+Returns the formatted number string to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `String` value.
+
+If there is an error formatting the number, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.FORMATTING\_ERROR`.
+
+The `options` parameter is optional, and its default values are:
+
+ {type:'decimal'}
+
+The `options.type` can be 'decimal', 'percent', or 'currency'.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 8
+
+Quick Example
+-------------
+
+When the browser is set to the `en\_US` locale, this displays a popup
+dialog with text similar to `number: 3.142`:
+
+ navigator.globalization.numberToString(
+ 3.1415926,
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>numberToString Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkNumber() {
+ navigator.globalization.numberToString(
+ 3.1415926,
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkNumber()">Click for number</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.stringToDate.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.stringToDate.md
new file mode 100644
index 0000000..85a3138
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.stringToDate.md
@@ -0,0 +1,114 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.stringToDate
+===========
+
+Parses a date formatted as a string, according to the client's user
+preferences and calendar using the time zone of the client, and
+returns the corresponding date object.
+
+ navigator.globalization.stringToDate(dateString, successCallback, errorCallback, options);
+
+Description
+-----------
+
+Returns the date to the success callback with a `properties` object as
+a parameter. That object should have the following properties:
+
+- __year__: The four digit year. _(Number)_
+- __month__: The month from (0 - 11). _(Number)_
+- __day__: The day from (1 - 31). _(Number)_
+- __hour__: The hour from (0 - 23). _(Number)_
+- __minute__: The minute from (0 - 59). _(Number)_
+- __second__: The second from (0 - 59). _(Number)_
+- __millisecond__: The milliseconds (from 0 - 999), not available on all platforms. _(Number)_
+
+The inbound `dateString` parameter should be of type `String`.
+
+The `options` parameter is optional, and defaults to the following
+values:
+
+ {formatLength:'short', selector:'date and time'}
+
+The `options.formatLength` can be `short`, `medium`, `long`, or
+`full`. The `options.selector` can be `date`, `time` or `date and
+time`.
+
+If there is an error parsing the date string, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.PARSING\_ERROR`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 8
+
+Quick Example
+-------------
+
+When the browser is set to the `en\_US` locale, this displays a
+popup dialog with text similar to `month:8 day:25 year:2012`. Note
+that the month integer is one less than the string, as the month
+integer represents an array index.
+
+ navigator.globalization.stringToDate(
+ '9/25/2012',
+ function (date) {alert('month:' + date.month +
+ ' day:' + date.day +
+ ' year:' + date.year + '\n');},
+ function () {alert('Error getting date\n');},
+ {selector: 'date'}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>stringToDate Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkStringDate() {
+ navigator.globalization.stringToDate(
+ '9/25/2012',
+ function (date) {alert('month:' + date.month +
+ ' day:' + date.day +
+ ' year:' + date.year + '\n');},
+ function () {alert('Error getting date\n');},
+ {selector:'date'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkStringDate()">Click for parsed date</button>
+ </body>
+ </html>
+
+Windows Phone 8 Quirks
+------------------
+
+- The `formatLength` option supports only `short` and `full` values.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/globalization/globalization.stringToNumber.md b/docs/en/3.0.0rc1/cordova/globalization/globalization.stringToNumber.md
new file mode 100644
index 0000000..9e34488
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/globalization/globalization.stringToNumber.md
@@ -0,0 +1,93 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+globalization.stringToNumber
+===========
+
+Parses a number formatted as a string according to the client's user
+preferences and returns the corresponding number.
+
+ navigator.globalization.stringToNumber(string, successCallback, errorCallback, options);
+
+Description
+-----------
+
+Returns the number to the `successCallback` with a `properties` object
+as a parameter. That object should have a `value` property with a
+`Number` value.
+
+If there is an error parsing the number string, then the
+`errorCallback` executes with a `GlobalizationError` object as a
+parameter. The error's expected code is
+`GlobalizationError.PARSING\_ERROR`.
+
+The `options` parameter is optional, and defaults to the following
+values:
+
+ {type:'decimal'}
+
+The `options.type` can be `decimal`, `percent`, or `currency`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 8
+
+Quick Example
+-------------
+
+When the browser is set to the `en\_US` locale, this should display a
+popup dialog with text similar to `number: 1234.56`:
+
+ navigator.globalization.stringToNumber(
+ '1234.56',
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>stringToNumber Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkNumber() {
+ navigator.globalization.stringToNumber(
+ '1234.56',
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkNumber()">Click for parsed number</button>
+ </body>
+ </html>
+
[05/12] Version 3.0.0rc1
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/parameters/size.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/parameters/size.md b/docs/en/3.0.0rc1/cordova/storage/parameters/size.md
new file mode 100644
index 0000000..7d9585e
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/parameters/size.md
@@ -0,0 +1,23 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+database_size
+==============
+
+The size of the database in bytes.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/parameters/version.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/parameters/version.md b/docs/en/3.0.0rc1/cordova/storage/parameters/version.md
new file mode 100644
index 0000000..2e72923
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/parameters/version.md
@@ -0,0 +1,23 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+database_version
+=============
+
+The version of the database.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/sqlerror/sqlerror.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/sqlerror/sqlerror.md b/docs/en/3.0.0rc1/cordova/storage/sqlerror/sqlerror.md
new file mode 100644
index 0000000..5515103
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/sqlerror/sqlerror.md
@@ -0,0 +1,46 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+SQLError
+========
+
+A `SQLError` object is thrown when an error occurs.
+
+Properties
+----------
+
+- __code__: One of the predefined error codes listed below.
+- __message__: A description of the error.
+
+Constants
+---------
+
+- `SQLError.UNKNOWN_ERR`
+- `SQLError.DATABASE_ERR`
+- `SQLError.VERSION_ERR`
+- `SQLError.TOO_LARGE_ERR`
+- `SQLError.QUOTA_ERR`
+- `SQLError.SYNTAX_ERR`
+- `SQLError.CONSTRAINT_ERR`
+- `SQLError.TIMEOUT_ERR`
+
+Description
+-----------
+
+The `SQLError` object is thrown when an error occurs when manipulating a database.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/sqlresultset/sqlresultset.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/3.0.0rc1/cordova/storage/sqlresultset/sqlresultset.md
new file mode 100644
index 0000000..f302ee8
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/sqlresultset/sqlresultset.md
@@ -0,0 +1,153 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+SQLResultSet
+=======
+
+When a `SQLTransaction` object's `executeSql` method is called, the
+specified callback executes with a `SQLResultSet` parameter.
+
+Properties
+-------
+
+- __insertId__: The row ID of the row that the `SQLResultSet` object's SQL statement inserted into the database.
+- __rowsAffected__: The number of rows changed by the SQL statement, zero if the statement did not affect any rows.
+- __rows__: a `SQLResultSetRowList` representing the rows returned, empty if no rows are returned.
+
+Details
+-------
+
+When a `SQLTransaction` object's `executeSql` method is called, the
+specified callback executes with a `SQLResultSet` parameter containing
+three properties:
+
+* The `insertId` returns the row number of a successly SQL insertion
+ statement. If the SQL does not insert any rows, the `insertId` is
+ not set.
+
+* The `rowsAffected` is always `0` for a SQL `select` statement. For
+ `insert` or `update` statements it returns the number of modified
+ rows.
+
+* The final `SQLResultSetList` contains the data returned from a SQL
+ select statement.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iOS
+- Tizen
+
+Execute SQL Quick Example
+------------------
+
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ function querySuccess(tx, results) {
+ console.log("Returned rows = " + results.rows.length);
+ // this will be true since it was a select statement and so rowsAffected was 0
+ if (!results.rowsAffected) {
+ console.log('No rows affected!');
+ return false;
+ }
+ // for an insert statement, this property will return the ID of the last inserted row
+ console.log("Last inserted row ID = " + results.insertId);
+ }
+
+ function errorCB(err) {
+ alert("Error processing SQL: "+err.code);
+ }
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Query the database
+ //
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ // Query the success callback
+ //
+ function querySuccess(tx, results) {
+ console.log("Returned rows = " + results.rows.length);
+ // this will be true since it was a select statement and so rowsAffected was 0
+ if (!results.rowsAffected) {
+ console.log('No rows affected!');
+ return false;
+ }
+ // for an insert statement, this property will return the ID of the last inserted row
+ console.log("Last inserted row ID = " + results.insertId);
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(err) {
+ console.log("Error processing SQL: "+err.code);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Database</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md b/docs/en/3.0.0rc1/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
new file mode 100644
index 0000000..ca83868
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md
@@ -0,0 +1,142 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+SQLResultSetRowList
+=======
+
+One of the properties of the `SQLResultSet` containing the rows
+returned from a SQL query.
+
+Properties
+-------
+
+- __length__: the number of rows returned by the SQL query.
+
+Methods
+-------
+
+- __item__: returns the row at the specified index represented by a JavaScript object.
+
+Details
+-------
+
+The `SQLResultSetRowList` contains the data returned from a SQL
+`select` statement. The object contains a `length` property
+indicating how many rows the `select` statement returns. To get a row
+of data, call the `item` method to specify an index. It returns a
+JavaScript `Object` whose properties are the database columns the
+`select` statement was executed against.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iOS
+- Tizen
+
+Execute SQL Quick Example
+------------------
+
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ function querySuccess(tx, results) {
+ var len = results.rows.length;
+ console.log("DEMO table: " + len + " rows found.");
+ for (var i=0; i<len; i++){
+ console.log("Row = " + i + " ID = " + results.rows.item(i).id + " Data = " + results.rows.item(i).data);
+ }
+ }
+
+ function errorCB(err) {
+ alert("Error processing SQL: "+err.code);
+ }
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Query the database
+ //
+ function queryDB(tx) {
+ tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB);
+ }
+
+ // Query the success callback
+ //
+ function querySuccess(tx, results) {
+ var len = results.rows.length;
+ console.log("DEMO table: " + len + " rows found.");
+ for (var i=0; i<len; i++){
+ console.log("Row = " + i + " ID = " + results.rows.item(i).id + " Data = " + results.rows.item(i).data);
+ }
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(err) {
+ console.log("Error processing SQL: "+err.code);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(queryDB, errorCB);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Database</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/sqltransaction/sqltransaction.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/3.0.0rc1/cordova/storage/sqltransaction/sqltransaction.md
new file mode 100644
index 0000000..3c98feb
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/sqltransaction/sqltransaction.md
@@ -0,0 +1,114 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+SQLTransaction
+=======
+
+Allows execution of SQL statements against the Database.
+
+Methods
+-------
+
+- __executeSql__: executes a SQL statement.
+
+Details
+-------
+
+Calling a `Database` object's transaction method, passes a
+`SQLTransaction` object to the specified callback method.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iOS
+- Tizen
+
+Execute SQL Quick Example
+------------------
+
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ function errorCB(err) {
+ alert("Error processing SQL: "+err);
+ }
+
+ function successCB() {
+ alert("success!");
+ }
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(err) {
+ alert("Error processing SQL: "+err);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ alert("success!");
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>SQLTransaction</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/storage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/storage.md b/docs/en/3.0.0rc1/cordova/storage/storage.md
new file mode 100644
index 0000000..1f703fd
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/storage.md
@@ -0,0 +1,80 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Storage
+==========
+
+> Provides access to the device's storage options.
+
+This API is based on the [W3C Web SQL Database
+Specification](http://dev.w3.org/html5/webdatabase/) and [W3C Web
+Storage API Specification](http://dev.w3.org/html5/webstorage/). Some
+devices already provide an implementation of these specifications, in
+which case the built-in support applies. Cordova's implementation
+offers compatible support for those that don't.
+
+Methods
+-------
+
+- openDatabase
+
+Arguments
+---------
+
+- database_name
+- database_version
+- database_displayname
+- database_size
+
+Objects
+-------
+
+- Database
+- SQLTransaction
+- SQLResultSet
+- SQLResultSetRowList
+- SQLError
+- localStorage
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Storage" value="org.apache.cordova.Storage" />
+
+### BlackBerry WebWorks
+
+#### www/config.xml
+
+ <feature id="blackberry.widgetcache" required="true" version="1.0.0.0" />
+
+### iOS
+
+ No permissions are required.
+
+### Windows Phone
+
+ No permissions are required.
+
+### Tizen
+
+ No permissions are required.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/storage.opendatabase.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/storage.opendatabase.md b/docs/en/3.0.0rc1/cordova/storage/storage.opendatabase.md
new file mode 100644
index 0000000..cc6b111
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/storage.opendatabase.md
@@ -0,0 +1,73 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+openDatabase
+===============
+
+Returns a new `Database` object.
+
+ var dbShell = window.openDatabase(database_name, database_version, database_displayname, database_size);
+
+Description
+-----------
+
+The method creates a new SQL Lite Database and returns a `Database`
+object that allows manipulation of the data.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iOS
+- Tizen
+
+Quick Example
+-------------
+
+ var db = window.openDatabase("test", "1.0", "Test DB", 1000000);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var db = window.openDatabase("test", "1.0", "Test DB", 1000000);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Open Database</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/cli/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/cli/index.md b/docs/en/3.0.0rc1/guide/cli/index.md
new file mode 100644
index 0000000..2650932
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/cli/index.md
@@ -0,0 +1,288 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+---
+
+# The Command-line Interface
+
+This guide shows you how to create applications and deploy them to
+various native mobile platforms using the `cordova` command-line
+interface (CLI). This tool allows you to create new projects, build
+them on different platforms, and run them within an emulator. You can
+also use the CLI to initialize project code, after which you use
+various platforms' SDKs to develop them further.
+
+## Prerequisites
+
+Before running any command-line tools, you need to install SDKs for
+each platform you wish to target.
+(See the Platform Guides for more details.)
+
+To add support or rebuild a project for any platform, you need to run
+the command-line interface from the same machine that supports the
+platform's SDK. The CLI supports the following combinations:
+
+* iOS (Mac)
+* Android (Mac, Linux)
+* BlackBerry (Mac, Windows)
+* Windows Phone 7 (Windows)
+* Windows Phone 8 (Windows)
+
+On the Mac, the command-line is available via the _Terminal_
+application. On the PC, it's available as _Command Prompt_ under
+_Accessories_.
+
+The more likely it is that you run the CLI from different machines,
+the more it makes sense to maintain a remote source code repository,
+whose assets you pull down to local working directories.
+
+To install the `cordova` command-line tool, follow these steps:
+
+1. Download and install [Node.js](http://nodejs.org/). Following
+ installation, you should be able to invoke `node` or `npm` on your
+ command line.
+
+1. Install the `cordova` utility. In Unix, prefixing the additional
+ `sudo` command may be necessary to install development utilities in
+ otherwise restricted directories:
+
+ $ sudo npm install -g cordova
+
+ The installation log may produce errors for any uninstalled
+ platform SDKs. Following installation, you should be able to run
+ `cordova` on the command line.
+
+## Create the App
+
+Go to the directory where you maintain your source code, and run a
+command such as the following:
+
+ $ cordova create HelloWorld com.example.hello "Hello World"
+
+The first argument specifies a _HelloWorld_ directory to be generated
+for your project. Its `www` subdirectory houses your application's
+home page, along with various resources under `css`, `js`, and `img`,
+which follow common web development file-naming conventions. The
+`config.xml` file contains important metadata needed to generate and
+distribute the application.
+
+The other two arguments are optional: the `com.example.hello` argument
+provides your project with a reverse domain-style identifier, and the
+`"Hello World!"` provides the application's display text. You can edit
+both of these values later in the `config.xml` file.
+
+## Add Platforms
+
+All subsequent commands need to be run within the project's directory,
+or any subdirectories within its scope:
+
+ $ cd HelloWorld
+
+Before you can build the project, you need to specify a set of target
+platforms. Your ability to run these commands depends on whether your
+machine supports each SDK, and whether you have already installed each
+SDK. Run any of these from a Mac:
+
+ $ cordova platform add ios
+ $ cordova platform add android
+ $ cordova platform add blackberry
+
+Run any of these from a Windows machine, where _wp_ refers to
+different versions of the Windows Phone operating system:
+
+ $ cordova platform add wp7
+ $ cordova platform add wp8
+ $ cordova platform add android
+ $ cordova platform add blackberry
+
+Run this to check your current set of platforms:
+
+ $ cordova platforms ls
+
+(Note the `platform` and `platforms` commands are synonymous.)
+
+Run either of the following synonymous commands to remove a platform:
+
+ $ cordova platform remove blackberry
+ $ cordova platform rm android
+
+Running commands to add or remove platforms affects the contents of
+the project's _platforms_ directory, where each specified platform
+appears as a subdirectory. The _www_ source directory is reproduced
+within each platform's subdirectory, appearing for example in
+`platforms/ios/www` or `platforms/android/assets/www`. By default,
+each platform's configuration file is set up to be able to access all
+of Cordova's APIs.
+
+If you wish, you can use an SDK at this point to open the project you
+created. However, any edits you make to the project within an SDK
+affect the derivative set of assets, not the original cross-platform
+source files. Use this approach if you simply want to initialize a
+project.
+(See the Platform Guides for information on how to develop applications within each SDK.)
+Read on if you wish to use command-line tools for the entire
+development cycle.
+
+## Build the App
+
+By default, the `cordova create` script generates a skeletal web-based
+application whose home page is the project's `www/index.html` file.
+Edit this application however you want, but any initialization should
+be specified as part of the `deviceready` event handler, referenced by
+default from `www/js/index.js`.
+<!-- XREF
+(See Application Development Guide for details.)
+XREF -->
+
+Run the following command to iteratively build the project:
+
+ $ cordova build
+
+This generates platform-specific code within the project's `platforms`
+subdirectory. You can optionally limit the scope of each build to
+specific platforms:
+
+ $ cordova build ios
+
+The `cordova build` command is a shorthand for the following, which in
+this example is also targeted to a single platform:
+
+ $ cordova prepare ios
+ $ cordova compile ios
+
+In this case, once you run `prepare`, you can use Apple's Xcode SDK as
+an alternative to modify and compile the platform-specific code that
+Cordova generates within `platforms/ios`. You can use the same
+approach with other platforms' SDKs.
+
+## View the App in an Emulator
+
+SDKs for mobile platforms often come bundled with emulators that
+execute a device image, so that you can launch the app from the home
+screen and see how it interacts with many platform features. Run a
+command such as the following to rebuild the app and view it within a
+specific platform's emulator:
+
+ $ cordova emulate android
+
+Some mobile platforms emulate a particular device by default, such as
+the iPhone for iOS projects. For other platforms, you may need to
+first associate a device with an emulator.
+(See the Platform Guides for details.)
+For example, you may first run the `android` command to launch the
+Android SDK, then run a particular device image, which launches it
+according to its default behavior:
+
+
+
+Following up with the `cordova emulate` command refreshes the emulator
+image to display the latest application, which is now available for
+launch from the home screen:
+
+
+
+## Add Features
+
+When you build and view a new project, the default application that
+appears doesn't do very much. You can modify the app in many ways to
+take advantage of standard web technologies, but for the app to
+communicate closely with various device-level features, you need to
+add plugins that provide access to core Cordova APIs.
+
+A _plugin_ is a bit of add-on code that provides an interface to
+native components. You can design your own plugin interface, for
+example when designing a hybrid app that mixes a Cordova WebView with
+native components. (See Embedding WebViews and Plugin Development Guide for details.) More commonly, you would add a plugin to enable
+one of Cordova's basic device-level features
+<!-- XREF
+discussed in the Application Development Guide and
+XREF -->
+detailed in the API Reference.
+
+The `cordova plugin add` command requires you to specify the
+repository for the plugin code. Here are examples of features you
+might add:
+
+* Basic device information:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git
+* Network and battery status:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git
+* Accelerometer, compass, and geolocation:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
+* Camera, media capture, and media playback:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git
+* Access files on device or network:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer.git
+* Notifications via dialog box or vibration:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git
+* Contacts:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git
+* Globalization:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git
+* Splash Screen:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git
+* In-app browser:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git
+* Debug console:
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-console.git
+
+Use `plugin ls` (or `plugin list`) to view currently installed
+plugins. Each displays by its identifier:
+
+ $ cordova plugin ls # or 'plugin list'
+ [ 'org.apache.cordova.core.console' ]
+
+To remove a plugin, refer to it by the same identifier that appears in
+the listing. For example, here is how you would remove support for a
+debug console from a release version:
+
+ $ cordova plugin rm org.apache.cordova.core.console
+ $ cordova plugin remove org.apache.cordova.core.console # same
+
+You can batch-remove or add plugins by specifying more than one
+argument for each command.
+
+<!--
+
+## Run the App on the Device
+
+-->
+
+## Update the App
+
+After installing installing the `cordova` utility, you can always
+update it to the latest version by running the following command:
+
+ $ sudo npm update -g cordova
+
+Use this syntax to install a specific version:
+
+ $ sudo npm install -g cordova@2.8.0
+
+Run the `info` command for a listing that includes the current version
+along with other available version numbers:
+
+ $ npm info cordova
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/overview/index.md b/docs/en/3.0.0rc1/guide/overview/index.md
new file mode 100644
index 0000000..195c84e
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/overview/index.md
@@ -0,0 +1,383 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+---
+
+# Overview
+
+Cordova is an open-source mobile development framework. It allows you
+to use standard web technologies such as HTML5, CSS3, and JavaScript
+for cross-platform development, avoiding each mobile platforms' native
+development language. Applications execute within wrappers targeted
+to each platform, and rely on standards-compliant API bindings to
+access each device's sensors, data, and network status.
+
+Use Cordova if you are:
+
+* a mobile developer and want to extend an application across more
+ than one platform, without having to re-implement it with each
+ platform's language and tool set.
+
+* a web developer and want to deploy a web app that's packaged for
+ distribution in various app store portals.
+
+* a mobile developer interested in mixing native application
+ components with a _WebView_ (browser window) that can access
+ device-level APIs, or if you want to develop a plug-in interface
+ between native and WebView components.
+
+## Basic Components
+
+Cordova applications rely on a common `config.xml` file that provides
+information about the app and specifies parameters affecting how it
+works, such as whether it responds to orientation shifts. This file
+adheres to the W3C's
+[Packaged Web App](http://www.w3.org/TR/widgets/),
+or _widget_, specification.
+
+The application itself is implemented as a web page, named
+_index.html_ by default, that references whatever CSS, JavaScript,
+images, media files, or other resources are necessary for it to run.
+The app executes as a _WebView_ within the native application wrapper,
+which you distribute to app stores. For the web app to interact with
+various device features the way native apps do, it must also reference
+a `cordova.js` file, which provides API bindings.
+<!-- XREF
+(See the API Reference for an overview, and the API and Configuration
+Guide for examples of how to use them.)
+XREF -->
+
+The Cordova-enabled WebView may provide the application with its
+entire user interface. It can also be a component within a larger,
+hybrid application that mixes the WebView with native application
+components. Cordova provides a _plug-in_ interface for these
+components to communicate with each other.
+
+## Development Paths
+
+The easiest way to set up an application is to run the `cordova`
+command-line utility, also known as the _command-line interface_
+(CLI). (To install the CLI, see The Command-line Interface.)
+Depending on the set of platforms you wish to target, you can rely on
+the CLI for progressively greater shares of the development cycle:
+
+* In the most basic scenario, you can use the CLI simply to create a
+ new project that is populated with default configuration for you to
+ modify.
+
+* For many mobile platforms, you can also use the CLI to set up
+ additional project files required to compile within each SDK. For
+ this to work, you must install each targeted platform's SDK.
+ (See the Platform Guides for instructions.)
+ As indicated in the Platform Support table below, you may need to
+ run the CLI on different operating systems depending on the targeted
+ platform.
+
+* For supporting platforms, the CLI can compile executible
+ applications and run them in an SDK-based device emulator.
+ <!-- XREF
+ (See Application Development Guide for details.)
+ XREF -->
+ For comprehensive testing, you can also generate application files
+ and install them directly on a device.
+
+At any point in the development cycle, you can also rely on
+platform-specific SDK tools, which may provide a richer set of
+options.
+(See the Platform Guides for details about each platform's SDK tool set.)
+An SDK environment is more appropriate if you want implement a hybrid
+app that mixes web-based and native application components.
+<!-- XREF
+(See Hybrid Application Guide for more information.)
+XREF -->
+You may use the command-line utility to initially generate the app, or
+iteratively thereafter to feed updated code to SDK tools. You may
+also build the app's configuration file yourself.
+<!-- XREF
+(See Configuration Reference for details.)
+XREF -->
+
+<!-- XREF
+To build projects on some platforms, you may need to apply digital signatures.
+See Distributing Applications for information on how to upload your app to various store portals.
+XREF -->
+
+## Platform Support
+
+The following shows the set of development tools and device APIs
+available for each mobile platform:
+
+<!-- START HTML -->
+
+<table class="compat" width="100%">
+
+<thead>
+ <tr>
+ <th></td>
+ <th>Android</th>
+ <th>BlackBerry</th>
+ <th>BlackBerry 10</th>
+ <th>iOS</th>
+ <th>Windows<br/>Phone 7</th>
+ <th>Windows<br/>Phone 8</th>
+ <th>Windows<br/>8</th>
+ </tr>
+
+</thead>
+
+<tbody>
+ <tr>
+ <th><a href="#">cordova<br/>CLI</a></th>
+ <td data-col="android" class="y">Mac, Windows, Linux</td>
+ <td data-col="blackberry" class="y">Mac, Windows</td>
+ <td data-col="blackberry10" class="y">Mac, Windows</td>
+ <td data-col="ios" class="y">Mac</td>
+ <td data-col="winphone7" class="y">Windows</td>
+ <td data-col="winphone8" class="y">Windows</td>
+ <td data-col="win8" class="u"></td>
+ </tr>
+
+ <tr>
+ <th><a href="#">PhoneGap<br/>Build</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="u"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="u"></td>
+ </tr>
+
+ <tr>
+ <th><a href="guide_platforms_index.md.html">SDK platform support</a></th>
+ <td data-col="android" class="y"><a href="guide_platforms_android_index.md.html"> </a></td>
+ <td data-col="blackberry" class="y"><a href="guide_platforms_blackberry_index.md.html"> </a></td>
+ <td data-col="blackberry10" class="y"><a href="guide_platforms_blackberry10_index.md.html"> </a></td>
+ <td data-col="ios" class="y"><a href="guide_platforms_ios_index.md.html"> </a></td>
+ <td data-col="winphone7" class="y"><a href="guide_platforms_wp7_index.md.html"> </a></td>
+ <td data-col="winphone8" class="y"><a href="guide_platforms_windows-phone-8_index.md.html"> </a></td>
+ <td data-col="win8" class="y"><a href="guide_platforms_windows-8_index.md.html"> </a></td>
+ </tr>
+
+ <tr>
+ <th><a href="#">Embedded<br/>WebView</a></th>
+ <td data-col="android" class="y"><a href="guide_platforms_android_webview.md.html"></a></td>
+ <td data-col="blackberry" class="n"></td>
+ <td data-col="blackberry10" class="n"></td>
+ <td data-col="ios" class="y"><a href="guide_platforms_ios_webview.md.html"></a></td>
+ <td data-col="winphone7" class="n"></td>
+ <td data-col="winphone8" class="n"></td>
+ <td data-col="win8" class="n"></td>
+ </tr>
+
+ <tr>
+ <th><a href="guide_plugin-development_index.md.html">Plug-in<br/>Interface</a></th>
+ <td data-col="android" class="y"><a href="guide_guide_platforms_android_plugin.md.html"></a></td>
+ <td data-col="blackberry" class="y"><a href="guide_guide_platforms_blackberry_plugin.md.html"></a></td>
+ <td data-col="blackberry10" class="y"><a href="guide_guide_platforms_blackberry10_plugin.md.html"></a></td>
+ <td data-col="ios" class="y"><a href="guide_guide_platforms_ios_plugin.md.html"></a></td>
+ <td data-col="winphone7" class="y"><a href="guide_guide_platforms_wp8_plugin.md.html"></a></td>
+ <td data-col="winphone8" class="n"></td>
+ <td data-col="win8" class="n"></td>
+ </tr>
+
+ <tr>
+ <th></th>
+ <th colspan="20">Platform APIs</th>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_accelerometer_accelerometer.md.html">Accelerometer</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_camera_camera.md.html">Camera</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_media_capture_capture.md.html">Capture</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="n"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_compass_compass.md.html">Compass</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="n"></td>
+ <td data-col="blackberry10" class="n"></td>
+ <td data-col="ios" class="y">(3GS+)</td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_connection_connection.md.html">Connection</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_contacts_contacts.md.html">Contacts</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_device_device.md.html">Device</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_events_events.md.html">Events</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_file_file.md.html">File</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_geolocation_geolocation.md.html">Geolocation</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_globalization_globalization.md.html">Globalization</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="n"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="n"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_inappbrowser_inappbrowser.md.html">InAppBrowser</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_media_media.md.html">Media</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="n"></td>
+ <td data-col="blackberry10" class="n"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_notification_notification.md.html">Notification</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_splashscreen_splashscreen.md.html">Splashscreen</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="n"></td>
+ <td data-col="blackberry10" class="n"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="n"></td>
+ <td data-col="winphone8" class="n"></td>
+ <td data-col="win8" class="n"></td>
+ </tr>
+
+ <tr>
+ <th><a href="cordova_storage_storage.md.html">Storage</a></th>
+ <td data-col="android" class="y"></td>
+ <td data-col="blackberry" class="y"></td>
+ <td data-col="blackberry10" class="y"></td>
+ <td data-col="ios" class="y"></td>
+ <td data-col="winphone7" class="y"></td>
+ <td data-col="winphone8" class="y"></td>
+ <td data-col="win8" class="y"></td>
+ </tr>
+
+</tbody>
+</table>
+
+<!-- END HTML -->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/android/config.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/android/config.md b/docs/en/3.0.0rc1/guide/platforms/android/config.md
new file mode 100644
index 0000000..00a1ecd
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/android/config.md
@@ -0,0 +1,40 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Android Configuration
+
+The `config.xml` settings file controls various settings of Cordova. This is application wide, and not set per CordovaWebView Instance.
+
+## <preference>
+
+Various **other** preferences (as **<preference>** tags) default on not breaking existing apps. The available preferences are:
+
+1. **useBrowserHistory (boolean, defaults to true)** - set to false if you want to use the history shim that was used to work around the hashtag error present in Android 3.x prior to the history fix. (Note: This setting will be deprecated in April 2013)
+2. **loadingDialog** - Display a native loading dialog when loading the app. The value's format is _Title, Message_
+3. **loadingPageDialog** - Display a native loading dialog when loading sub-pages. The value's format is _Title, Message_
+4. **errorUrl** - Set the error page for your application. Should be located in your Android project in file://android_asset/www/
+5. **backgroundColor** - Set the background color for your application. Supports a four-byte hex value, with the first byte representing alpha value, and the following three bytes with standard RGB values. (i.e. 0x00000000 = Black)
+6. **loadUrlTimeoutValue** - How much time Cordova should wait before throwing a timeout error on the application.
+7. **keepRunning (boolean, defaults to true)** - Determines whether Cordova will keep running in the background or not
+8. **splashscreen** - The name of the file minus its extension in the `res/drawable` directory. If you have multiple assets, they all must share this common name in their respective directories.
+9. **disallowOverscroll (boolean, defaults to false)** - set to true if you want to disable the glow when a user scrolls beyond the edge of the webview.
+
+## <plugin>
+
+Android supports using <feature> as analogues to <plugin> elements.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/android/index.md b/docs/en/3.0.0rc1/guide/platforms/android/index.md
new file mode 100644
index 0000000..ddad02e
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/android/index.md
@@ -0,0 +1,200 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Android Platform Guide
+
+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:
+
+* Android Configuration
+* Android WebViews
+* Android Plugins
+* Upgrading Android
+* Android Command-line Tools
+
+The command-line tools above refer to versions prior to Cordova 3.0.
+See The Cordova Command-line Interface for information about the
+current interface.
+
+## Requirements and Support
+
+See the [System Requirements](http://developer.android.com/sdk/index.html)
+for the Android SDK.
+
+Cordova supports Android 2.2, 2.3, and 4.x. As a general rule,
+platforms are deprecated as they dip below 5% on Google's
+[distribution dashboard](http://developer.android.com/about/dashboards/index.html).
+
+<!--
+NOTE, doc said:
+- Android 2.1 (Deprecated May 2013)
+- Android 3.x (Deprecated May 2013)
+-->
+
+Developers should use the `cordova` utility in conjunction with
+the Android SDK. See The Command-line Interface for
+information how to install it, add projects, then build and deploy a
+project.
+
+## Install the SDK
+
+Install the Android SDK from
+[developer.android.com/sdk](http://developer.android.com/sdk/). You
+may be presented with a choice of where to install the SDK, otherwise
+move the downloaded `adt-bundle` tree to wherever you store
+development tools.
+
+For Cordova command-line tools to work, you need to include the SDK's
+`tools` and `platform-tools` directories in your PATH environment. On
+Mac, you can use a text editor to create or modify the
+`~/.bash_profile` file, adding a line such as the following, depending
+on where the SDK installs:
+
+ export PATH=${PATH}:/Development/adt-bundle/sdk/platform-tools:/Development/adt-bundle/sdk/tools
+
+This exposes SDK tools in newly opened terminal windows. Otherwise run
+this to make them available in the current session:
+
+ $ source ~/.bash_profile
+
+To modify the PATH environment on Windows 7:
+
+* Click on the __Start__ menu in the lower-left corner of the desktop,
+ right-click on __Computer__, then click __Properties__.
+
+* Click __Advanced System Settings__ in the column on the left.
+
+* In the resulting dialog box, press __Environment Variables__.
+
+* Select the __PATH__ variable and press __Edit__.
+
+* Append the following to the PATH based on where you installed the
+ SDK, for example:
+
+ ;C:\Development\adt-bundle\sdk\platform-tools;C:\Development\adt-bundle\sdk\tools
+
+* Save the value and close both dialog boxes.
+
+You may also need to enable Java and Ant. Open a command prompt and
+type `java`, and also type `ant`. Append to the PATH whichever fail to
+run:
+
+ ;%JAVA_HOME%\bin;%ANT_HOME%\bin
+
+## Open a Project in the SDK
+
+Use the `cordova` utility to set up a new project, as described in The
+Cordova The Command-line Interface. For example, in a source-code directory:
+
+ $ cordova create hello com.example.hello "Hello World"
+ $ cd hello
+ $ cordova platform add android
+ $ cordova build
+
+Once created, here's how to use the SDK to modify it:
+
+* Launch the __Eclipse__ application.
+* Select the __New Project__ menu item.
+* Choose __Android Project from Existing Code__ from the resulting dialog box, and press __Next__:
+ 
+* Navigate to `hello`, or whichever directory you created for the project, then to the `platforms/android` subdirectory.
+* Press __Finish__.
+
+Once the Eclipse window opens, a red __X__ may appear to indicate
+unresolved problems. If so, follow these additional steps:
+
+* Right-click on the project folder.
+* In the resulting __Properties__ dialog, select __Android__ from the navigation pane.
+* For the project build target, select the highest Android API level you have installed.
+* Click __OK__.
+* Select __Clean__ from the __Project__ menu. This should correct all the errors in the project.
+
+## Deploy to Emulator
+
+You can use the `cordova` utility to run an app in an emulator, or you
+can run it within the SDK. Either way, the SDK must first be
+configured to display at least one device. To do so, use the Android
+SDK Manager, a Java application that runs separately from Eclipse.
+There are two ways to open it:
+
+* Run `android` on the command line.
+
+* From within Eclipse, press this toolbar icon:
+
+ 
+
+Once open, the Android SDK Manager displays various runtime libraries:
+
+
+
+Choose __Tools → Manage AVDs__ (Android Virtual Devices), then
+choose any item from __Device Definitions__ in the resulting dialog
+box:
+
+
+
+Press __Create AVD__, optionally modifying the name, then press __OK__
+to accept the changes:
+
+
+
+The AVD then appears in the __Android Virtual Devices__ list:
+
+
+
+To open the emulator as a separate application, select the AVD and
+press __Start__. It launches much as it would on the device, with
+additional controls available for hardware buttons:
+
+
+
+At this point you can use the `cordova` utility to deploy the
+application to the emulator from the command line:
+
+ $ cordova emulate android
+
+If instead you are working within Eclipse, right-click the project and
+choose __Run As → Android Application__. You may be asked to
+specify an AVD if none are already open.
+
+For a faster experience, use an Intel-based emulator image:
+
+* Install one or more `Intel x86 Atom` System Images as well as the
+ `Intel Hardware Accelerated Execution Manager`, available under
+ __Extras__.
+* Run the Intel installer, which is available within your Android SDK
+ at `extras/intel/Hardware_Accelerated_Execution_Manager`.
+* Create a new AVD with the target set to an Intel image.
+* When starting the emulator, ensure there are no error messages
+ indicating a failure to load HAX modules.
+
+## Deploy to Device
+
+To push an app directly to the device, make sure USB debugging is
+enabled on your device as described on the
+[Android Developer Site](http://developer.android.com/tools/device.html),
+and use a mini USB cable to plug it into your system.
+
+You can push the app to the device from the command line:
+
+ $ cordova run android
+
+Alternately within Eclipse, right-click the project and choose __Run
+As → Android Application__.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/android/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/android/plugin.md b/docs/en/3.0.0rc1/guide/platforms/android/plugin.md
new file mode 100644
index 0000000..dba4f2d
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/android/plugin.md
@@ -0,0 +1,192 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Android Plugins
+
+Writing a plugin requires an understanding of the architecture of Cordova-Android. Cordova-Android consists
+of an Android WebView with hooks attached to it. These plugins are represented as class mappings in the config.xml
+file.
+
+A plugin consists of at least one Java class that extends the `CordovaPlugin` class. A plugin must override one
+of the `execute` methods from `CordovaPlugin`.
+As best practice, the plugin should handle `pause` and `resume` events, and any message passing between plugins.
+Plugins with long-running requests, background activity such as media payback, listeners, or internal state should implement the `onReset()` method as well. This method is run when the `WebView` navigates to a new page or refreshes, which reloads the JavaScript.
+
+## Plugin Class Mapping
+
+The JavaScript portion of a plugin always uses the `cordova.exec` method as follows:
+
+ exec(<successFunction>, <failFunction>, <service>, <action>, [<args>]);
+
+This marshals a request from the WebView to the Android native side,
+more or less boiling down to calling the `action` method on the
+`service` class, with the arguments passed in the `args` Array.
+
+Whether you distribute your plugin as Java file or as a JAR of its own, the plugin must be added to the `config.xml` file in your Cordova-Android application's `res/xml/` folder.
+
+ <plugin name="<service_name>" value="<full_name_including_namespace>"/>
+
+The service name should match the one used in the JavaScript `exec`
+call, and the value is the Java classes full name, including the
+namespace. Otherwise the plugin may compile but still be unreachable
+by Cordova.
+
+## Writing an Android Java Plugin
+
+JavaScript fires off a plugin request to the native side. The Android
+Java plugin is mapped properly via the `config.xml` file. So what
+does the final Android Java Plugin class look like?
+
+What gets dispatched to the plugin via JavaScript's `exec` function gets
+passed into the Plugin class's `execute` method. Most `execute`
+implementations look like this:
+
+ @Override
+ public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
+ if ("beep".equals(action)) {
+ this.beep(args.getLong(0));
+ callbackContext.success();
+ return true;
+ }
+ return false; // Returning false results in a "MethodNotFound" error.
+ }
+
+We compare the value of the `action` parameter, and dispatch the
+request off to a (private) method in the class, optionally passing
+some of the parameters to the method.
+
+When catching exceptions and returning errors, it's important for the
+sake of clarity that errors returned to JavaScript match Java's
+exception names as much as possible.
+
+### Threading
+
+JavaScript in the WebView does *not* run on the UI thread. It runs on
+the WebCore thread. The `execute` method also runs on the WebCore thread.
+
+If you need to interact with the UI, you should use the following:
+
+ @Override
+ public boolean execute(String action, JSONArray args, final CallbackContext callbackContext) throws JSONException {
+ if ("beep".equals(action)) {
+ final long duration = args.getLong(0);
+ cordova.getActivity().runOnUiThread(new Runnable() {
+ public void run() {
+ ...
+ callbackContext.success(); // Thread-safe.
+ }
+ });
+ return true;
+ }
+ return false;
+ }
+
+If you do not need to run on the UI thread, but do not want to block the WebCore thread:
+
+ @Override
+ public boolean execute(String action, JSONArray args, final CallbackContext callbackContext) throws JSONException {
+ if ("beep".equals(action)) {
+ final long duration = args.getLong(0);
+ cordova.getThreadPool().execute(new Runnable() {
+ public void run() {
+ ...
+ callbackContext.success(); // Thread-safe.
+ }
+ });
+ return true;
+ }
+ return false;
+ }
+
+### Echo Android Plugin Example
+
+Add the following to our `config.xml` file:
+
+ <plugin name="Echo" value="org.apache.cordova.plugin.Echo" />
+
+Then add the following file to
+`src/org/apache/cordova/plugin/Echo.java` inside our Cordova-Android
+application:
+
+ package org.apache.cordova.plugin;
+
+ import org.apache.cordova.api.CordovaPlugin;
+ import org.apache.cordova.api.PluginResult;
+ import org.json.JSONArray;
+ import org.json.JSONException;
+ import org.json.JSONObject;
+
+ /**
+ * This class echoes a string called from JavaScript.
+ */
+ public class Echo extends CordovaPlugin {
+ @Override
+ public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
+ if (action.equals("echo")) {
+ String message = args.getString(0);
+ this.echo(message, callbackContext);
+ return true;
+ }
+ return false;
+ }
+
+ private void echo(String message, CallbackContext callbackContext) {
+ if (message != null && message.length() > 0) {
+ callbackContext.success(message);
+ } else {
+ callbackContext.error("Expected one non-empty string argument.");
+ }
+ }
+ }
+
+Let's take a look at the code. The necessary `imports` are at
+the top. Our class extends from `CordovaPlugin`. We override the
+execute() method in order to recieve messages from exec(). Our method
+first compares against `action`: this plugin only supports one action,
+the `echo` action. Any other action returns false, which results in an
+error of type `INVALID_ACTION`, which translates into an error
+callback invocation on the JavaScript side. Next, we grab the echo
+string using the `getString` method on our `args`, telling it we want
+to get the 0th parameter in the parameter array. We do a bit of
+parameter checking: make sure it is not `null`, and make sure it is
+not a zero-length string. If it is, we call `callbackContext.error()`
+(which, by now, you should know invokes the error callback). If all of
+those checks pass, then we call `callbackContext.success()` and pass
+in the `message` string we received as a parameter. This finally
+translates into a success callback invocation on the JavaScript
+side. It also passes the `message` parameter as a parameter into the
+JavaScript success callback function.
+
+## Debugging Plugins
+
+Eclipse can be used to debug an Android project, and the plugins can be debugged if the Java source is included in the project. Only the latest version of the Android Developer Tools is known to allow source code attachment to JAR dependencies, so this is not fully supported at this time.
+
+## Common Pitfalls
+
+* Plugins have access to a `CordovaInterface` object. This object has access to the Android `Activity` that is running the application. This is the `Context` required to launch
+a new Android `Intent`. The `CordovaInterface` allows plugins to start an `Activity` for a result, and to set the callback plugin for when the `Intent` comes back to the application. This is important, since the
+`Intent`s system is how Android communicates between processes.
+* Plugins do not have direct access to the `Context` as they have in the past. The legacy `ctx` member is deprecated, and will be removed six months after 2.0 is released. All of `ctx` methods exist on the `Context`, so both `getContext()` and `getActivity()` are capable of returning the proper object required.
+
+## Use the Source
+
+One of the best ways to prepare yourself to write your own plugin is to
+[look over existing plugins](https://github.com/apache/cordova-android/tree/master/framework/src/org/apache/cordova).
+
+You should also read through the comments in [CordovaPlugin.java](https://github.com/apache/cordova-android/blob/master/framework/src/org/apache/cordova/api/CordovaPlugin.java).
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/android/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/android/tools.md b/docs/en/3.0.0rc1/guide/platforms/android/tools.md
new file mode 100644
index 0000000..09fcfdc
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/android/tools.md
@@ -0,0 +1,80 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Android Command-line Tools
+
+The `cordova` command-line utility is a high-level tool that allows
+you to build applications across several platforms at once. An older
+version of the Cordova framework provides sets of command-line tools
+specific to each platform. To use them as an alternative to the CLI,
+you need to download this version of Cordova from
+[cordova.apache.org](http://cordova.apache.org). The download contains
+separate archives for each platform. Expand the platform you wish to
+target. The tools described here are typically available in the
+top-level `bin` directory, otherwise consult the __README__ file for
+more detailed directions.
+
+## Create a project
+
+Run the `create` command, specifying the existing path to the project,
+the reverse-domain-style package identifier, and the app's display
+name. Here is the syntax for both Mac and Windows:
+
+ $ /path/to/cordova-android/bin/create /path/to/project com.example.project_name ProjectName
+ $ C:\path\to\cordova-android\bin\create.bat C:\path\to\project com.example.project_name ProjectName
+
+## Build
+
+This cleans then builds a project.
+
+Debug, on Mac or Windows:
+
+ $ /path/to/project/cordova/build --debug
+ $ C:\path\to\project\cordova\build.bat --debug
+
+Release, on Mac or Windows:
+
+ $ /path/to/project/cordova/build --release
+ $ C:\path\to\project\cordova\build.bat --release
+
+## Run the App
+
+The `run` command accepts the following _optional_ parameters:
+
+* Target specification. This includes `--emulator`, `--device`, or `--target=<targetID>`.
+* Build specification. This includes `--debug`, `--release`, or `--nobuild`.
+
+ $ /path/to/project/cordova/run [Target] [Build]
+ $ C:\path\to\project\cordova\run.bat [Target] [Build]
+
+Make sure you create at least one Android Virtual Device, otherwise
+you're prompted to do so with the `android` command. If more than one
+AVD is available as a target, you're prompted to select one. By
+default the `run` command detects a connected device, or a currently
+running emulator if no device is found.
+
+## Logging
+
+ $ /path/to/project/cordova/log
+ $ C:\path\to\project\cordova\log.bat
+
+### Cleaning
+
+ $ /path/to/project/cordova/clean
+ $ C:\path\to\project\cordova\clean.bat
[07/12] Version 3.0.0rc1
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/inappbrowser/inappbrowser.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/inappbrowser/inappbrowser.md b/docs/en/3.0.0rc1/cordova/inappbrowser/inappbrowser.md
new file mode 100644
index 0000000..9ad9978
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/inappbrowser/inappbrowser.md
@@ -0,0 +1,486 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+InAppBrowser
+============
+
+> The `InAppBrowser` is a web browser that displays in the app when calling `window.open`.
+
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+
+Description
+-----------
+
+The object returned from a call to `window.open`.
+
+Methods
+----------
+
+- addEventListener
+- removeEventListener
+- close
+- show
+- executeScript
+- insertCSS
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="InAppBrowser" value="org.apache.cordova.InAppBrowser" />
+
+### iOS
+
+#### config.xml
+
+ <plugin name="InAppBrowser" value="CDVInAppBrowser" />
+
+### Windows Phone 7 + 8
+
+#### config.xml
+
+ <plugin name="InAppBrowser" />
+
+addEventListener
+================
+
+> Adds a listener for an event from the `InAppBrowser`.
+
+ ref.addEventListener(eventname, callback);
+
+- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
+- __eventname__: the event to listen for _(String)_
+
+ - __loadstart__: event fires when the `InAppBrowser` starts to load a URL.
+ - __loadstop__: event fires when the `InAppBrowser` finishes loading a URL.
+ - __loaderror__: event fires when the `InAppBrowser` encounters an error when loading a URL.
+ - __exit__: event fires when the `InAppBrowser` window is closed.
+
+- __callback__: the function that executes when the event fires. The function is passed an `InAppBrowserEvent` object as a parameter.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+- Windows Phone 7 + 8
+
+Quick Example
+-------------
+
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ ref.addEventListener('loadstart', function() { alert(event.url); });
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>InAppBrowser.addEventListener Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ ref.addEventListener('loadstart', function(event) { alert('start: ' + event.url); });
+ ref.addEventListener('loadstop', function(event) { alert('stop: ' + event.url); });
+ ref.addEventListener('loaderror', function(event) { alert('error: ' + event.message); });
+ ref.addEventListener('exit', function(event) { alert(event.type); });
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+ </html>
+
+removeEventListener
+===================
+
+> Removes a listener for an event from the `InAppBrowser`.
+
+ ref.removeEventListener(eventname, callback);
+
+- __ref__: reference to the `InAppBrowser` window. _(InAppBrowser)_
+- __eventname__: the event to stop listening for. _(String)_
+
+ - __loadstart__: event fires when the `InAppBrowser` starts to load a URL.
+ - __loadstop__: event fires when the `InAppBrowser` finishes loading a URL.
+ - __loaderror__: event fires when the `InAppBrowser` encounters an error loading a URL.
+ - __exit__: event fires when the `InAppBrowser` window is closed.
+
+- __callback__: the function to execute when the event fires.
+The function is passed an `InAppBrowserEvent` object.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+- Windows Phone 7 + 8
+
+Quick Example
+-------------
+
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ var myCallback = function() { alert(event.url); }
+ ref.addEventListener('loadstart', myCallback);
+ ref.removeEventListener('loadstart', myCallback);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>InAppBrowser.removeEventListener Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Global InAppBrowser reference
+ var iabRef = null;
+
+ function iabLoadStart(event) {
+ alert(event.type + ' - ' + event.url);
+ }
+
+ function iabLoadStop(event) {
+ alert(event.type + ' - ' + event.url);
+ }
+
+ function iabLoadError(event) {
+ alert(event.type + ' - ' + event.message);
+ }
+
+ function iabClose(event) {
+ alert(event.type);
+ iabRef.removeEventListener('loadstart', iabLoadStart);
+ iabRef.removeEventListener('loadstop', iabLoadStop);
+ iabRef.removeEventListener('loaderror', iabLoadError);
+ iabRef.removeEventListener('exit', iabClose);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ iabRef = window.open('http://apache.org', '_blank', 'location=yes');
+ iabRef.addEventListener('loadstart', iabLoadStart);
+ iabRef.addEventListener('loadstop', iabLoadStop);
+ iabRef.removeEventListener('loaderror', iabLoadError);
+ iabRef.addEventListener('exit', iabClose);
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+ </html>
+
+close
+=====
+
+> Closes the `InAppBrowser` window.
+
+ ref.close();
+
+- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+- Windows Phone 7 + 8
+- BlackBerry 10
+
+Quick Example
+-------------
+
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ ref.close();
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>InAppBrowser.close Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ // close InAppBrowser after 5 seconds
+ setTimeout(function() {
+ ref.close();
+ }, 5000);
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+ </html>
+
+show
+=====
+
+> Displays an InAppBrowser window that was opened hidden. Calling this has no effect if the InAppBrowser was already visible.
+
+ ref.show();
+
+- __ref:__ reference to the InAppBrowser window (`InAppBrowser`)
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ var ref = window.open('http://apache.org', '_blank', 'hidden=yes');
+ ref.show();
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>InAppBrowser.show Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var ref = window.open('http://apache.org', '_blank', 'hidden=yes');
+ ref.addEventListener('loadstop', function(event) {
+ alert('background window loaded');
+ });
+ // close InAppBrowser after 5 seconds
+ setTimeout(function() {
+ ref.close();
+ }, 5000);
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+ </html>
+
+
+executeScript
+=============
+
+> Injects JavaScript code into the `InAppBrowser` window
+
+ ref.executeScript(details, callback);
+
+- __ref__: reference to the `InAppBrowser` window. _(InAppBrowser)_
+- __injectDetails__: details of the script to run, specifying either a `file` or `code` key. _(Object)_
+ - __file__: URL of the script to inject.
+ - __code__: Text of the script to inject.
+- __callback__: the function that executes after the JavaScript code is injected.
+ - If the injected script is of type `code`, the callback executes
+ with a single parameter, which is the return value of the
+ script, wrapped in an `Array`. For multi-line scripts, this is
+ the return value of the last statement, or the last expression
+ evaluated.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ ref.addEventListener('loadstop', function() {
+ ref.executeSript({file: "myscript.js"});
+ });
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>InAppBrowser.executeScript Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Global InAppBrowser reference
+ var iabRef = null;
+
+ // Inject our custom JavaScript into the InAppBrowser window
+ //
+ function replaceHeaderImage() {
+ iabRef.executeScript({
+ code: "var img=document.querySelector('#header img'); img.src='http://cordova.apache.org/images/cordova_bot.png';"
+ }, function() {
+ alert("Image Element Successfully Hijacked");
+ }
+ }
+
+ function iabClose(event) {
+ iabRef.removeEventListener('loadstop', replaceHeaderImage);
+ iabRef.removeEventListener('exit', iabClose);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ iabRef = window.open('http://apache.org', '_blank', 'location=yes');
+ iabRef.addEventListener('loadstop', replaceHeaderImage);
+ iabRef.addEventListener('exit', iabClose);
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+ </html>
+
+insertCSS
+=========
+
+> Injects CSS into the `InAppBrowser` window.
+
+ ref.insertCSS(details, callback);
+
+- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
+- __injectDetails__: details of the script to run, specifying either a `file` or `code` key. _(Object)_
+ - __file__: URL of the stylesheet to inject.
+ - __code__: Text of the stylesheet to inject.
+- __callback__: the function that executes after the CSS is injected.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ ref.addEventListener('loadstop', function() {
+ ref.insertCSS({file: "mystyles.css"});
+ });
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>InAppBrowser.insertCSS Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Global InAppBrowser reference
+ var iabRef = null;
+
+ // Inject our custom CSS into the InAppBrowser window
+ //
+ function changeBackgroundColor() {
+ iabRef.insertCSS({
+ code: "body { background: #ffff00"
+ }, function() {
+ alert("Styles Altered");
+ }
+ }
+
+ function iabClose(event) {
+ iabRef.removeEventListener('loadstop', changeBackgroundColor);
+ iabRef.removeEventListener('exit', iabClose);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ iabRef = window.open('http://apache.org', '_blank', 'location=yes');
+ iabRef.addEventListener('loadstop', changeBackgroundColor);
+ iabRef.addEventListener('exit', iabClose);
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+ </html>
+
+InAppBrowserEvent
+=================
+
+The object that is passed to the callback function from an
+`addEventListener` call on an `InAppBrowser` object.
+
+Properties
+----------
+
+- __type__: the eventname, either `loadstart`, `loadstop`, `loaderror`, or `exit`. _(String)_
+- __url__: the URL that was loaded. _(String)_
+- __code__: the error code, only in the case of `loaderror`. _(Number)_
+- __message__: the error message, only in the case of `loaderror`. _(String)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/inappbrowser/window.open.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/inappbrowser/window.open.md b/docs/en/3.0.0rc1/cordova/inappbrowser/window.open.md
new file mode 100644
index 0000000..a08c917
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/inappbrowser/window.open.md
@@ -0,0 +1,102 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+window.open
+===========
+
+Opens a URL in a new `InAppBrowser` instance, the current browser
+instance, or the system browser.
+
+ var ref = window.open(url, target, options);
+
+- __ref__: Reference to the `InAppBrowser` window. _(InAppBrowser)_
+- __url__: The URL to load _(String)_. Call `encodeURI()` on this if the URL contains Unicode characters.
+- __target__: The target in which to load the URL, an optional parameter that defaults to `_self`. _(String)_
+
+ - `_self`: Opens in the Cordova WebView if the URL is in the white list, otherwise it opens in the `InAppBrowser`.
+ - `_blank`: Opens in the `InAppBrowser`.
+ - `_system`: Opens in the system's web browser.
+
+- __options__: Options for the `InAppBrowser`. Optional, defaulting to: `location=yes`. _(String)_
+
+ The `options` string must not contain any blank space, and each feature's name/value pairs must be separated by a comma. Feature names are case insensitive. All platforms support the value below:
+
+ - __location__: Set to `yes` or `no` to turn the `InAppBrowser`'s location bar on or off.
+
+ Android only
+ --------------------
+ - __closebuttoncaption__ - set to a string that will be the caption for the "Done" button.
+ - __hidden__ - set to 'yes' to create the browser and load the page, but not show it. The load event will fire when loading is complete. Omit or set to 'no' (default) to have the browser open and load normally.
+
+ iOS only
+ --------
+ - __closebuttoncaption__ - set to a string that will be the caption for the "Done" button. Note that you will have to localize this value yourself.
+ - __hidden__ - set to 'yes' to create the browser and load the page, but not show it. The load event will fire when loading is complete. Omit or set to 'no' (default) to have the browser open and load normally.
+ - __toolbar__ - set to 'yes' or 'no' to turn the toolbar on or off for the InAppBrowser (defaults to 'yes')
+ - __enableViewportScale__: Set to `yes` or `no` to prevent viewport scaling through a meta tag (defaults to `no`).
+ - __mediaPlaybackRequiresUserAction__: Set to `yes` or `no` to prevent HTML5 audio or video from autoplaying (defaults to `no`).
+ - __allowInlineMediaPlayback__: Set to `yes` or `no` to allow inline HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. The HTML's `video` element must also include the `webkit-playsinline` attribute (defaults to `no`)
+ - __keyboardDisplayRequiresUserAction__: Set to `yes` or `no` to open the keyboard when form elements receive focus via JavaScript's `focus()` call (defaults to `yes`).
+ - __suppressesIncrementalRendering__: Set to `yes` or `no` to wait until all new view content is received before being rendered (defaults to `no`).
+ - __presentationstyle__: Set to `pagesheet`, `formsheet` or `fullscreen` to set the [presentation style](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle) (defaults to `fullscreen`).
+ - __transitionstyle__: Set to `fliphorizontal`, `crossdissolve` or `coververtical` to set the [transition style](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle) (defaults to `coververtical`).
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+- BlackBerry 10
+- Windows Phone 7 + 8
+
+Quick Example
+-------------
+
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ var ref2 = window.open(encodeURI('http://ja.m.wikipedia.org/wiki/ハングル'), '_blank', 'location=yes');
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>window.open Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // external url
+ var ref = window.open(encodeURI('http://apache.org'), '_blank', 'location=yes');
+ // relative document
+ ref = window.open('next.html', '_self');
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/MediaError/mediaError.md b/docs/en/3.0.0rc1/cordova/media/MediaError/mediaError.md
new file mode 100644
index 0000000..5652a27
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/MediaError/mediaError.md
@@ -0,0 +1,45 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+MediaError
+==========
+
+A `MediaError` object is returned to the `mediaError` callback
+function when an error occurs.
+
+Properties
+----------
+
+- __code__: One of the predefined error codes listed below.
+- __message__: An error message describing the details of the error.
+
+Constants
+---------
+
+- `MediaError.MEDIA_ERR_ABORTED`
+- `MediaError.MEDIA_ERR_NETWORK`
+- `MediaError.MEDIA_ERR_DECODE`
+- `MediaError.MEDIA_ERR_NONE_SUPPORTED`
+
+Description
+-----------
+
+The `MediaError` object is passed to a `mediaError` callback function
+when an error occurs.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/Parameters/mediaError.md b/docs/en/3.0.0rc1/cordova/media/Parameters/mediaError.md
new file mode 100644
index 0000000..08b4400
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/Parameters/mediaError.md
@@ -0,0 +1,33 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+mediaError
+==========
+
+A user-specified callback function that executes when there is an
+error in media functions.
+
+ function(error) {
+ // Handle the error
+ }
+
+Parameters
+----------
+
+- __error__: The error returned by the device. _(MediaError)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/CaptureCB.md b/docs/en/3.0.0rc1/cordova/media/capture/CaptureCB.md
new file mode 100644
index 0000000..d1d7599
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/CaptureCB.md
@@ -0,0 +1,47 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+CaptureCB
+=========
+
+> Invoked upon a successful media capture operation.
+
+ function captureSuccess( MediaFile[] mediaFiles ) { ... };
+
+Description
+-----------
+
+This function executes after a successful capture operation completes.
+At this point a media file has been captured, and either the user has
+exited the media capture application, or the capture limit has been
+reached.
+
+Each `MediaFile` object describes a captured media file.
+
+Quick Example
+-------------
+
+ // capture callback
+ function captureSuccess(mediaFiles) {
+ var i, path, len;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
+ // do something interesting with the file
+ }
+ };
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/CaptureError.md b/docs/en/3.0.0rc1/cordova/media/capture/CaptureError.md
new file mode 100644
index 0000000..eb4a57d
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/CaptureError.md
@@ -0,0 +1,37 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+CaptureError
+============
+
+> Encapsulates the error code resulting from a failed media capture operation.
+
+Properties
+----------
+
+- __code__: One of the pre-defined error codes listed below.
+
+Constants
+---------
+
+- `CaptureError.CAPTURE_INTERNAL_ERR`: The camera or microphone failed to capture image or sound.
+- `CaptureError.CAPTURE_APPLICATION_BUSY`: The camera or audio capture application is currently serving another capture request.
+- `CaptureError.CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. the value of `limit` is less than one).
+- `CaptureError.CAPTURE_NO_MEDIA_FILES`: The user exits the camera or audio capture application before capturing anything.
+- `CaptureError.CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/CaptureErrorCB.md b/docs/en/3.0.0rc1/cordova/media/capture/CaptureErrorCB.md
new file mode 100644
index 0000000..f3771e6
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/CaptureErrorCB.md
@@ -0,0 +1,44 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+CaptureErrorCB
+==============
+
+> Invoked if an error occurs during a media capture operation.
+
+ function captureError( CaptureError error ) { ... };
+
+Description
+-----------
+
+This function executes if an error occurs when trying to launch a
+media capture operation. Failure scenarios include when the capture
+application is busy, a capture operation is already taking place, or
+the user cancels the operation before any media files are captured.
+
+This function executes with a `CaptureError` object containing an
+appropriate error `code`.
+
+Quick Example
+-------------
+
+ // capture error callback
+ var captureError = function(error) {
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
+ };
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/ConfigurationData.md b/docs/en/3.0.0rc1/cordova/media/capture/ConfigurationData.md
new file mode 100644
index 0000000..361f45a
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/ConfigurationData.md
@@ -0,0 +1,63 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+ConfigurationData
+=================
+
+> Encapsulates a set of media capture parameters that a device supports.
+
+Description
+-----------
+
+Describes media capture modes supported by the device. The
+configuration data includes the MIME type, and capture dimensions for
+video or image capture.
+
+The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). Examples:
+
+- `video/3gpp`
+- `video/quicktime`
+- `image/jpeg`
+- `audio/amr`
+- `audio/wav`
+
+Properties
+----------
+
+- __type__: The ASCII-encoded lowercase string representing the media type. (DOMString)
+- __height__: The height of the image or video in pixels. The value is zero for sound clips. (Number)
+- __width__: The width of the image or video in pixels. The value is zero for sound clips. (Number)
+
+Quick Example
+-------------
+
+ // retrieve supported image modes
+ var imageModes = navigator.device.capture.supportedImageModes;
+
+ // Select mode that has the highest horizontal resolution
+ var width = 0;
+ var selectedmode;
+ for each (var mode in imageModes) {
+ if (mode.width > width) {
+ width = mode.width;
+ selectedmode = mode;
+ }
+ }
+
+Not supported by any platform. All configuration data arrays are empty.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/MediaFile.getFormatData.md b/docs/en/3.0.0rc1/cordova/media/capture/MediaFile.getFormatData.md
new file mode 100644
index 0000000..321958c
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/MediaFile.getFormatData.md
@@ -0,0 +1,64 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+MediaFile.getFormatData
+=======================
+
+> Retrieves format information about the media capture file.
+
+ mediaFile.getFormatData(
+ MediaFileDataSuccessCB successCallback,
+ [MediaFileDataErrorCB errorCallback]
+ );
+
+Description
+-----------
+
+This function asynchronously attempts to retrieve the format
+information for the media file. If successful, it invokes the
+`MediaFileDataSuccessCB` callback with a `MediaFileData` object. If
+the attempt fails, this function invokes the `MediaFileDataErrorCB`
+callback.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+BlackBerry WebWorks Quirks
+--------------------------
+
+Does not provide an API for information about media files, so all
+`MediaFileData` objects return with default values.
+
+Android Quirks
+--------------
+
+The API to access media file format information is limited, so not all
+`MediaFileData` properties are supported.
+
+iOS Quirks
+----------
+
+The API to access media file format information is limited, so not all
+`MediaFileData` properties are supported.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/MediaFile.md b/docs/en/3.0.0rc1/cordova/media/capture/MediaFile.md
new file mode 100644
index 0000000..3bca7aa
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/MediaFile.md
@@ -0,0 +1,37 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+MediaFile
+=========
+
+> Encapsulates properties of a media capture file.
+
+Properties
+----------
+
+- __name__: The name of the file, without path information. (DOMString)
+- __fullPath__: The full path of the file, including the name. (DOMString)
+- __type__: The file's mime type (DOMString)
+- __lastModifiedDate__: The date and time when the file was last modified. (Date)
+- __size__: The size of the file, in bytes. (Number)
+
+Methods
+-------
+
+- __MediaFile.getFormatData__: Retrieves the format information of the media file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/MediaFileData.md b/docs/en/3.0.0rc1/cordova/media/capture/MediaFileData.md
new file mode 100644
index 0000000..5458b68
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/MediaFileData.md
@@ -0,0 +1,65 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+MediaFileData
+=============
+
+> Encapsulates format information about a media file.
+
+Properties
+----------
+
+- __codecs__: The actual format of the audio and video content. (DOMString)
+- __bitrate__: The average bitrate of the content. The value is zero for images. (Number)
+- __height__: The height of the image or video in pixels. The value is zero for audio clips. (Number)
+- __width__: The width of the image or video in pixels. The value is zero for audio clips. (Number)
+- __duration__: The length of the video or sound clip in seconds. The value is zero for images. (Number)
+
+BlackBerry WebWorks Quirks
+--------------------------
+
+No API provides format information for media files, so the
+`MediaFileData` object returned by `MediaFile.getFormatData` features
+the following default values:
+
+- __codecs__: Not supported, and returns `null`.
+- __bitrate__: Not supported, and returns zero.
+- __height__: Not supported, and returns zero.
+- __width__: Not supported, and returns zero.
+- __duration__: Not supported, and returns zero.
+
+Android Quirks
+--------------
+Supports the following `MediaFileData` properties:
+
+- __codecs__: Not supported, and returns `null`.
+- __bitrate__: Not supported, and returns zero.
+- __height__: Supported: image and video files only.
+- __width__: Supported: image and video files only.
+- __duration__: Supported: audio and video files only.
+
+iOS Quirks
+----------
+Supports the following `MediaFileData` properties:
+
+- __codecs__: Not supported, and returns null.
+- __bitrate__: Supported on iOS4 devices for audio only. Returns zero for images and videos.
+- __height__: Supported: image and video files only.
+- __width__: Supported: image and video files only.
+- __duration__: Supported: audio and video files only.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/capture.md b/docs/en/3.0.0rc1/cordova/media/capture/capture.md
new file mode 100644
index 0000000..ca184bb
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/capture.md
@@ -0,0 +1,121 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Capture
+=======
+
+> Provides access to the device's audio, image, and video capture capabilities.
+
+**Important privacy note:** Collection and use of images, video, or audio from the device's camera or microphone raises important privacy issues. Your app's privacy policy should discuss how the app uses such sensors and whether the data recorded is shared with any other parties. In addition, if the app's use of the camera or microphone is not apparent in the user interface, you should provide a just-in-time notice prior to your app accessing the camera or microphone (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for "OK" and "No Thanks"). Note that some app marketplaces may require your app to provide just-in-time notice and obtain permission from the user prior to accessing the camera or microphone. For more information, please see the Privacy Guide.
+
+Objects
+-------
+
+- Capture
+- CaptureAudioOptions
+- CaptureImageOptions
+- CaptureVideoOptions
+- CaptureCallback
+- CaptureErrorCB
+- ConfigurationData
+- MediaFile
+- MediaFileData
+
+Methods
+-------
+
+- capture.captureAudio
+- capture.captureImage
+- capture.captureVideo
+- MediaFile.getFormatData
+
+Scope
+-----
+
+The `capture` object is assigned to the `navigator.device` object, and
+therefore has global scope.
+
+ // The global capture object
+ var capture = navigator.device.capture;
+
+Properties
+----------
+
+- __supportedAudioModes__: The audio recording formats supported by the device. (ConfigurationData[])
+- __supportedImageModes__: The recording image sizes and formats supported by the device. (ConfigurationData[])
+- __supportedVideoModes__: The recording video resolutions and formats supported by the device. (ConfigurationData[])
+
+Methods
+-------
+
+- `capture.captureAudio`: Launch the device's audio recording application to record audio clips.
+- `capture.captureImage`: Launch the device's camera application to take photos.
+- `capture.captureVideo`: Launch the device's video recorder application to record videos.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/plugins.xml
+
+ <plugin name="Capture" value="org.apache.cordova.Capture"/>
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.RECORD_AUDIO" />
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture" />
+
+#### www/config.xml
+
+ <feature id="blackberry.system" required="true" version="1.0.0.0" />
+ <feature id="blackberry.io.file" required="true" version="1.0.0.0" />
+
+### iOS
+
+#### config.xml
+
+ <plugin name="Capture" value="CDVCapture" />
+
+### Windows Phone
+
+#### Properties/WPAppManifest.xml
+
+ <Capabilities>
+ <Capability Name="ID_CAP_MEDIALIB" />
+ <Capability Name="ID_CAP_MICROPHONE" />
+ <Capability Name="ID_HW_FRONTCAMERA" />
+ <Capability Name="ID_CAP_ISV_CAMERA" />
+ <Capability Name="ID_CAP_CAMERA" />
+ </Capabilities>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/captureAudio.md b/docs/en/3.0.0rc1/cordova/media/capture/captureAudio.md
new file mode 100644
index 0000000..f6d9772
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/captureAudio.md
@@ -0,0 +1,152 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+capture.captureAudio
+====================
+
+> Start the audio recorder application and return information about the captured audio clip file(s).
+
+ navigator.device.capture.captureAudio(
+ CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
+ );
+
+Description
+-----------
+
+Starts an asynchronous operation to capture audio recordings using the
+device's default audio recording application. The operation allows
+the device user to capture multiple recordings in a single session.
+
+The capture operation ends when either the user exits the audio
+recording application, or the maximum number of recordings specified
+by `CaptureAudioOptions.limit` is reached. If no `limit` parameter
+value is specified, it defaults to one (1), and the capture operation
+terminates after the user records a single audio clip.
+
+When the capture operation finishes, the `CaptureCallback` executes
+with an array of `MediaFile` objects describing each captured audio
+clip file. If the user terminates the operation before an audio clip
+is captured, the `CaptureErrorCallback` executes with a `CaptureError`
+object, featuring the `CaptureError.CAPTURE_NO_MEDIA_FILES` error
+code.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // capture callback
+ var captureSuccess = function(mediaFiles) {
+ var i, path, len;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
+ // do something interesting with the file
+ }
+ };
+
+ // capture error callback
+ var captureError = function(error) {
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
+ };
+
+ // start audio capture
+ navigator.device.capture.captureAudio(captureSuccess, captureError, {limit:2});
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Capture Audio</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8" src="json2.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Called when capture operation is finished
+ //
+ function captureSuccess(mediaFiles) {
+ var i, len;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ uploadFile(mediaFiles[i]);
+ }
+ }
+
+ // Called if something bad happens.
+ //
+ function captureError(error) {
+ var msg = 'An error occurred during capture: ' + error.code;
+ navigator.notification.alert(msg, null, 'Uh oh!');
+ }
+
+ // A button will call this function
+ //
+ function captureAudio() {
+ // Launch device audio recording application,
+ // allowing user to capture up to 2 audio clips
+ navigator.device.capture.captureAudio(captureSuccess, captureError, {limit: 2});
+ }
+
+ // Upload files to server
+ function uploadFile(mediaFile) {
+ var ft = new FileTransfer(),
+ path = mediaFile.fullPath,
+ name = mediaFile.name;
+
+ ft.upload(path,
+ "http://my.domain.com/upload.php",
+ function(result) {
+ console.log('Upload success: ' + result.responseCode);
+ console.log(result.bytesSent + ' bytes sent');
+ },
+ function(error) {
+ console.log('Error uploading file ' + path + ': ' + error.code);
+ },
+ { fileName: name });
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="captureAudio();">Capture Audio</button> <br>
+ </body>
+ </html>
+
+BlackBerry WebWorks Quirks
+--------------------------
+
+- Cordova for BlackBerry WebWorks attempts to launch the __Voice Notes Recorder__ application, provided by RIM, to capture audio recordings. The app receives a `CaptureError.CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
+
+iOS Quirks
+----------
+
+- iOS does not have a default audio recording application, so a simple user interface is provided.
+
+Windows Phone 7 and 8 Quirks
+----------
+
+- Windows Phone 7 does not have a default audio recording application, so a simple user interface is provided.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/captureAudioOptions.md b/docs/en/3.0.0rc1/cordova/media/capture/captureAudioOptions.md
new file mode 100644
index 0000000..c7d7ac2
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/captureAudioOptions.md
@@ -0,0 +1,52 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+CaptureAudioOptions
+===================
+
+> Encapsulates audio capture configuration options.
+
+Properties
+----------
+
+- __limit__: The maximum number of audio clips the device user can record in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+- __duration__: The maximum duration of an audio sound clip, in seconds.
+
+Quick Example
+-------------
+
+ // limit capture operation to 3 media files, no longer than 10 seconds each
+ var options = { limit: 3, duration: 10 };
+
+ navigator.device.capture.captureAudio(captureSuccess, captureError, options);
+
+Android Quirks
+--------------
+
+- The `duration` parameter is not supported. Recording lengths cannot be limited programmatically.
+
+BlackBerry WebWorks Quirks
+--------------------------
+
+- The `duration` parameter is not supported. Recording lengths cannot be limited programmatically.
+
+iOS Quirks
+----------
+
+- The `limit` parameter is not supported, so only one recording can be created for each invocation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/captureImage.md b/docs/en/3.0.0rc1/cordova/media/capture/captureImage.md
new file mode 100644
index 0000000..ac89e44
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/captureImage.md
@@ -0,0 +1,143 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+capture.captureImage
+====================
+
+> Start the camera application and return information about captured image file(s).
+
+ navigator.device.capture.captureImage(
+ CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
+ );
+
+Description
+-----------
+
+Starts an asynchronous operation to capture images using the device's
+camera application. The operation allows users to capture more than
+one image in a single session.
+
+The capture operation ends either when the user closes the camera
+application, or the maximum number of recordings specified by
+`CaptureAudioOptions.limit` is reached. If no `limit` value is
+specified, it defaults to one (1), and the capture operation
+terminates after the user captures a single image.
+
+When the capture operation finishes, it invokes the `CaptureCB`
+callback with an array of `MediaFile` objects describing each captured
+image file. If the user terminates the operation before capturing an
+image, the `CaptureErrorCB` callback executes with a `CaptureError`
+object featuring a `CaptureError.CAPTURE_NO_MEDIA_FILES` error code.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Windows Phone 7 Quirks
+----------------------
+
+Invoking the native camera application while your device is connected
+via Zune does not work, and the error callback executes.
+
+Quick Example
+-------------
+
+ // capture callback
+ var captureSuccess = function(mediaFiles) {
+ var i, path, len;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
+ // do something interesting with the file
+ }
+ };
+
+ // capture error callback
+ var captureError = function(error) {
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
+ };
+
+ // start image capture
+ navigator.device.capture.captureImage(captureSuccess, captureError, {limit:2});
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Capture Image</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8" src="json2.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Called when capture operation is finished
+ //
+ function captureSuccess(mediaFiles) {
+ var i, len;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ uploadFile(mediaFiles[i]);
+ }
+ }
+
+ // Called if something bad happens.
+ //
+ function captureError(error) {
+ var msg = 'An error occurred during capture: ' + error.code;
+ navigator.notification.alert(msg, null, 'Uh oh!');
+ }
+
+ // A button will call this function
+ //
+ function captureImage() {
+ // Launch device camera application,
+ // allowing user to capture up to 2 images
+ navigator.device.capture.captureImage(captureSuccess, captureError, {limit: 2});
+ }
+
+ // Upload files to server
+ function uploadFile(mediaFile) {
+ var ft = new FileTransfer(),
+ path = mediaFile.fullPath,
+ name = mediaFile.name;
+
+ ft.upload(path,
+ "http://my.domain.com/upload.php",
+ function(result) {
+ console.log('Upload success: ' + result.responseCode);
+ console.log(result.bytesSent + ' bytes sent');
+ },
+ function(error) {
+ console.log('Error uploading file ' + path + ': ' + error.code);
+ },
+ { fileName: name });
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="captureImage();">Capture Image</button> <br>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/captureImageOptions.md b/docs/en/3.0.0rc1/cordova/media/capture/captureImageOptions.md
new file mode 100644
index 0000000..b751bd1
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/captureImageOptions.md
@@ -0,0 +1,41 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+CaptureImageOptions
+===================
+
+> Encapsulates image capture configuration options.
+
+Properties
+----------
+
+- __limit__: The maximum number of images the user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+
+Quick Example
+-------------
+
+ // limit capture operation to 3 images
+ var options = { limit: 3 };
+
+ navigator.device.capture.captureImage(captureSuccess, captureError, options);
+
+iOS Quirks
+----------
+
+- The __limit__ parameter is not supported, and only one image is taken per invocation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/captureVideo.md b/docs/en/3.0.0rc1/cordova/media/capture/captureVideo.md
new file mode 100644
index 0000000..0077183
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/captureVideo.md
@@ -0,0 +1,143 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+capture.captureVideo
+====================
+
+> Start the video recorder application and return information about captured video clip file(s).
+
+ navigator.device.capture.captureVideo(
+ CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureVideoOptions options]
+ );
+
+Description
+-----------
+
+Starts an asynchronous operation to capture video recordings using the
+device's video recording application. The operation allows the user
+to capture more than one recordings in a single session.
+
+The capture operation ends when either the user exits the video
+recording application, or the maximum number of recordings specified
+by `CaptureVideoOptions.limit` is reached. If no `limit` parameter
+value is specified, it defaults to one (1), and the capture operation
+terminates after the user records a single video clip.
+
+When the capture operation finishes, it the `CaptureCB` callback
+executes with an array of `MediaFile` objects describing each captured
+video clip file. If the user terminates the operation before
+capturing a video clip, the `CaptureErrorCB` callback executes with a
+`CaptureError` object featuring a
+`CaptureError.CAPTURE_NO_MEDIA_FILES` error code.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // capture callback
+ var captureSuccess = function(mediaFiles) {
+ var i, path, len;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ path = mediaFiles[i].fullPath;
+ // do something interesting with the file
+ }
+ };
+
+ // capture error callback
+ var captureError = function(error) {
+ navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error');
+ };
+
+ // start video capture
+ navigator.device.capture.captureVideo(captureSuccess, captureError, {limit:2});
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Capture Video</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8" src="json2.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Called when capture operation is finished
+ //
+ function captureSuccess(mediaFiles) {
+ var i, len;
+ for (i = 0, len = mediaFiles.length; i < len; i += 1) {
+ uploadFile(mediaFiles[i]);
+ }
+ }
+
+ // Called if something bad happens.
+ //
+ function captureError(error) {
+ var msg = 'An error occurred during capture: ' + error.code;
+ navigator.notification.alert(msg, null, 'Uh oh!');
+ }
+
+ // A button will call this function
+ //
+ function captureVideo() {
+ // Launch device video recording application,
+ // allowing user to capture up to 2 video clips
+ navigator.device.capture.captureVideo(captureSuccess, captureError, {limit: 2});
+ }
+
+ // Upload files to server
+ function uploadFile(mediaFile) {
+ var ft = new FileTransfer(),
+ path = mediaFile.fullPath,
+ name = mediaFile.name;
+
+ ft.upload(path,
+ "http://my.domain.com/upload.php",
+ function(result) {
+ console.log('Upload success: ' + result.responseCode);
+ console.log(result.bytesSent + ' bytes sent');
+ },
+ function(error) {
+ console.log('Error uploading file ' + path + ': ' + error.code);
+ },
+ { fileName: name });
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="captureVideo();">Capture Video</button> <br>
+ </body>
+ </html>
+
+BlackBerry WebWorks Quirks
+--------------------------
+
+- Cordova for BlackBerry WebWorks attempts to launch the __Video Recorder__ application, provided by RIM, to capture video recordings. The app receives a `CaptureError.CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/capture/captureVideoOptions.md b/docs/en/3.0.0rc1/cordova/media/capture/captureVideoOptions.md
new file mode 100644
index 0000000..769e2ac
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/capture/captureVideoOptions.md
@@ -0,0 +1,48 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+CaptureVideoOptions
+===================
+
+> Encapsulates video capture configuration options.
+
+Properties
+----------
+
+- __limit__: The maximum number of video clips the device's user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
+- __duration__: The maximum duration of a video clip, in seconds.
+
+Quick Example
+-------------
+
+ // limit capture operation to 3 video clips
+ var options = { limit: 3 };
+
+ navigator.device.capture.captureVideo(captureSuccess, captureError, options);
+
+BlackBerry WebWorks Quirks
+--------------------------
+
+- The __duration__ parameter is not supported, so the length of recordings cannot be limited programmatically.
+
+iOS Quirks
+----------
+
+- The __limit__ parameter is not supported. Only one video is recorded per invocation.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/media.getCurrentPosition.md b/docs/en/3.0.0rc1/cordova/media/media.getCurrentPosition.md
new file mode 100644
index 0000000..5383e48
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/media.getCurrentPosition.md
@@ -0,0 +1,176 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+media.getCurrentPosition
+========================
+
+Returns the current position within an audio file.
+
+ media.getCurrentPosition(mediaSuccess, [mediaError]);
+
+Parameters
+----------
+
+- __mediaSuccess__: The callback that is passed the current position in seconds.
+- __mediaError__: (Optional) The callback to execute if an error occurs.
+
+Description
+-----------
+
+An asynchronous function that returns the current position of the
+underlying audio file of a `Media` object. Also updates the `Media`
+object's `position` parameter.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Audio player
+ //
+ var my_media = new Media(src, onSuccess, onError);
+
+ // Update media position every second
+ var mediaTimer = setInterval(function () {
+ // get media position
+ my_media.getCurrentPosition(
+ // success callback
+ function (position) {
+ if (position > -1) {
+ console.log((position) + " sec");
+ }
+ },
+ // error callback
+ function (e) {
+ console.log("Error getting pos=" + e);
+ }
+ );
+ }, 1000);
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Media Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
+ }
+
+ // Audio player
+ //
+ var my_media = null;
+ var mediaTimer = null;
+
+ // Play audio
+ //
+ function playAudio(src) {
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
+
+ // Play audio
+ my_media.play();
+
+ // Update my_media position every second
+ if (mediaTimer == null) {
+ mediaTimer = setInterval(function() {
+ // get my_media position
+ my_media.getCurrentPosition(
+ // success callback
+ function(position) {
+ if (position > -1) {
+ setAudioPosition((position) + " sec");
+ }
+ },
+ // error callback
+ function(e) {
+ console.log("Error getting pos=" + e);
+ setAudioPosition("Error: " + e);
+ }
+ );
+ }, 1000);
+ }
+ }
+
+ // Pause audio
+ //
+ function pauseAudio() {
+ if (my_media) {
+ my_media.pause();
+ }
+ }
+
+ // Stop audio
+ //
+ function stopAudio() {
+ if (my_media) {
+ my_media.stop();
+ }
+ clearInterval(mediaTimer);
+ mediaTimer = null;
+ }
+
+ // onSuccess Callback
+ //
+ function onSuccess() {
+ console.log("playAudio():Audio Success");
+ }
+
+ // onError Callback
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Set audio position
+ //
+ function setAudioPosition(position) {
+ document.getElementById('audio_position').innerHTML = position;
+ }
+
+ </script>
+ </head>
+ <body>
+ <a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
+ <a href="#" class="btn large" onclick="pauseAudio();">Pause Playing Audio</a>
+ <a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
+ <p id="audio_position"></p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/media.getDuration.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/media.getDuration.md b/docs/en/3.0.0rc1/cordova/media/media.getDuration.md
new file mode 100644
index 0000000..c8c92e9
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/media.getDuration.md
@@ -0,0 +1,167 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+media.getDuration
+=================
+
+Returns the duration of an audio file.
+
+ media.getDuration();
+
+Description
+-----------
+
+The `media.getDuration` method executes synchronously, returning the
+duration of the audio file in seconds, if known. If the duration is
+unknown, it returns a value of -1.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Audio player
+ //
+ var my_media = new Media(src, onSuccess, onError);
+
+ // Get duration
+ var counter = 0;
+ var timerDur = setInterval(function() {
+ counter = counter + 100;
+ if (counter > 2000) {
+ clearInterval(timerDur);
+ }
+ var dur = my_media.getDuration();
+ if (dur > 0) {
+ clearInterval(timerDur);
+ document.getElementById('audio_duration').innerHTML = (dur) + " sec";
+ }
+ }, 100);
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Media Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
+ }
+
+ // Audio player
+ //
+ var my_media = null;
+ var mediaTimer = null;
+
+ // Play audio
+ //
+ function playAudio(src) {
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
+
+ // Play audio
+ my_media.play();
+
+ // Update my_media position every second
+ if (mediaTimer == null) {
+ mediaTimer = setInterval(function() {
+ // get my_media position
+ my_media.getCurrentPosition(
+ // success callback
+ function(position) {
+ if (position > -1) {
+ setAudioPosition((position) + " sec");
+ }
+ },
+ // error callback
+ function(e) {
+ console.log("Error getting pos=" + e);
+ setAudioPosition("Error: " + e);
+ }
+ );
+ }, 1000);
+ }
+ }
+
+ // Pause audio
+ //
+ function pauseAudio() {
+ if (my_media) {
+ my_media.pause();
+ }
+ }
+
+ // Stop audio
+ //
+ function stopAudio() {
+ if (my_media) {
+ my_media.stop();
+ }
+ clearInterval(mediaTimer);
+ mediaTimer = null;
+ }
+
+ // onSuccess Callback
+ //
+ function onSuccess() {
+ console.log("playAudio():Audio Success");
+ }
+
+ // onError Callback
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Set audio position
+ //
+ function setAudioPosition(position) {
+ document.getElementById('audio_position').innerHTML = position;
+ }
+
+ </script>
+ </head>
+ <body>
+ <a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
+ <a href="#" class="btn large" onclick="pauseAudio();">Pause Playing Audio</a>
+ <a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
+ <p id="audio_position"></p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/media.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/media.md b/docs/en/3.0.0rc1/cordova/media/media.md
new file mode 100644
index 0000000..2f9e49e
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/media.md
@@ -0,0 +1,133 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Media
+=====
+
+> The `Media` object provides the ability to record and play back audio files on a device.
+
+ var media = new Media(src, mediaSuccess, [mediaError], [mediaStatus]);
+
+__NOTE:__ The current implementation does not adhere to a W3C
+specification for media capture, and is provided for convenience only.
+A future implementation will adhere to the latest W3C specification
+and may deprecate the current APIs.
+
+Parameters
+----------
+
+- __src__: A URI containing the audio content. _(DOMString)_
+- __mediaSuccess__: (Optional) The callback that executes after a `Media` object has completed the current play, record, or stop action. _(Function)_
+- __mediaError__: (Optional) The callback that executes if an error occurs. _(Function)_
+- __mediaStatus__: (Optional) The callback that executes to indicate status changes. _(Function)_
+
+Constants
+---------
+
+The following constants are reported as the only parameter to the
+`mediaStatus` callback:
+
+- `Media.MEDIA_NONE` = 0;
+- `Media.MEDIA_STARTING` = 1;
+- `Media.MEDIA_RUNNING` = 2;
+- `Media.MEDIA_PAUSED` = 3;
+- `Media.MEDIA_STOPPED` = 4;
+
+Methods
+-------
+
+- `media.getCurrentPosition`: Returns the current position within an audio file.
+- `media.getDuration`: Returns the duration of an audio file.
+- `media.play`: Start or resume playing an audio file.
+- `media.pause`: Pause playback of an audio file.
+- `media.release`: Releases the underlying operating system's audio resources.
+- `media.seekTo`: Moves the position within the audio file.
+- `media.setVolume`: Set the volume for audio playback.
+- `media.startRecord`: Start recording an audio file.
+- `media.stopRecord`: Stop recording an audio file.
+- `media.stop`: Stop playing an audio file.
+
+Additional ReadOnly Parameters
+---------------------
+
+- __position__: The position within the audio playback, in seconds.
+ - Not automatically updated during play; call `getCurrentPosition` to update.
+- __duration__: The duration of the media, in seconds.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7.5
+- Tizen
+- Windows 8
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Media" value="org.apache.cordova.AudioHandler" />
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.RECORD_AUDIO" />
+ <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Capture" value="org.apache.cordova.media.MediaCapture" />
+
+### iOS
+
+#### config.xml
+
+ <plugin name="Media" value="CDVSound" />
+
+### Windows Phone
+
+#### Properties/WPAppManifest.xml
+
+ <Capabilities>
+ <Capability Name="ID_CAP_MEDIALIB" />
+ <Capability Name="ID_CAP_MICROPHONE" />
+ <Capability Name="ID_HW_FRONTCAMERA" />
+ <Capability Name="ID_CAP_ISV_CAMERA" />
+ <Capability Name="ID_CAP_CAMERA" />
+ </Capabilities>
+
+Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+
+### Tizen
+
+ No permissions are required.
+
+### Windows Phone Quirks
+
+- Only one media file can be played back at a time.
+- There are strict restrictions on how your application interacts with other media. See the [Microsoft documentation for details][url].
+
+[url]: http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx
[02/12] Version 3.0.0rc1
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/win8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/win8/index.md b/docs/en/3.0.0rc1/guide/platforms/win8/index.md
new file mode 100644
index 0000000..471793a
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/win8/index.md
@@ -0,0 +1,111 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Windows 8 Platform Guide
+
+This guide shows how to set up your SDK development environment to
+deploy Cordova apps for Windows 8. See the following for more
+detailed platform-specific information:
+
+* Upgrading Windows 8
+* Windows 8 Command-line Tools
+
+The command-line tools above refer to versions prior to Cordova 3.0.
+See The Cordova Command-line Interface for information about the
+current interface.
+
+Microsoft deprecated the name _Metro-style apps_ in Windows 8 and
+Windows RT. MSDN now refers to this type of app as a _Windows Store_
+app, and this guide follows that convention. Also, in this guide
+_Windows 8_ signifies both Windows 8 and Windows RT.
+
+## 1. Requirements
+
+- Windows 8
+
+- Visual Studio 2012 Professional or better, or Visual Studio 2012 Express for Windows 8
+
+Follow the instructions [here](http://www.windowsstore.com/) to submit your apps Windows Store.
+
+## 2. Install SDK + Cordova
+
+- Set up your preferred variant of Visual Studio 2012. All of the product's paid versions (Professional, etc.) let you build Windows Store apps. You need **Express for Windows 8** to build Windows Store apps using the [Express editions](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-products).
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-8` subfolder.
+
+## 3. Set up New Project
+
+You can already build Windows 8 apps using the _HTML/JavaScript track_
+available in Windows Store apps. Use Cordova in Windows Store apps to
+expose the same APIs as on other Cordova-supported platforms.
+
+- Open Visual Studio 2012 and choose **New Project**.
+- Select **Installed → Template → Other Languages → JavaScript → Windows Store** from the tree, and then **Blank App** from the projects list. Enter whatever project name you like, such as **CordovaWin8Foo** as in this example.
+
+ 
+
+- Microsoft continues to use `default.html` as the default home page, but most web developers use `index.html`. (Plus it's likely that in the other platform variants of your project you are using `index.html` as the name of your default page.) To fix this, in Solution Explorer rename the `default.html` file to `index.html`. Then double-click the `package.appxmanifest` file and change the **Start page** value to `index.html`.
+
+ 
+
+- To include `cordova.js` in your project, right-click on the **js** folder in Solution Explorer and select **Add → New Item**. Locate the `cordova.js` file in the **lib\windows-8** folder noted above.
+
+- Edit the code for `index.html`. Add a reference to `cordova.js`. You can do this manually, or by dragging the file from Solution Explorer.
+
+### Adding the reference...
+ <!-- WinJS references -->
+ <link href="//Microsoft.WinJS.1.0/css/ui-dark.css" rel="stylesheet" />
+ <script src="//Microsoft.WinJS.1.0/js/base.js"></script>
+ <script src="//Microsoft.WinJS.1.0/js/ui.js"></script>
+
+ <!-- Cordova -->
+ <script src="/js/cordova.js"></script>
+
+ <!-- CordovaWin8Foo references -->
+ <link href="/css/default.css" rel="stylesheet" />
+ <script src="/js/default.js"></script>
+
+- Next, add some code that demonstrates Cordova is working.
+
+### Adding a 'deviceready' handler...
+ <body>
+ <p>Content goes here</p>
+
+ <script type="text/javascript">
+
+ console.log("Subscribing...");
+ document.addEventListener("deviceready", function () {
+
+ navigator.notification.alert("The device is ready!");
+
+ });
+
+ </script>
+
+ </body>
+
+## 5. Test the Project
+
+- Run the project from Visual Studio. You'll see the message box appear:
+
+ 
+
+## Done!
+
+That's it! You're now ready to build Windows Store apps with Cordova.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/win8/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/win8/tools.md b/docs/en/3.0.0rc1/guide/platforms/win8/tools.md
new file mode 100644
index 0000000..9fbb26d
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/win8/tools.md
@@ -0,0 +1,44 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Windows 8 Command-line Tools
+
+The `cordova` command-line utility is a high-level tool that allows
+you to build applications across several platforms at once. An older
+version of the Cordova framework provides sets of command-line tools
+specific to each platform. To use them as an alternative to the CLI,
+you need to download this version of Cordova from
+[cordova.apache.org](http://cordova.apache.org). The download contains
+separate archives for each platform. Expand the platform you wish to
+target. The tools described here are typically available in the
+top-level `bin` directory, otherwise consult the __README__ file for
+more detailed directions.
+
+## Windows 8
+
+The Windows 8 command-line tools only support creating new projects.
+Commands must be run from a cmd or powershell prompt.
+
+## Create a project
+
+Run the `create` command with the following parameters:
+
+* Path to your new Cordova Windows 8 project
+* Package Name, following reverse-domain style convention ( this becomes the default Namespace )
+* Project name
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/win8/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/win8/upgrading.md b/docs/en/3.0.0rc1/guide/platforms/win8/upgrading.md
new file mode 100644
index 0000000..102ad4a
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/win8/upgrading.md
@@ -0,0 +1,42 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Upgrading Windows 8
+
+This guide shows how to modify Windows 8 projects to upgrade from older versions of Cordova.
+Most of these instructions apply to projects created with an older set
+of command-line tools that precede the `cordova` CLI utility. See The
+Cordova Command-line Interface for information how to update the
+version of the CLI.
+
+## Upgrade to 2.9.0 from 2.8.0 ##
+
+The following commands should be done from within Visual Studio to be sure that the any project references are updated/deleted.
+
+1. Remove `cordova-2.8.0.js` from the project's `www` directory.
+2. Add cordova.js file from the source to the project's `www` directory. (Note that the file no longer contains a version number in the filename.)
+3. Build and test!
+
+## Upgrade to 2.8.0 from 2.7.0 ##
+
+The following commands should be done from within Visual Studio to be sure that the any project references are updated/deleted.
+
+1. Remove `cordova-2.7.0.js` from the project's `www` directory.
+2. Add cordova.js file from the source to the project's `www` directory. (Note that the file no longer contains a version number in the filename.)
+3. Build and test!
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/wp7/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/wp7/index.md b/docs/en/3.0.0rc1/guide/platforms/wp7/index.md
new file mode 100644
index 0000000..6edb1b6
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/wp7/index.md
@@ -0,0 +1,99 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Windows Phone 7 Platform Guide
+
+This guide shows how to set up your SDK development environment to
+deploy Cordova apps for Windows Phone 7 devices. Apps also run on
+Windows Phone 8 devices using the same APIs, but version 7 lacks some
+of IE10's advanced features available on Windows Phone 8. Windows
+Phone 8 apps do _not_ run on Windows Phone 7 devices.
+
+See the following for more detailed platform-specific information that
+applies to both versions:
+
+* Upgrading Windows Phone
+* Windows Phone Plugins
+* Windows Phone Command-line Tools
+
+The command-line tools above refer to versions prior to Cordova 3.0.
+See The Cordova Command-line Interface for information about the
+current interface.
+
+## 1. System Requirements
+
+- Operating System:
+ - Windows 7 or Windows 8 (Pro) or Windows Vista with SP2
+ - The 64-bit version (x64) of Windows is required for the SDK.
+ - The Pro version is recommended for running a device emulator.
+
+- Register and pay for a [Windows Phone Dev Center](http://dev.windowsphone.com/en-us/publish) account if you want to install your app on a real device or submit it to Market Place.
+
+__NOTE:__ Running the SDK in Virtual Machine might present some challenges. You can read this blog post that gives insight on the solutions to develop for [Windows Phone on a Mac](http://aka.ms/BuildaWP8apponaMac).
+
+## 2. Install SDK + Cordova
+
+- Download and install the [Windows Phone SDK](http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=27570/)
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-phone-8\wp7` subfolder, `lib\windows-phone-8\wp8` contains the Windwos Phone 8 version of Cordova.
+- Copy the file CordovaWP7_x_x_x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\
+
+## 2.1. Building the template
+
+__NOTE:__ this step may not be required. If the lib\windows-phone directory already contains a file CordovaWP7_x_x_x.zip then you may skip this step.
+
+In order to simplify the development process, Cordova comes with a script to build Visual Studio templates. This allows for rapid creation of Cordova applications inside Visual Studio. This template can be modified if needed and the below steps indicate how to proceed if you want to generate the template.
+
+### Run the batch file to create and install the templates.
+
+- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where 3.0.0 is the current version number) To easily use these files in Visual Studio, copy them to
+"My Documents\Visual Studio 2012\Templates\ProjectTemplates\" You will then be able to create new Apache Cordova Windows Phone apps from the Visual Studio File->New Project menu.
+- If you run the batch file from the command line, you can also call with a parameter to install automatically
+
+Run the script :
+
+ >createTemplates.bat -install
+
+## 3. Set up New Project
+
+- Open Visual Studio Express for Windows Phone and choose **New Project**.
+- Select **CordovaWP7**. (The version number is displayed in the template description.)
+- Give the project a name, and select __OK__.
+
+## 4. Review the project structure
+
+- The `www` folder contains your Cordova `html/js/css` and any other resources included in your app.
+- Any content that you add here needs to be a part of the Visual Studio project, and it must be set as content.
+- Note: This screen capture was from the wp8 cordova-2.3.0 download, your listing will vary based on the actual version installed.
+
+
+
+## 6. Build your project for the device
+
+In order to test your application on a device, the device must be registered. Click [here][register-url] to read documentation on deploying and testing on your Windows Phone 7.
+
+- Make sure your phone is connected, and the screen is unlocked.
+- In Visual Studio, select 'Device' from the top drop-down menu.
+- Press the green **play** button next to the main drop-down menu to start debugging, or type __F5__.
+
+
+
+## Done!
+
+[register-url]: http://msdn.microsoft.com/en-us/library/windowsphone/develop/ff402565(v=vs.105).aspx
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/wp8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/wp8/index.md b/docs/en/3.0.0rc1/guide/platforms/wp8/index.md
new file mode 100644
index 0000000..2bad662
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/wp8/index.md
@@ -0,0 +1,128 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Windows Phone 8 Platform Guide
+
+This guide shows how to set up your SDK development environment to
+deploy Cordova apps for Windows Phone 8 devices. If you want to target
+both 7.5 and 8 devices, develope for Windows Phone 7 instead as
+detailed in the Windows Phone 7 Platform Guide. Version 7 does not
+have all the advanced features included in IE10, but implements the
+same set of APIs. Windows Phone 8 apps do _not_ run on Windows Phone 7
+devices.
+
+See the following for more detailed platform-specific information that
+applies to both versions:
+
+* Upgrading Windows Phone
+* Windows Phone Plugins
+* Windows Phone Command-line Tools
+
+The command-line tools above refer to versions prior to Cordova 3.0.
+See The Cordova Command-line Interface for information about the
+current interface.
+
+## 1. System Requirements
+
+- Operating System:
+ - Windows 8 or Windows 8 Pro
+ - The 64-bit version (x64) of Windows is required for the SDK.
+ - The Pro version is recommended so you can run a device emulator.
+
+- Hardware:
+ - 6.5 GB of free hard disk space
+ - 4 GB RAM
+ - 64-bit (x64) CPU
+
+- Windows Phone 8 Emulator
+ - The phone emulator uses Hyper-V, so this list includes those pre-requisites.
+ - Windows 8 Pro 64-bit edition or greater
+ - Requires a processor that supports virtualization and [Second Level Address Translation (SLAT)](http://en.wikipedia.org/wiki/Second_Level_Address_Translation)
+ - See the [list of Intel processors that support VT-x (virtualization) and EPT (SLAT)](http://ark.intel.com/Products/VirtualizationTechnology)
+ - Enable the virtualization capability (i.e., VT-x on Intel) in your BIOS settings, as usually this is disabled by default.
+
+- SDK + IDE ( Visual Studio )
+ - Visual Studio 2012 Professional, Premium, or Ultimate. Note that Visual Studio Express for Windows Phone (included in the SDK) is not recommended because you can not build the template (see below) with VS Express, as it does not have the __Export Template__ functionality, which is only in VS Pro or higher.
+
+- Register and pay for a [Windows Phone Dev Center](http://dev.windowsphone.com/en-us/publish) account if you want to install your app on a real device or submit it to Market Place.
+
+__NOTE:__ Running the SDK in Virtual Machine might present some challenges. You can read this blog post that gives insight on the solutions to develop for [Windows Phone on a Mac](http://aka.ms/BuildaWP8apponaMac).
+
+## 2. Install SDK + Cordova
+
+- Download and install [Windows Phone SDK](http://www.microsoft.com/en-us/download/details.aspx?id=35471)
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-phone-8\wp8` subfolder, `lib\windows-phone-8\wp7` contains the Windwos Phone 7 version of Cordova.
+- Copy the file CordovaWP8_x_x_x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\
+
+## 2.1. Building the template
+
+__NOTE:__ this step may not be required. If the lib\windows-phone directory already contains a file CordovaWP8_x_x_x.zip then you may skip this step.
+
+In order to simplify the development process, Cordova comes with a script to build Visual Studio templates. This allows for rapid creation of Cordova applications inside Visual Studio. This template can be modified if needed and the below steps indicate how to proceed if you want to generate the template.
+
+### Run the batch file to create and install the templates.
+
+- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where 3.0.0 is the current version number) To easily use these files in Visual Studio, copy them to
+"My Documents\Visual Studio 2012\Templates\ProjectTemplates\" You will then be able to create new Apache Cordova Windows Phone apps from the Visual Studio File->New Project menu.
+- If you run the batch file from the command line, you can also call with a parameter to install automatically
+
+Run the script :
+
+ >createTemplates.bat -install
+
+## 3. Set up New Project
+
+- Open Visual Studio Express for Windows Phone and choose **New Project**.
+- Select **CordovaWP8**. (The version number is displayed in the template description.)
+- Give the project a name, and select __OK__.
+
+
+
+## 4. Review the project structure
+
+- The `www` folder contains your Cordova `html/js/css` and any other resources included in your app.
+- Any content that you add here needs to be a part of the Visual Studio project, and it must be set as content.
+- Note: This screen capture was from the cordova-2.3.0 download, your listing will vary based on the actual version installed.
+
+
+
+## 5. Build and Deploy to Emulator
+
+- Make sure **Windows Phone Emulator** is selected in the main drop-down menu.
+- Press the green **play** button next to the drop-down menu to start debugging, or type __F5__.
+
+
+
+## 6. Build your project for the device
+
+In order to test your application on a device, the device must be registered. Click [here][register-url] to read documentation on deploying and testing on your Windows Phone 8.
+
+- Make sure your phone is connected, and the screen is unlocked.
+- In Visual Studio, select 'Device' from the top drop-down menu.
+- Press the green **play** button next to the main drop-down menu to start debugging, or type __F5__.
+
+
+
+## Done!
+
+## Further Reading
+
+For more details on the specific differences between IE10 and WebKit browsers, and how to support both MS has a helpful [guide here](http://blogs.windows.com/windows_phone/b/wpdev/archive/2012/11/15/adapting-your-webkit-optimized-site-for-internet-explorer-10.aspx)
+
+[register-url]: http://msdn.microsoft.com/en-us/library/windowsphone/develop/ff402565(v=vs.105).aspx
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/wp8/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/wp8/plugin.md b/docs/en/3.0.0rc1/guide/platforms/wp8/plugin.md
new file mode 100644
index 0000000..3bf34b4
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/wp8/plugin.md
@@ -0,0 +1,187 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Windows Phone Plugins
+
+Writing a plugin for Cordova on Windows Phone requires a basic understanding of
+the architecture of Cordova. Cordova-WP7 consists of a WebBrowser which hosts the
+application JavaScript code and manages native API calls. There is a BaseCommand
+(`WP7CordovaClassLib.Cordova.Commands.BaseCommand`) class in C# which you can extend,
+and it comes with the majority of the 'plumbing' built for you already.
+
+1. Select your project, and right-click to choose __Add → New Item...__
+ - Preferably add it to the 'Plugins' folder, but it is up to you
+2. Select 'Class' and name it `Echo.cs`
+ - The name of this class must _exactly_ match what you call into `cordova.exec(win, fail, "Echo", ...)`
+3. Include the base classes implementation
+
+ using WPCordovaClassLib.Cordova;
+ using WPCordovaClassLib.Cordova.Commands;
+ using WPCordovaClassLib.Cordova.JSON;
+
+4. Extend your class from BaseCommand
+
+ public class Echo : BaseCommand
+ {
+ // ...
+ }
+
+5. Add a method that is callable from JS
+
+ public class Echo : BaseCommand
+ {
+ public void echo(string options)
+ {
+ // all JS callable plugin methods MUST have this signature!
+ // public, returning void, 1 argument that is a string
+ }
+ }
+
+## Namespaces
+
+The default namespace for unqualified commands is:
+
+ namespace Cordova.Extension.Commands
+ {
+ // ...
+ }
+
+If you want to use your own namespace, you need to make a fully
+qualified call to `cordova.exec`. For example, if you want to define
+your C# class like this:
+
+ namespace com.mydomain.cordovaExtensions
+ {
+ public class Echo : BaseCommand
+ {
+ // ...
+ }
+ }
+
+Then, in JS you need to call `exec` like this:
+
+ cordova.exec(win, fail, "com.mydomain.cordovaExtensions.Echo", ...);
+
+## Interpreting your arguments in C#
+
+The data received by your plugin method is a string value, but in actuality
+looking at our JavaScript code, we see our intention was to pass an array of strings.
+Looking back at our JS call to `cordova.exec`, we see we passed `[str]`:
+
+ cordova.exec(win, fail, "Echo", "echo", ["input string"]);
+
+If we inspect the options string passed in to our `Echo.echo` method,
+we see that the value is actually:
+
+ "[\"input string\"]"
+
+All JavaScript exec arguments are JSON encoded before being passed into C#.
+
+If we want to treat this as the string we were expecting, we need to decode it.
+We can use simple JSON deserialization.
+
+ string optVal = JsonHelper.Deserialize<string[]>(options)[0];
+ // optVal now has the value of "input string"
+
+## Passing results from C# to JS
+
+The base class BaseCommand provides methods for passing data to your JS callback handlers.
+To simply signal that the command has succeeded, when no additional result info is needed,
+you can simply call:
+
+ DispatchCommandResult(); // calls back with an empty plugin result, considered a success callback
+
+To pass data back, you need to call a different version of `DispatchCommandResult`:
+
+ DispatchCommandResult(new PluginResult(PluginResult.Status.OK, "Everything went as planned, this is a result that is passed to the success handler."));
+
+To pass structured object data back to JS, it should be encoded as a JSON string:
+
+ DispatchCommandResult(new PluginResult(PluginResult.Status.OK, "{result:\"super awesome!\"}"));
+
+If you need to signal that an error has occurred, you can call `DispatchCommandResult` with a `PluginResult` object:
+
+ DispatchCommandResult(new PluginResult(PluginResult.Status.ERROR, "Echo signaled an error"));
+
+## Handling serialization errors in your plugin's C# method
+
+When interpreting your arguments, it is a good idea to use a try/catch block
+in case we have bad input. This is a pattern used throughout the Cordova C# code:
+
+ string optVal = null;
+
+ try
+ {
+ optVal = JsonHelper.Deserialize<string[]>(options)[0];
+ }
+ catch(Exception)
+ {
+ // simply catch the exception, we handle null values and exceptions together
+ }
+
+ if (optVal == null)
+ {
+ DispatchCommandResult(new PluginResult(PluginResult.Status.JSON_EXCEPTION));
+ }
+ else
+ {
+ // ... continue on to do our work
+ }
+
+## Advanced Plugin Functionality
+
+See other methods that you can override in:
+
+1. [BaseCommand.cs](https://github.com/apache/cordova-wp7/blob/master/templates/standalone/cordovalib/Commands/BaseCommand.cs)
+
+For example, you can hook into the 'pause' and 'resume' application events.
+
+### Debugging Plugins
+
+To debug the C# side, you can use Visual Studio's debugger, just set a break point
+at any of the methods exposed by your class.
+
+JavaScript is a little more difficult to debug on Windows Phone. You
+need to use `console.log` to output the state of your plugin, or
+inform yourself of errors.
+
+## Common Pitfalls
+
+- Be careful when deciding on the arguments you pass to native in your JavaScript
+ implementation. Most device platforms expect the args passed to cordova.exec
+ to be an array, but if you have different types of objects in this array, it
+ becomes difficult or impossible to deserialize.
+
+ cordova.exec(win, fail, "ServiceName", "MethodName", ["this is a string", 54, {literal:'trouble'}]);
+
+ - This means that your C# code receives a difficult to decode string value, such as:
+
+ "[\"this is a string\", 54, { literal:'trouble' }]"
+
+ - Consider converting ALL parameters to strings before calling exec:
+
+ cordova.exec(win, fail, "ServiceName", "MethodName", ["this is a string", "54", "{literal:'trouble'}"]) ;
+
+ string[] optValues = JsonHelper.Deserialize<string[]>(options);
+
+- It is usually a good idea to do parameter checking in your
+ JavaScript code, before you call `exec`. This allows you to re-use
+ more JavaScript code among your plug-in's various native
+ implementations.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/wp8/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/wp8/tools.md b/docs/en/3.0.0rc1/guide/platforms/wp8/tools.md
new file mode 100644
index 0000000..f11ab67
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/wp8/tools.md
@@ -0,0 +1,101 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Windows Phone Command-line Tools
+
+The `cordova` command-line utility is a high-level tool that allows
+you to build applications across several platforms at once. An older
+version of the Cordova framework provides sets of command-line tools
+specific to each platform. To use them as an alternative to the CLI,
+you need to download this version of Cordova from
+[cordova.apache.org](http://cordova.apache.org). The download contains
+separate archives for each platform. Expand the platform you wish to
+target. The tools described here are typically available in the
+top-level `bin` directory, otherwise consult the __README__ file for
+more detailed directions.
+
+## Windows Phone
+
+The Windows Phone command-line tools support creating, building, and
+running new projects. Commands must be run from a cmd or powershell
+prompt.
+
+The WP8 repo now includes code for building both WP7 + WP8 apps. The
+repo has subfolders for each: wp7/ and wp8/
+
+## Create a project
+
+There are 2 ways to go about creating a new Apache Cordova WP7 or WP8 application.
+
+### Run the batch file to create and install the templates.
+
+- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where 3.0.0 is the current version number) To easily use these files in Visual Studio, copy them to
+"My Documents\Visual Studio 2012\Templates\ProjectTemplates\" You will then be able to create new Apache Cordova Windows Phone apps from the Visual Studio File->New Project menu.
+- If you run the batch file from the command line, you can also call with a parameter to install automatically
+
+Run the script :
+
+ >createTemplates.bat -install
+
+### Use the create scripts on the command line
+
+Run the `create` command, specifying the existing path to the project,
+the reverse-domain-style package identifier, and the app's display
+name. Here is the syntax for both Windows Phone 7 and 8:
+
+ >.\wp7\bin\create PathToNewProject [ PackageName ] [ AppName ]
+ >.\wp8\bin\create PathToNewProject [ PackageName ] [ AppName ]
+
+ >PathToNewProject : The path to where you wish to create the project
+ >PackageName : The namespace for the project (default is Cordova.Example)
+ >AppName : The name of the application (default is CordovaWP8AppProj or CordovaWP7AppProj)
+
+ >examples:
+ >.\wp7\bin\create C:\path\to\my_new_project
+ >.\wp8\bin\create C:\path\to\my_new_project io.cordova.example CordovaWP8App
+
+ Launch Visual Studio and open Solution file (.sln) in (C:\path\to\my_new_project)
+
+ Built and Run it
+
+## Building your project (cleans then builds)
+
+* Debug
+
+ $ C:\path\to\my_new_project\cordova\build --debug
+
+* Release
+
+ $ C:\path\to\my_new_project\cordova\build --release
+
+## Running your application
+
+Run the 'run' command with the following *optional* parameters
+
+* Target specification. This includes `--emulator`, `--device`, or `--target=<targetID>`.
+* Build specification. This includes `--debug`, `--release`, or `--nobuild`.
+
+ $ C:\path\to\my_new_project\cordova\run [Target] [Build]
+
+By default the `run` command will be called with `--emulator --debug` if flags are not provided.
+
+## Cleaning
+
+ $ C:\path\to\my_new_project\cordova\clean
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/wp8/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/wp8/upgrading.md b/docs/en/3.0.0rc1/guide/platforms/wp8/upgrading.md
new file mode 100644
index 0000000..bc58ba6
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/wp8/upgrading.md
@@ -0,0 +1,274 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Upgrading Windows Phone
+
+This guide shows how to modify Windows Phone projects, both versions 7
+and 8, to upgrade from older versions of Cordova.
+Most of these instructions apply to projects created with an older set
+of command-line tools that precede the `cordova` CLI utility. See The
+Cordova Command-line Interface for information how to update the
+version of the CLI.
+The following section shows how to upgrade from non-CLI projects.
+
+## Upgrade to the CLI (3.0.0) from 2.9.0 ##
+
+1. Create a new Apache Cordova 3.0.0 project using the cordova CLI, as
+ described in The Cordova Command-line Interface.
+2. Add your platforms the the cordova project, for example: `cordova
+ platform add wp7 wp8`.
+3. Copy the contents of the project's `www` folder to the `www` folder
+ at the root of the cordova project you just created.
+4. Copy or overwrite any native assets from your original project
+ (`SplashScreen`, `ApplicationIcon`, etc.), making sure to add any
+ new files to the `.csproj` file. The windows phone project builds
+ inside the `platforms\wp7` or `platforms\wp8` directory.
+5. Use the cordova CLI tool to install any plugins you need. Note that
+ the CLI handles all core APIs as plugins, so they may need to be
+ added. Only 3.0.0 plugins are compatible with the CLI.
+6. Build and test.
+
+## Upgrade to 3.0.0 (non-CLI) from 2.9.0 ##
+
+In Visual Studio's Solution Explorer window:
+
+1. Create a new Apache Cordova WP7 or WP8 3.0.0 Project
+2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+3. Copy and overwrite any splash screen, or icon images.
+4. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+5. Build and test.
+
+__NOTE:__ all core APIs are removed from Cordova version 3.0, and must
+be installed separately as plugins. For more information on how to
+re-enable these features in a non-CLI workflow, see Using Plugman to
+Manage Plugins.
+
+## Upgrade to 2.9.0 from 2.8.0 ##
+
+In Visual Studio's Solution Explorer window:
+
+1. Create a new Apache Cordova WP7 or WP8 2.9.0 Project
+2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+3. Update the name of cordova.js in the HTML tag if it's still using cordova-VERSION.js (should be just cordova.js).
+4. Copy and overwrite any splash screen, or icon images.
+5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the .csproj file.
+6. Build and test.
+
+## Upgrade to 2.8.0 from 2.7.0 ##
+
+In Visual Studio's Solution Explorer window:
+
+1. Create a new Apache Cordova WP7 or WP8 2.8.0 Project
+2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+3. Update your HTML to use the new cordova.js file. ( note that there is no longer a version number in the name )
+4. Copy and overwrite any splash screen, or icon images.
+5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+6. Build and test.
+
+## Upgrade to 2.7.0 from 2.6.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Create a new Apache Cordova WP7 or WP8 2.7.0 Project
+2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+3. Update your HTML to use the new `cordova-2.7.0.js` file.
+4. Copy and overwrite any splash screen, or icon images.
+5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+6. Build and test.
+
+## Upgrade to 2.6.0 from 2.5.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Create a new Apache Cordova WP7 or WP8 2.6.0 Project
+2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+3. Update your HTML to use the new `cordova-2.6.0.js` file.
+4. Copy and overwrite any splash screen, or icon images.
+5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+6. Build and test.
+
+## Upgrade to 2.5.0 from 2.4.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Create a new Apache Cordova WP7 or WP8 2.5.0 Project
+2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+3. Update your HTML to use the new `cordova-2.5.0.js` file.
+4. Copy and overwrite any splash screen, or icon images.
+5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+6. Build and test.
+
+## Upgrade to 2.4.0 from 2.3.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Create a new Apache Cordova WP7 or WP8 2.4.0 Project
+2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+3. Update your HTML to use the new `cordova-2.4.0.js` file.
+4. Copy and overwrite any splash screen, or icon images.
+5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+6. Build and test.
+
+## Upgrade to 2.3.0 from 2.2.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Create a new Apache Cordova WP7 2.3.0 Project
+2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+3. Update your HTML to use the new `cordova-2.3.0.js` file.
+4. Copy and overwrite any splash screen, or icon images.
+5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+6. Build and test.
+
+## Upgrade to 2.2.0 from 2.1.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Create a new Apache Cordova WP7 2.2.0 Project
+2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+3. Update your HTML to use the new `cordova-2.2.0.js` file.
+4. Copy and overwrite any splash screen, or icon images.
+5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+6. Build and test.
+
+## Upgrade to 2.1.0 from 2.0.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Create a new Apache Cordova WP7 2.1.0 Project
+2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+3. Update your HTML to use the new `cordova-2.1.0.js` file.
+4. Copy and overwrite any splash screen, or icon images.
+5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+6. Build and test.
+
+## Upgrade to 2.0.0 from 1.9.0 ##
+
+There have been considerable changes to the WP7 project structure in Apache Cordova 2.0.0 which make this upgrade a little more involved that the others. Essentially this is not an upgrade but creation of a new project and copy over of existing source files.
+
+In Visual Studio's Solution Explorer window:
+1. Create a new Apache Cordova WP7 2.0 Project
+2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project.
+3. Update your HTML to use the new `cordova-2.0.0.js` file.
+4. Copy and overwrite any splash screen, or icon images.
+5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project.
+6. Build and test.
+
+## Upgrade to 1.9.0 from 1.8.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
+3. Right-click on __References__ and select __Add Reference__
+4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+ - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+5. Copy the new `cordova-1.9.0.js` into your project. (Be sure it is marked as Content.)
+6. Update your HTML to use the new `cordova-1.9.0.js` file.
+
+## Upgrade to 1.8.0 from 1.7.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
+3. Right-click on __References__ and select __Add Reference__
+4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+ - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+5. Copy the new `cordova-1.8.0.js` into your project. (Be sure it is marked as Content.)
+6. Update your HTML to use the new `cordova-1.8.0.js` file.
+
+## Upgrade to 1.7.0 from 1.6.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
+3. Right-click on __References__ and select __Add Reference__
+4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+ - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+5. Copy the new `cordova-1.7.0.js` into your project. (Be sure it is marked as Content.)
+6. Update your HTML to use the new `cordova-1.7.0.js` file.
+
+## Upgrade to 1.6.1 from 1.6.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
+3. Right-click on __References__ and select __Add Reference__
+4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+ - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+5. Copy the new `cordova-1.6.1.js` into your project. (Be sure it is marked as Content.)
+6. Update your HTML to use the new `cordova-1.6.1.js` file.
+
+## Upgrade to 1.6.0 from 1.5.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
+3. Right-click on __References__ and select __Add Reference__
+4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+ - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+5. Copy the new `cordova-1.6.0.js` into your project. (Be sure it is marked as Content.)
+6. Update your HTML to use the new `cordova-1.6.0.js` file.
+
+## Upgrade to 1.5.0 from 1.4.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
+3. Right-click on __References__ and select __Add Reference__
+4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+ - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+5. Copy the new `cordova-1.5.0.js` into your project. (Be sure it is marked as Content.)
+6. Update your HTML to use the new `cordova-1.5.0.js` file.
+
+## Upgrade to 1.4.0 from 1.3.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
+3. Right-click on __References__ and select __Add Reference__
+4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+ - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+5. Copy the new `cordova-1.4.0.js` into your project. (Be sure it is marked as Content.)
+6. Update your HTML to use the new `cordova-1.4.0.js` file.
+
+## Upgrade to 1.3.0 from 1.2.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
+3. Right-click on __References__ and select __Add Reference__
+4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+ - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+5. Copy the new `cordova-1.3.0.js` into your project. (Be sure it is marked as Content.)
+6. Update your HTML to use the new `cordova-1.3.0.js` file.
+
+## Upgrade to 1.2.0 from 1.1.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
+3. Right-click on __References__ and select __Add Reference__
+4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+ - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+5. Copy the new `cordova-1.2.0.js` into your project. (Be sure it is marked as Content.)
+6. Update your HTML to use the new `cordova-1.2.0.js` file.
+
+## Upgrade to 1.1.0 from 1.0.0 ##
+
+In Visual Studio's Solution Explorer window:
+1. Delete `GapLib/WP7CordovaClassLib.dll` from your project.
+2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder.
+3. Right-click on __References__ and select __Add Reference__
+4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll'
+ - __NOTE:__ you can view the version of the DLL by right-clicking on the reference, and selecting __Properties__.
+5. Copy the new `cordova-1.1.0.js` into your project. (Be sure it is marked as Content.)
+6. Update your HTML to use the new `cordova-1.1.0.js` file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/plugins/corePluginInstall.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/plugins/corePluginInstall.md b/docs/en/3.0.0rc1/guide/plugins/corePluginInstall.md
new file mode 100644
index 0000000..7b8f01e
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/plugins/corePluginInstall.md
@@ -0,0 +1,110 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Using Plugman to Manage Plugins
+
+From version 3.0 onward, Cordova implements all device APIs as
+plugins, and leaves them disabled by default. It also supports two
+different ways to add and remove plugins. The first is by using the
+`cordova` CLI described in The Command-line Interface. The second is
+by using a lower-level
+[plugman](https://github.com/apache/cordova-plugman/)
+command-line interface. This guide concentrates on the second
+approach, which may be useful for developers who want to upgrade their
+version of Cordova, but who haven't yet adopted the Cordova CLI in
+their workflow.
+
+For more information on plugman, see
+[the README file in its repository](https://github.com/apache/cordova-plugman/blob/master/README.md).
+
+## Basic Commands
+
+To install plugman, you must have [node](http://nodejs.org/) installed
+on your machine:
+
+ npm install -g plugman
+
+Here is the syntax to add a plugin for each platform:
+
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin <name|url|path> [--plugins_dir <directory>] [--www <directory>] [--variable <name>=<value> [--variable <name>=<value> ...]]
+
+To uninstall a plugin:
+
+ plugman --uninstall --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin <id> [--www <directory>] [--plugins_dir <directory>]
+
+## Installing Core Plugins
+
+The examples below show how to add plugins as needed so that any
+Cordova APIs you use in your project still work after you upgrade to
+version 3.0. For each command, you need to select the target
+platform, and reference the platform's project directory.
+
+* cordova-plugin-battery-status
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git
+
+* cordova-plugin-camera
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git
+
+* cordova-plugin-console
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-console.git
+
+* cordova-plugin-contacts
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git
+
+* cordova-plugin-device
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git
+
+* cordova-plugin-device-motion (accelerometer)
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git
+
+* cordova-plugin-device-orientation (compass)
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git
+
+* cordova-plugin-dialogs
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git
+
+* cordova-plugin-file
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
+
+* cordova-plugin-file-transfer
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer.git
+
+* cordova-plugin-geolocation
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
+
+* cordova-plugin-globalization
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git
+
+* cordova-plugin-inappbrowser
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git
+
+* cordova-plugin-media
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git
+
+* cordova-plugin-media-capture
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git
+
+* cordova-plugin-network-information
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git
+
+* cordova-plugin-splashscreen
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git
+
+* cordova-plugin-vibration
+ plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/plugins/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/plugins/index.md b/docs/en/3.0.0rc1/guide/plugins/index.md
new file mode 100644
index 0000000..64896fd
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/plugins/index.md
@@ -0,0 +1,120 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Plugin Development Guide
+
+A Cordova plugin bridges a bit of functionality between the WebView
+powering a Cordova application and the native platform the Cordova
+application is running on. Plugins are composed of a single JavaScript
+interface used across all platforms, and native implementations
+following platform-specific Plugin interfaces that the JavaScript
+calls into. All of the core Cordova APIs are implemented using this
+architecture.
+
+This guide steps the process of writing a simple Echo Plugin that
+passes a string from JavaScript and sends it into the native
+environment for the supported platforms. The native code then returns
+the same string back to the callbacks inside the plugin's JavaScript.
+
+This guide provides enough overview on which you can build to write
+more complex plugins.
+
+## JavaScript
+
+The entry point for any plugin is JavaScript. The reason developers use
+Cordova is so they can use and write JavaScript, not Objective-C,
+not Java, not C#. The JavaScript interface for your plugin is the
+front-facing and arguably most important part of your Cordova plugin.
+
+You can structure your plugin's JavaScript however you like. The one
+thing you _must_ use to communicate between the Cordova JavaScript
+ and native environments is the `cordova.exec` function. Here is an example:
+
+ cordova.exec(function(winParam) {}, function(error) {}, "service",
+ "action", ["firstArgument", "secondArgument", 42,
+ false]);
+
+The parameters are detailed below:
+
+1. `function(winParam) {}` - Success function callback. Assuming your
+ `exec` call completes successfully, this function is invoked
+ (optionally with any parameters you pass back to it).
+2. `function(error) {}` - Error function callback. If the operation does
+ not complete successfully, this function is invoked (optionally
+ with an error parameter).
+3. `"service"` - The service name to call into on the native side. This
+ is mapped to a native class, about which more information is
+ available in the native guides listed below.
+4. `"action"` - The action name to call into. This is picked up by the
+ native class receiving the `exec` call, and, depending on the
+ platform, essentially maps to a class's method.
+ The native guides listed below provide details.
+5. `[/* arguments */]` - Arguments to pass into the native environment.
+
+### Echo Plugin JavaScript Example
+
+ window.echo = function(str, callback) {
+ cordova.exec(callback, function(err) {
+ callback('Nothing to echo.');
+ }, "Echo", "echo", [str]);
+ };
+
+Let's dive into this. The plugin attaches itself to `window`,
+specifically to the `echo` function. Plugin users would then use it as
+follows:
+
+ window.echo("echome", function(echoValue) {
+ alert(echoValue == "echome"); // should alert true.
+ });
+
+First, let's take a look at the last three arguments to the `exec`
+function. We will be calling the `Echo` "service", requesting the `echo`
+"action", and passing an array of arguments containing the echo string,
+which is the first parameter into the `window.echo` function.
+
+The success callback passed into `exec` is simply a reference to the
+callback function that `window.echo` takes. We do a bit more for the
+error callback: if the native side fires off the error callback, we
+simply invoke the success callback and pass into it a "default"
+string.
+
+## Plugin Specification
+
+Cordova has a plugin specification available to enable automated
+installation of the plugin for Android, iOS, BlackBerry 10 and Windows
+Phone platforms. By structuring your plugin in a particular way and
+adding a `plugin.xml` manifest file, you can enable users to install
+your plugin via the command line tooling.
+
+- Plugin Specification
+
+## Native
+
+Once you define JavaScript for your plugin, you need to complement it
+with at least one native implementation. Details to do so for each
+platform are listed below. These guides continue to build on the
+simple Echo Plugin example discussed above.
+
+- Android Plugins
+- BlackBerry Plugins
+- BlackBerry 10 Plugins
+- iOS Plugins
+- Windows Phone Plugins
+
+The Tizen platform currently does not support plugins.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/plugins/plugin_spec.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/plugins/plugin_spec.md b/docs/en/3.0.0rc1/guide/plugins/plugin_spec.md
new file mode 100644
index 0000000..63b9b0c
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/plugins/plugin_spec.md
@@ -0,0 +1,502 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Plugin Specification
+
+The `plugin.xml` file is an XML document in the `plugins` namespace:
+`http://apache.org/cordova/ns/plugins/1.0`. It contains a top-level
+`plugin` element that defines the plugin, and children that define the
+structure of the plugin.
+
+A sample plugin element:
+
+ <?xml version="1.0" encoding="UTF-8"?>
+ <plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
+ xmlns:android="http://schemas.android.com/apk/res/android"
+ id="com.alunny.foo"
+ version="1.0.2">
+
+## <plugin> element
+
+The `plugin` element is the plugin manifest's top-level element. It
+features the following attributes:
+
+* `xmlns` (required):
+ The plugin namespace, `http://apache.org/cordova/ns/plugins/1.0`. If
+ the document contains XML from other namespaces, such as tags to be
+ added to the `AndroidManifest.xml` file, those namespaces should
+ also be included in the top-level element.
+
+* `id` (required):
+ A reverse-domain style identifier for the plugin, such as
+ `com.alunny.foo`
+
+* `version` (required):
+ A version number for the plugin, that matches the following
+ major-minor-patch style regular expression:
+
+ ^\d+[.]\d+[.]\d+$
+
+## <engines> and <engine> elements
+
+The child elements of the `<engines>` element specify versions of
+Apache Cordova-based frameworks that this plugin supports. An example:
+
+ <engines>
+ <engine name="cordova" version="1.7.0" />
+ <engine name="cordova" version="1.8.1" />
+ <engine name="worklight" version="1.0.0" />
+ </engines>
+
+Similar to the `<plugin>` element's `version` attribute, the specified
+version string should match a major-minor-patch string conforming to
+the regular expression:
+
+ ^\d+[.]\d+[.]\d+$
+
+Engine elements may also specify fuzzy matches to avoid repetition,
+and to reduce maintenance when the underlying platform is updated.
+Tools should support a minimum of `>`, `>=`, `<` and `<=`, for
+example:
+
+ <engines>
+ <engine name="cordova" version=">=1.7.0" />
+ <engine name="cordova" version="<1.8.1" />
+ </engines>
+
+plugman aborts with a non-zero code for any plugin whose target
+project does not meet the engine's constraints.
+
+If no `<engine>` tags are specified, plugman attempts to install into
+the specified cordova project directory blindly.
+
+## <name> element
+
+A human-readable name for the plugin, whose text content contains the
+name of the plugin. For example:
+
+ <name>Foo</name>
+
+This element does not (yet) handle localization.
+
+## <asset> element
+
+One or more elements listing the files or directories to be copied
+into a Cordova app's `www` directory. Examples:
+
+ <!-- a single file, to be copied in the root directory -->
+ <asset src="www/foo.js" target="foo.js" />
+ <!-- a directory, also to be copied in the root directory -->
+ <asset src="www/foo" target="foo" />
+
+All `<asset>` tags require both `src` and `target` attributes.
+Web-only plugins contains mostly `<asset>` elements. Any `<asset>`
+elements that are nested within `<platform>` elements specify
+platform-specific web assets, as described below. Attributes include:
+
+* `src` (required):
+ Where the file or directory is located in the plugin package,
+ relative to the `plugin.xml` document. If a file does not exist at
+ the specified `src` location, plugman stops and reverses the
+ installation process, issues a notification about the conflict, and
+ exits with a non-zero code.
+
+* `target` (required):
+
+ Where the file or directory should be located in the Cordova app,
+ relative to the `www` directory.
+ Assets can be targeted to subdirectories, for example:
+
+ <asset src="www/new-foo.js" target="js/experimental/foo.js" />
+
+ creates the `js/experimental` directory within the `www` directory,
+ unless already present, then copies the `new-foo.js` file and
+ renames it `foo.js`. If a file already exists at the target
+ location, plugman stops and reverses the installation process,
+ issues a notification about the conflict, and exits with a non-zero
+ code.
+
+## <js-module> element
+
+Most plugins include one or more JavaScript files. Each `<js-module>`
+tag corresponds to a JavaScript file, and prevents the plugin's users
+from having to add a `<script>` tag for each file. While `<asset>`
+tags simply copy a file from the plugin subdirectory into `www`,
+`<js-module>` tags are much more sophisticated. They look like this:
+
+ <js-module src="socket.js" name="Socket">
+ <clobbers target="chrome.socket" />
+ </js-module>
+
+When installing a plugin with the example above, `socket.js` is copied
+to `www/plugins/my.plugin.id/socket.js`, and added as an entry to
+`www/cordova_plugins.js`. At load time, code in `cordova.js` uses XHR
+to read each file and inject a `<script>` tag into HTML. It adds a
+mapping to clobber or merge as appropriate, as described below.
+
+_Do not_ wrap the file with `cordova.define`, as it is added
+automatically. The module is wrapped in a closure, with `module`,
+`exports`, and `require` in scope, as is normal for AMD modules.
+
+Details for the `<js-module>` tag:
+
+* The `src` references a file in the plugin directory relative to the
+ `plugin.xml` file.
+
+* The `name` provides the last part of the module name. It can
+ generally be whatever you like, and it only matters if you want to
+ use `cordova.require` to import other parts of your plugins in your
+ JavaScript code. The module name for a `<js-module>` is your
+ plugin's `id` followed by the value of `name`. For the example
+ above, with an `id` of `chrome.socket`, the module name is
+ `chrome.socket.Socket`.
+
+* Three tags are allowed within `<js-module>`:
+
+ * `<clobbers target="some.value" />` indicates that the
+ `module.exports` is inserted into the `window` object as
+ `window.some.value`. You can have as many `<clobbers>` as you
+ like. Any object not available on `window` is created.
+
+ * `<merges target="some.value" />` indicates that the module
+ should be merged with any existing value at `window.some.value`.
+ If any key already exists, the module's version overrides the
+ original. You can have as many `<merges>` as you like. Any
+ object not available on `window` is created.
+
+ * `<runs />` means that your code should be specified with
+ `cordova.require`, but not installed on the `window`
+ object. This is useful when initializing the module, attaching
+ event handlers or otherwise. You can only have up to one
+ `<runs/>` tag. Note that including a `<runs/>` with
+ `<clobbers/>` or `<merges/>` is redundant, since they also
+ `cordova.require` your module.
+
+ * An empty `<js-module>` still loads and can be acccessed in other
+ modules via `cordova.require`.
+
+If `src` does not resolve to an existing file, plugman stops and
+reverses the installation, issues a notification of the problem, and
+exits with a non-zero code.
+
+Nesting `<js-module>` elements within `<platform>` declares
+platform-specific JavaScript module bindings.
+
+## <dependency>
+
+The `<dependency>` tag allows you specify other plugins on which the
+current plugin depends. While future versions will access them from
+plugin repositories, in the short term plugins are directly referenced
+as URLs by `<dependency>` tags. They are formatted as follows:
+
+ <dependency id="com.plugin.id" url="https://github.com/myuser/someplugin" commit="428931ada3891801" subdir="some/path/here" />
+
+* `id`: provides the ID of the plugin. It should be globally unique,
+ and expressed in reverse-domain style. While neither of these
+ restrictions is currently enforced, they may be in the future.
+
+* `url`: A URL for the plugin. This should reference a git repository,
+ which plugman attempts to clone.
+
+* `commit`: This is any git reference understood by `git checkout`: a
+ branch or tag name (e.g., `master`, `0.3.1`), or a commit hash (e.g.,
+ `975ddb228af811dd8bb37ed1dfd092a3d05295f9`).
+
+* `subdir`: Specifies that the targeted plugin dependency exists as a
+ subdirectory of the git repository. This is helpful because it
+ allows the repository to contain several related plugins, each
+ specified individually.
+
+In the future, version constraints will be introduced, and a plugin
+repository will exist to support fetching by name instead of explicit
+URLs.
+
+### Relative Dependency Paths
+
+If you set the `url` of a `<dependency>` tag to `"."` and provide a
+`subdir`, the dependent plugin is installed from the same local or
+remote git repository as the parent plugin that specifies the
+`<dependency>` tag.
+
+Note that the `subdir` always specifies a path relative to the _root_
+of the git repository, not the parent plugin. This is true even if you
+installed the plugin with a local path directly to it. Plugman finds
+the root of the git repository and then finds the other plugin from
+there.
+
+## <platform>
+
+The `<platform>` tag identifies platforms that have associated native
+code or require modifications to their configuration files. Tools
+using this specification can identify supported platforms and install
+the code into Cordova projects.
+
+Plugins without `<platform>` tags are assumed to be JavaScript-only,
+and therefore installable on any and all platforms.
+
+A sample platform tag:
+
+ <platform name="android">
+ <!-- android-specific elements -->
+ </platform>
+ <platform name="ios">
+ <!-- ios-specific elements -->
+ </platform>
+
+The required `name` attribute identifies a platform as supported,
+associating the element's children with that platform.
+
+Platform names should be lowercase. Platform names, as arbitrarily
+chosen, are listed:
+
+* android
+* bb10
+* ios
+* wp7
+* wp8
+
+## <source-file>
+
+The `<source-file>` element identifies executable source code that
+should be installed into a project. Examples:
+
+ <!-- android -->
+ <source-file src="src/android/Foo.java"
+ target-dir="src/com/alunny/foo" />
+ <!-- ios -->
+ <source-file src="src/ios/CDVFoo.m" />
+ <source-file src="src/ios/someLib.a" framework="true" />
+ <source-file src="src/ios/someLib.a" compiler-flags="-fno-objc-arc" />
+
+It supports the following attributes:
+
+* `src` (required):
+ Location of the file relative to `plugin.xml`. If the `src` file
+ cannot be found, plugman stops and reverses the installation, issues
+ a notification about the problem, and exits with a non-zero code.
+
+* `target-dir`:
+ A directory into which the files should be copied, relative to the
+ root of the Cordova project. In practice, this is most important
+ for Java-based platforms, where a file in the `com.alunny.foo`
+ package must be located within the `com/alunny/foo` directory. For
+ platforms where the source directory is not important, this
+ attribute should be omitted.
+
+ As with assets, if the `target` of a `source-file` would overwrite
+ an existing file, plugman stops and reverses the installation,
+ issues a notification about the problem, and exits with a non-zero
+ code.
+
+* `framework` (iOS only):
+ If set to `true`, also adds the specified file as a framework to the
+ project.
+
+* `compiler-flags` (iOS only):
+ If set, assigns the specified compiler flags for the particular
+ source file.
+
+## <config-file>
+
+Identifies an XML-based configuration file to be modified, where in
+that document the modification should take place, and what should be
+modified.
+
+Two file types that have been tested for modification with this
+element are `xml` and `plist` files.
+
+The `config-file` element only allows you to append new children to an
+XML document tree. The children are XML literals to be inserted in the
+target document.
+
+Example for XML:
+
+ <config-file target="AndroidManifest.xml" parent="/manifest/application">
+ <activity android:name="com.foo.Foo" android:label="@string/app_name">
+ <intent-filter>
+ </intent-filter>
+ </activity>
+ </config-file>
+
+Example for `plist`:
+
+ <config-file target="*-Info.plist" parent="CFBundleURLTypes">
+ <array>
+ <dict>
+ <key>PackageName</key>
+ <string>$PACKAGE_NAME</string>
+ </dict>
+ </array>
+ </config-file>
+
+It supports the following attributes:
+
+* `target`:
+
+ The file to be modified, and the path relative to the root of the
+ Cordova project.
+
+ The target can include wildcard (`*`) elements. In this case,
+ plugman recursively searches through the project directory structure
+ and uses the first match.
+
+ On iOS, the location of configuration files relative to the project
+ directory root is not known, so specifying a target of `config.xml`
+ resolves to `cordova-ios-project/MyAppName/config.xml`.
+
+ If the specified file does not exist, the tool ignores the
+ configuration change and continues installation.
+
+* `parent`: An XPath selector referencing the parent of the elements
+ to be added to the config file. If you use absolute selectors, you
+ can use a wildcard (`*`) to specify the root element,
+ e.g., `/*/plugins`.
+
+ For `plist` files, the `parent` determines under what parent key the
+ specified XML should be inserted.
+
+ If the selector does not resolve to a child of the specified
+ document, the tool stops and reverses the installation process,
+ issues a warning, and exits with a non-zero code.
+
+## <plugins-plist>
+
+This is _outdated_ as it only applies to cordova-ios 2.2.0 and
+below. Use the `<config-file>` tag for newer versions of Cordova.
+
+Example:
+
+ <config-file target="config.xml" parent="/widget/plugins">
+ <plugin name="ChildBrowser" value="ChildBrowserCommand"/>
+ </config-file>
+
+Specifies a key and value to append to the correct `AppInfo.plist`
+file in an iOS Cordova project. For example:
+
+ <plugins-plist key="Foo" string="CDVFoo" />
+
+## <resource-file> and <header-file>
+
+Like source files, but specifically for platforms such as iOS that
+distinguish between source files, headers, and resources. Examples:
+
+ <resource-file src="CDVFoo.bundle" />
+ <resource-file src="CDVFooViewController.xib" />
+ <header-file src="CDVFoo.h" />
+
+## <lib-file>
+
+Like source, resource, and header files, but specifically for
+platforms such as BlackBerry 10 that use user-generated libraries.
+Examples:
+
+ <lib-file src="src/BlackBerry10/native/device/libfoo.so" arch="device" />
+ <lib-file src="src/BlackBerry10/native/simulator/libfoo.so" arch="simulator" />
+
+Supported attributes:
+
+* `src` (required):
+ The location of the file relative to `plugin.xml`.
+ If `src` cannot be found, plugman stops and reverses the
+ installation, issues a warning about the problem, and exits with a
+ non-zero code.
+
+* `arch`: The architecture for which the `.so` file has been built,
+ either `device` or `simulator`.
+
+## <framework>
+
+Identifies a framework (usually part of the OS/platform) on which the plugin depends.
+
+Examples:
+
+ <framework src="libsqlite3.dylib" />
+ <framework src="social.framework" weak="true" />
+
+
+
+
+The `src` attribute identifies the framework, which plugman attempts
+to add to the Cordova project, in the correct fashion for a given
+platform.
+
+The optional `weak` attribute is a boolean indicating whether the
+framework should be weakly linked. The default is `false`.
+
+## <info>
+
+Additional information provided to users. This is useful when you
+require extra steps that can't be easily automated or are beyond
+plugman's scope. Examples:
+
+ <info>
+ You need to install **Google Play Services** from the `Android Extras` section using the Android SDK manager (run `android`).
+
+ You need to add the following line to your `local.properties`
+
+ android.library.reference.1=PATH_TO_ANDROID_SDK/sdk/extras/google/google_play_services/libproject/google-play-services_lib
+ </info>
+
+# Variables
+
+In certain cases, a plugin may need to make configuration changes
+dependent on the target application. For example, to register for C2DM
+on Android, an app whose package id is `com.alunny.message` would
+require a permission such as:
+
+ <uses-permission
+ android:name="com.alunny.message.permission.C2D_MESSAGE"/>
+
+In such cases where the content inserted from the `plugin.xml` file is
+not known ahead of time, variables can be indicated by a dollar-sign
+followed by a series of capital letters, digits, or underscores. For
+the above example, the `plugin.xml` file would include this tag:
+
+ <uses-permission
+ android:name="$PACKAGE_NAME.permission.C2D_MESSAGE"/>
+
+plugman replaces variable references with the specified value, or the
+empty string if not found. The value of the variable reference may be
+detected (in this case, from the `AndroidManifest.xml` file) or
+specified by the user of the tool; the exact process is dependent on
+the particular tool.
+
+plugman can request users to specify a plugin's required
+variables. For example, API keys for C2M and Google Maps can be
+specified as a command-line argument:
+
+ plugman --platform android --project /path/to/project --plugin name|git-url|path --variable API_KEY=!@CFATGWE%^WGSFDGSDFW$%^#$%YTHGsdfhsfhyer56734
+
+To make the variable mandatory, the `<platform>` tag needs to contain
+a `<preference>` tag. For example:
+
+ <preference name="API_KEY" />
+
+plugman checks that these required preferences are passed in. If not,
+it should warn the user how to pass the variable in and exit with a
+non-zero code.
+
+Certain variable names should be reserved, as listed below.
+
+## $PACKAGE_NAME
+
+The reverse-domain style unique identifier for the package,
+corresponding to the `CFBundleIdentifier` on iOS or the `package`
+attribute of the top-level `manifest` element in an
+`AndroidManifest.xml` file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/privacy/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/privacy/index.md b/docs/en/3.0.0rc1/guide/privacy/index.md
new file mode 100644
index 0000000..7603e08
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/privacy/index.md
@@ -0,0 +1,110 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Privacy Guide
+
+Mobile privacy is a critical issue that every app developer must address. Your users expect that their private information will be collected and treated appropriately by your app. Also, there are an increasing number of jurisdictions that now have legal requirements regarding mobile privacy practices.
+
+This guide on mobile app privacy should be considered a "primer" addressing some the most significant issues. It outlines some broadly accepted best practices and provides references to other more detailed guides and references.
+
+* **Privacy Policy**: You app should include a privacy policy that
+ addresses topics such as what kind of information your app collects
+ from or about your users, how that information is used, with whom it
+ is shared, and how users can make privacy-related choices within the
+ app. To aid understanding, you should use plain language and avoid
+ technical jargon. You should make your privacy policy available for
+ users to review prior to download, such as in the app description in
+ the app marketplace. In addition, you should make your privacy
+ policy available within the app itself. The limited size of mobile
+ device displays creates challenges for displaying privacy policies
+ to users. Consider developing a "short form" of the policy that
+ includes the most important information, and then provide a link to
+ the "long form" policy for those interested in more details. Several
+ groups are attempting to develop icon-based standards for
+ communicating privacy practices, which you may want to consider once
+ these standards mature.
+
+* **Collection of sensitive information**: An app's collection of
+ sensitive personal information raises important privacy concerns.
+ Examples of sensitive personal information include financial
+ information, health information, and information from or about
+ children. It also includes information gathered from certain sensors
+ and databases typically found on mobile devices and tablets, such as
+ geolocation information, contacts/phonebook, microphone/camera, and
+ stored pictures/videos. See the following documentation pages for
+ more information: [camera](cordova_camera_camera.md.html),
+ [capture](cordova_media_capture_capture.md.html),
+ [contacts](cordova_contacts_contacts.md.html), and
+ [geolocation](cordova_geolocation_geolocation.md.html). Generally,
+ you should obtain a user's express permission before collecting
+ sensitive information and, if possible, provide a control mechanism
+ that allows a user to easily change permissions. App operating
+ systems can help in some instances by presenting just-in-time dialog
+ boxes that ask for the user's permission before collection. In these
+ cases, be sure to take advantage of any opportunity to customize the
+ dialog box text to clarify how the app uses and, if applicable,
+ shares such information.
+
+* **Avoiding user surprise**: If your app collects or uses information
+ in a way that may be surprising to users in light of the primary
+ purpose of your app (for example, a music player that accesses
+ stored pictures), you should take similar steps as with the
+ collection of sensitive personal information. That is, you should
+ strongly consider the use of just-in-time dialog boxes to inform the
+ user about the collection or use of that information and, if
+ appropriate, provide a corresponding privacy control.
+
+* **Third party data collection or sharing**: If you app collects
+ information that is provided to another company--such as a social
+ networking platform or an ad network (for example, if your app
+ displays advertising)--you should inform your users of that
+ collection and sharing. At a minimum, your privacy policy should
+ describe the information collection and sharing and, if appropriate,
+ offer your users the ability to control or opt-out of such
+ collection or sharing.
+
+* **Collection limitation and security**: Your users entrust your app
+ with their information and they expect that you will take
+ appropriate security precautions to protect it. One of the best ways
+ to avoid security compromises of personal information is not to
+ collect the information in the first place unless your app has a
+ specific and legitimate business reason for the collection. For
+ information that does need to be collected, ensure that you provide
+ appropriate security controls to protect that information, whether
+ it is stored on the device or on your backend servers. You should
+ also develop an appropriate data retention policy that is
+ implemented within the app and on your backend servers.
+
+Following are some additional helpful mobile privacy guides for developers:
+
+* California Attorney General, [Privacy on the Go: Recommendations for the Mobile Ecosystem][1]
+
+* Center for Democracy & Technology, Future of Privacy Forum, [Best Practices for Mobile App Developers][2]
+
+* CTIA-The Wireless Association, [Best Practices and Guidelines for Location Based Services][3]
+
+* Federal Trade Commission, [Mobile Privacy Disclosures: Building Trust Through Transparency][4]
+
+* Future of Privacy Forum, [Application Privacy][5] Website
+
+[1]: http://oag.ca.gov/sites/all/files/pdfs/privacy/privacy_on_the_go.pdf
+[2]: http://www.futureofprivacy.org/wp-content/uploads/Best-Practices-for-Mobile-App-Developers_Final.pdf
+[3]: http://www.ctia.org/business_resources/wic/index.cfm/AID/11300
+[4]: http://www.ftc.gov/os/2013/02/130201mobileprivacyreport.pdf
+[5]: http://www.applicationprivacy.org
[06/12] Version 3.0.0rc1
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/media.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/media.pause.md b/docs/en/3.0.0rc1/cordova/media/media.pause.md
new file mode 100644
index 0000000..0c3712a
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/media.pause.md
@@ -0,0 +1,167 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+media.pause
+===========
+
+Pauses playing an audio file.
+
+ media.pause();
+
+Description
+-----------
+
+The `media.pause` method executes synchronously, and pauses playing an audio file.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Play audio
+ //
+ function playAudio(url) {
+ // Play the audio file at url
+ var my_media = new Media(url,
+ // success callback
+ function () { console.log("playAudio():Audio Success"); },
+ // error callback
+ function (err) { console.log("playAudio():Audio Error: " + err); }
+ );
+
+ // Play audio
+ my_media.play();
+
+ // Pause after 10 seconds
+ setTimeout(function () {
+ media.pause();
+ }, 10000);
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Media Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
+ }
+
+ // Audio player
+ //
+ var my_media = null;
+ var mediaTimer = null;
+
+ // Play audio
+ //
+ function playAudio(src) {
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
+
+ // Play audio
+ my_media.play();
+
+ // Update my_media position every second
+ if (mediaTimer == null) {
+ mediaTimer = setInterval(function() {
+ // get my_media position
+ my_media.getCurrentPosition(
+ // success callback
+ function(position) {
+ if (position > -1) {
+ setAudioPosition((position) + " sec");
+ }
+ },
+ // error callback
+ function(e) {
+ console.log("Error getting pos=" + e);
+ setAudioPosition("Error: " + e);
+ }
+ );
+ }, 1000);
+ }
+ }
+
+ // Pause audio
+ //
+ function pauseAudio() {
+ if (my_media) {
+ my_media.pause();
+ }
+ }
+
+ // Stop audio
+ //
+ function stopAudio() {
+ if (my_media) {
+ my_media.stop();
+ }
+ clearInterval(mediaTimer);
+ mediaTimer = null;
+ }
+
+ // onSuccess Callback
+ //
+ function onSuccess() {
+ console.log("playAudio():Audio Success");
+ }
+
+ // onError Callback
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Set audio position
+ //
+ function setAudioPosition(position) {
+ document.getElementById('audio_position').innerHTML = position;
+ }
+
+ </script>
+ </head>
+ <body>
+ <a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
+ <a href="#" class="btn large" onclick="pauseAudio();">Pause Playing Audio</a>
+ <a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
+ <p id="audio_position"></p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/media.play.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/media.play.md b/docs/en/3.0.0rc1/cordova/media/media.play.md
new file mode 100644
index 0000000..4ddc625
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/media.play.md
@@ -0,0 +1,200 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+media.play
+==========
+
+Starts or resumes playing an audio file.
+
+ media.play();
+
+Description
+-----------
+
+The `media.play` method executes synchronously, and starts or resumes
+playing an audio file.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Play audio
+ //
+ function playAudio(url) {
+ // Play the audio file at url
+ var my_media = new Media(url,
+ // success callback
+ function () {
+ console.log("playAudio():Audio Success");
+ },
+ // error callback
+ function (err) {
+ console.log("playAudio():Audio Error: " + err);
+ }
+ );
+ // Play audio
+ my_media.play();
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Media Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
+ }
+
+ // Audio player
+ //
+ var my_media = null;
+ var mediaTimer = null;
+
+ // Play audio
+ //
+ function playAudio(src) {
+ if (my_media == null) {
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
+ } // else play current audio
+ // Play audio
+ my_media.play();
+
+ // Update my_media position every second
+ if (mediaTimer == null) {
+ mediaTimer = setInterval(function() {
+ // get my_media position
+ my_media.getCurrentPosition(
+ // success callback
+ function(position) {
+ if (position > -1) {
+ setAudioPosition((position) + " sec");
+ }
+ },
+ // error callback
+ function(e) {
+ console.log("Error getting pos=" + e);
+ setAudioPosition("Error: " + e);
+ }
+ );
+ }, 1000);
+ }
+ }
+
+ // Pause audio
+ //
+ function pauseAudio() {
+ if (my_media) {
+ my_media.pause();
+ }
+ }
+
+ // Stop audio
+ //
+ function stopAudio() {
+ if (my_media) {
+ my_media.stop();
+ }
+ clearInterval(mediaTimer);
+ mediaTimer = null;
+ }
+
+ // onSuccess Callback
+ //
+ function onSuccess() {
+ console.log("playAudio():Audio Success");
+ }
+
+ // onError Callback
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Set audio position
+ //
+ function setAudioPosition(position) {
+ document.getElementById('audio_position').innerHTML = position;
+ }
+
+ </script>
+ </head>
+ <body>
+ <a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
+ <a href="#" class="btn large" onclick="pauseAudio();">Pause Playing Audio</a>
+ <a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
+ <p id="audio_position"></p>
+ </body>
+ </html>
+
+BlackBerry WebWorks Quirks
+----------
+
+- BlackBerry devices support a limited number of simultaneous audio
+ channels. CDMA devices only support a single audio channel. Other
+ devices support up to two simultaneous channels. An attempt to play
+ more audio files than the supported amount results in previous
+ playback being stopped.
+
+iOS Quirks
+----------
+
+- __numberOfLoops__: Pass this option to the `play` method to specify
+ the number of times you want the media file to play, e.g.:
+
+ var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
+ myMedia.play({ numberOfLoops: 2 })
+
+- __playAudioWhenScreenIsLocked__: Pass in this option to the `play`
+ method to specify whether you want to allow playback when the screen
+ is locked. If set to `true` (the default value), the state of the
+ hardware mute button is ignored, e.g.:
+
+ var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
+ myMedia.play({ playAudioWhenScreenIsLocked : false })
+
+- __order of file search__: When only a file name or simple path is
+ provided, iOS searches in the `www` directory for the file, then in
+ the application's `documents/tmp` directory:
+
+ var myMedia = new Media("audio/beer.mp3")
+ myMedia.play() // first looks for file in www/audio/beer.mp3 then in <application>/documents/tmp/audio/beer.mp3
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/media.release.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/media.release.md b/docs/en/3.0.0rc1/cordova/media/media.release.md
new file mode 100644
index 0000000..ec6e5b0
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/media.release.md
@@ -0,0 +1,159 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+media.release
+=================
+
+Releases the underlying operating system's audio resources.
+
+ media.release();
+
+Description
+-----------
+
+The `media.release` method executes synchronously, releasing the
+underlying operating system's audio resources. This is particularly
+important for Android, since there are a finite amount of OpenCore
+instances for media playback. Applications should call the `release`
+function for any `Media` resource that is no longer needed.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Audio player
+ //
+ var my_media = new Media(src, onSuccess, onError);
+
+ my_media.play();
+ my_media.stop();
+ my_media.release();
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Media Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
+ }
+
+ // Audio player
+ //
+ var my_media = null;
+ var mediaTimer = null;
+
+ // Play audio
+ //
+ function playAudio(src) {
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
+
+ // Play audio
+ my_media.play();
+
+ // Update my_media position every second
+ if (mediaTimer == null) {
+ mediaTimer = setInterval(function() {
+ // get my_media position
+ my_media.getCurrentPosition(
+ // success callback
+ function(position) {
+ if (position > -1) {
+ setAudioPosition((position) + " sec");
+ }
+ },
+ // error callback
+ function(e) {
+ console.log("Error getting pos=" + e);
+ setAudioPosition("Error: " + e);
+ }
+ );
+ }, 1000);
+ }
+ }
+
+ // Pause audio
+ //
+ function pauseAudio() {
+ if (my_media) {
+ my_media.pause();
+ }
+ }
+
+ // Stop audio
+ //
+ function stopAudio() {
+ if (my_media) {
+ my_media.stop();
+ }
+ clearInterval(mediaTimer);
+ mediaTimer = null;
+ }
+
+ // onSuccess Callback
+ //
+ function onSuccess() {
+ console.log("playAudio():Audio Success");
+ }
+
+ // onError Callback
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Set audio position
+ //
+ function setAudioPosition(position) {
+ document.getElementById('audio_position').innerHTML = position;
+ }
+
+ </script>
+ </head>
+ <body>
+ <a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
+ <a href="#" class="btn large" onclick="pauseAudio();">Pause Playing Audio</a>
+ <a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
+ <p id="audio_position"></p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/media.seekTo.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/media.seekTo.md b/docs/en/3.0.0rc1/cordova/media/media.seekTo.md
new file mode 100644
index 0000000..20e5c73
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/media.seekTo.md
@@ -0,0 +1,161 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+media.seekTo
+========================
+
+Sets the current position within an audio file.
+
+ media.seekTo(milliseconds);
+
+Parameters
+----------
+
+- __milliseconds__: The position to set the playback position within the audio, in milliseconds.
+
+Description
+-----------
+
+The `media.seekTo` executes asynchronously, updating the current
+playback position within an audio file referenced by a `Media`
+object. Also updates the `Media` object's `position` parameter.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Audio player
+ //
+ var my_media = new Media(src, onSuccess, onError);
+ my_media.play();
+ // SeekTo to 10 seconds after 5 seconds
+ setTimeout(function() {
+ my_media.seekTo(10000);
+ }, 5000);
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Media Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
+ }
+
+ // Audio player
+ //
+ var my_media = null;
+ var mediaTimer = null;
+
+ // Play audio
+ //
+ function playAudio(src) {
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
+
+ // Play audio
+ my_media.play();
+
+ // Update media position every second
+ mediaTimer = setInterval(function() {
+ // get media position
+ my_media.getCurrentPosition(
+ // success callback
+ function(position) {
+ if (position > -1) {
+ setAudioPosition(position + " sec");
+ }
+ },
+ // error callback
+ function(e) {
+ console.log("Error getting pos=" + e);
+ }
+ );
+ }, 1000);
+
+ // SeekTo to 10 seconds after 5 seconds
+ setTimeout(function() {
+ my_media.seekTo(10000);
+ }, 5000);
+ }
+
+ // Stop audio
+ //
+ function stopAudio() {
+ if (my_media) {
+ my_media.stop();
+ }
+ clearInterval(mediaTimer);
+ mediaTimer = null;
+ }
+
+ // onSuccess Callback
+ //
+ function onSuccess() {
+ console.log("playAudio():Audio Success");
+ }
+
+ // onError Callback
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Set audio position
+ //
+ function setAudioPosition(position) {
+ document.getElementById('audio_position').innerHTML = position;
+ }
+
+ </script>
+ </head>
+ <body>
+ <a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
+ <a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
+ <p id="audio_position"></p>
+ </body>
+ </html>
+
+BlackBerry WebWorks Quirks
+----------
+
+- Not supported on BlackBerry OS 5 devices.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/media.setVolume.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/media.setVolume.md b/docs/en/3.0.0rc1/cordova/media/media.setVolume.md
new file mode 100644
index 0000000..b3c4ac6
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/media.setVolume.md
@@ -0,0 +1,178 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+media.setVolume
+===========
+
+Set the volume for an audio file.
+
+ media.setVolume(volume);
+
+Paramters
+---------
+
+- __volume__: The volume to set for playback. The value must be within the range of 0.0 to 1.0.
+
+Description
+-----------
+
+Function `media.setVolume` is an asynchronous function that sets the volume during audio playback.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ // Play audio
+ //
+ function playAudio(url) {
+ // Play the audio file at url
+ var my_media = new Media(url,
+ // success callback
+ function() {
+ console.log("playAudio():Audio Success");
+ },
+ // error callback
+ function(err) {
+ console.log("playAudio():Audio Error: "+err);
+ });
+
+ // Play audio
+ my_media.play();
+
+ // Mute volume after 2 seconds
+ setTimeout(function() {
+ my_media.setVolume('0.0');
+ }, 2000);
+
+ // Set volume to 1.0 after 5 seconds
+ setTimeout(function() {
+ my_media.setVolume('1.0');
+ }, 5000);
+ }
+
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Media Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
+ }
+
+ // Audio player
+ //
+ var my_media = null;
+ var mediaTimer = null;
+
+ // Play audio
+ //
+ function playAudio(src) {
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
+
+ // Play audio
+ my_media.play();
+
+ // Update my_media position every second
+ if (mediaTimer == null) {
+ mediaTimer = setInterval(function() {
+ // get my_media position
+ my_media.getCurrentPosition(
+ // success callback
+ function(position) {
+ if (position > -1) {
+ setAudioPosition((position) + " sec");
+ }
+ },
+ // error callback
+ function(e) {
+ console.log("Error getting pos=" + e);
+ setAudioPosition("Error: " + e);
+ }
+ );
+ }, 1000);
+ }
+ }
+
+ // Set audio volume
+ //
+ function setVolume(volume) {
+ if (my_media) {
+ my_media.setVolume(volume);
+ }
+ }
+
+ // Stop audio
+ //
+ function stopAudio() {
+ if (my_media) {
+ my_media.stop();
+ }
+ clearInterval(mediaTimer);
+ mediaTimer = null;
+ }
+
+ // onSuccess Callback
+ //
+ function onSuccess() {
+ console.log("playAudio():Audio Success");
+ }
+
+ // onError Callback
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Set audio position
+ //
+ function setAudioPosition(position) {
+ document.getElementById('audio_position').innerHTML = position;
+ }
+
+ </script>
+ </head>
+ <body>
+ <a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
+ <a href="#" class="btn large" onclick="setVolume('0.0');">Mute Audio</a>
+ <a href="#" class="btn large" onclick="setVolume('1.0');">Unmute Audio</a>
+ <a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
+ <p id="audio_position"></p>
+ </body>
+ </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/media.startRecord.md b/docs/en/3.0.0rc1/cordova/media/media.startRecord.md
new file mode 100644
index 0000000..76eff26
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/media.startRecord.md
@@ -0,0 +1,155 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+media.startRecord
+=================
+
+Starts recording an audio file.
+
+ media.startRecord();
+
+Description
+-----------
+
+The `media.startRecord` method executes synchronously, starts a
+recording for an audio file.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // Record audio
+ //
+ function recordAudio() {
+ var src = "myrecording.mp3";
+ var mediaRec = new Media(src,
+ // success callback
+ function() {
+ console.log("recordAudio():Audio Success");
+ },
+
+ // error callback
+ function(err) {
+ console.log("recordAudio():Audio Error: "+ err.code);
+ });
+
+ // Record audio
+ mediaRec.startRecord();
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Record audio
+ //
+ function recordAudio() {
+ var src = "myrecording.amr";
+ var mediaRec = new Media(src, onSuccess, onError);
+
+ // Record audio
+ mediaRec.startRecord();
+
+ // Stop recording after 10 sec
+ var recTime = 0;
+ var recInterval = setInterval(function() {
+ recTime = recTime + 1;
+ setAudioPosition(recTime + " sec");
+ if (recTime >= 10) {
+ clearInterval(recInterval);
+ mediaRec.stopRecord();
+ }
+ }, 1000);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ recordAudio();
+ }
+
+ // onSuccess Callback
+ //
+ function onSuccess() {
+ console.log("recordAudio():Audio Success");
+ }
+
+ // onError Callback
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Set audio position
+ //
+ function setAudioPosition(position) {
+ document.getElementById('audio_position').innerHTML = position;
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="media">Recording audio...</p>
+ <p id="audio_position"></p>
+ </body>
+ </html>
+
+Android Quirks
+----------
+
+- Android devices record audio in Adaptive Multi-Rate format. The specified file should end with a _.amr_ extension.
+
+BlackBerry WebWorks Quirks
+----------
+
+- BlackBerry devices record audio in Adaptive Multi-Rate format. The specified file must end with a _.amr_ extension.
+
+iOS Quirks
+----------
+
+- iOS only records to files of type _.wav_ and returns an error if the file name extension is not correct.
+- If a full path is not provided, the recording is placed in the application's `documents/tmp` directory. This can be accessed via the `File` API using `LocalFileSystem.TEMPORARY`. Any subdirectory specified at record time must already exist.
+- Files can be recorded and played back using the documents URI:
+
+ var myMedia = new Media("documents://beer.mp3")
+
+Tizen Quirks
+----------
+
+- Not supported on Tizen devices.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/media.stop.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/media.stop.md b/docs/en/3.0.0rc1/cordova/media/media.stop.md
new file mode 100644
index 0000000..ec53ea9
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/media.stop.md
@@ -0,0 +1,172 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+media.stop
+==========
+
+Stops playing an audio file.
+
+ media.stop();
+
+Description
+-----------
+
+The `media.stop` method executes synchronously to stop playing an
+audio file.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Play audio
+ //
+ function playAudio(url) {
+ // Play the audio file at url
+ var my_media = new Media(url,
+ // success callback
+ function() {
+ console.log("playAudio():Audio Success");
+ },
+ // error callback
+ function(err) {
+ console.log("playAudio():Audio Error: "+err);
+ }
+ );
+
+ // Play audio
+ my_media.play();
+
+ // Pause after 10 seconds
+ setTimeout(function() {
+ my_media.stop();
+ }, 10000);
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Media Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
+ }
+
+ // Audio player
+ //
+ var my_media = null;
+ var mediaTimer = null;
+
+ // Play audio
+ //
+ function playAudio(src) {
+ // Create Media object from src
+ my_media = new Media(src, onSuccess, onError);
+
+ // Play audio
+ my_media.play();
+
+ // Update my_media position every second
+ if (mediaTimer == null) {
+ mediaTimer = setInterval(function() {
+ // get my_media position
+ my_media.getCurrentPosition(
+ // success callback
+ function(position) {
+ if (position > -1) {
+ setAudioPosition((position) + " sec");
+ }
+ },
+ // error callback
+ function(e) {
+ console.log("Error getting pos=" + e);
+ setAudioPosition("Error: " + e);
+ }
+ );
+ }, 1000);
+ }
+ }
+
+ // Pause audio
+ //
+ function pauseAudio() {
+ if (my_media) {
+ my_media.pause();
+ }
+ }
+
+ // Stop audio
+ //
+ function stopAudio() {
+ if (my_media) {
+ my_media.stop();
+ }
+ clearInterval(mediaTimer);
+ mediaTimer = null;
+ }
+
+ // onSuccess Callback
+ //
+ function onSuccess() {
+ console.log("playAudio():Audio Success");
+ }
+
+ // onError Callback
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Set audio position
+ //
+ function setAudioPosition(position) {
+ document.getElementById('audio_position').innerHTML = position;
+ }
+
+ </script>
+ </head>
+ <body>
+ <a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a>
+ <a href="#" class="btn large" onclick="pauseAudio();">Pause Playing Audio</a>
+ <a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a>
+ <p id="audio_position"></p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/media/media.stopRecord.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/media/media.stopRecord.md b/docs/en/3.0.0rc1/cordova/media/media.stopRecord.md
new file mode 100644
index 0000000..f71324e
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/media/media.stopRecord.md
@@ -0,0 +1,142 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+media.stopRecord
+================
+
+Stops recording an audio file.
+
+ media.stopRecord();
+
+Description
+-----------
+
+The `media.stopRecord` method executes synchronously, stopping the
+recording of an audio file.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // Record audio
+ //
+ function recordAudio() {
+ var src = "myrecording.mp3";
+ var mediaRec = new Media(src,
+ // success callback
+ function() {
+ console.log("recordAudio():Audio Success");
+ },
+
+ // error callback
+ function(err) {
+ console.log("recordAudio():Audio Error: "+ err.code);
+ }
+ );
+
+ // Record audio
+ mediaRec.startRecord();
+
+ // Stop recording after 10 seconds
+ setTimeout(function() {
+ mediaRec.stopRecord();
+ }, 10000);
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Record audio
+ //
+ function recordAudio() {
+ var src = "myrecording.mp3";
+ var mediaRec = new Media(src, onSuccess, onError);
+
+ // Record audio
+ mediaRec.startRecord();
+
+ // Stop recording after 10 sec
+ var recTime = 0;
+ var recInterval = setInterval(function() {
+ recTime = recTime + 1;
+ setAudioPosition(recTime + " sec");
+ if (recTime >= 10) {
+ clearInterval(recInterval);
+ mediaRec.stopRecord();
+ }
+ }, 1000);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ recordAudio();
+ }
+
+ // onSuccess Callback
+ //
+ function onSuccess() {
+ console.log("recordAudio():Audio Success");
+ }
+
+ // onError Callback
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Set audio position
+ //
+ function setAudioPosition(position) {
+ document.getElementById('audio_position').innerHTML = position;
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="media">Recording audio...</p>
+ <p id="audio_position"></p>
+ </body>
+ </html>
+
+Tizen Quirks
+----------
+
+- Not supported on Tizen devices.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/notification/notification.alert.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/notification/notification.alert.md b/docs/en/3.0.0rc1/cordova/notification/notification.alert.md
new file mode 100644
index 0000000..8935b22
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/notification/notification.alert.md
@@ -0,0 +1,117 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+notification.alert
+==================
+
+Shows a custom alert or dialog box.
+
+ navigator.notification.alert(message, alertCallback, [title], [buttonName])
+
+- __message__: Dialog message. _(String)_
+- __alertCallback__: Callback to invoke when alert dialog is dismissed. _(Function)_
+- __title__: Dialog title. _(String)_ (Optional, defaults to `Alert`)
+- __buttonName__: Button name. _(String)_ (Optional, defaults to `OK`)
+
+Description
+-----------
+
+Most Cordova implementations use a native dialog box for this feature,
+but some platforms use the browser's `alert` function, which is
+typically less customizable.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // Android / BlackBerry WebWorks (OS 5.0 and higher) / iOS / Tizen
+ //
+ function alertDismissed() {
+ // do something
+ }
+
+ navigator.notification.alert(
+ 'You are the winner!', // message
+ alertDismissed, // callback
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Notification Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // alert dialog dismissed
+ function alertDismissed() {
+ // do something
+ }
+
+ // Show a custom alertDismissed
+ //
+ function showAlert() {
+ navigator.notification.alert(
+ 'You are the winner!', // message
+ alertDismissed, // callback
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
+ </body>
+ </html>
+
+Windows Phone 7 and 8 Quirks
+-------------
+
+- There is no built-in browser alert, but you can bind one as follows to call `alert()` in the global scope:
+
+ window.alert = navigator.notification.alert;
+
+- Both `alert` and `confirm` are non-blocking calls, results of which are only available asynchronously.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/notification/notification.beep.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/notification/notification.beep.md b/docs/en/3.0.0rc1/cordova/notification/notification.beep.md
new file mode 100644
index 0000000..bcddc07
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/notification/notification.beep.md
@@ -0,0 +1,111 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+notification.beep
+=================
+
+The device plays a beep sound.
+
+ navigator.notification.beep(times);
+
+- __times__: The number of times to repeat the beep. _(Number)_
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+
+Quick Example
+-------------
+
+ // Beep twice!
+ navigator.notification.beep(2);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Notification Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // Show a custom alert
+ //
+ function showAlert() {
+ navigator.notification.alert(
+ 'You are the winner!', // message
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
+ }
+
+ // Beep three times
+ //
+ function playBeep() {
+ navigator.notification.beep(3);
+ }
+
+ // Vibrate for 2 seconds
+ //
+ function vibrate() {
+ navigator.notification.vibrate(2000);
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
+ <p><a href="#" onclick="playBeep(); return false;">Play Beep</a></p>
+ <p><a href="#" onclick="vibrate(); return false;">Vibrate</a></p>
+ </body>
+ </html>
+
+Android Quirks
+--------------
+
+- Android plays the default __Notification ringtone__ specified under the __Settings/Sound & Display__ panel.
+
+Windows Phone 7 and 8 Quirks
+-------------
+
+- Relies on a generic beep file from the Cordova distribution.
+
+Tizen Quirks
+-------------
+
+- Tizen implements beeps by playing an audio file via the media API.
+- The beep file must be short, must be located in a `sounds` sub-directory of the application's root directory, and must be named `beep.wav`.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/notification/notification.confirm.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/notification/notification.confirm.md b/docs/en/3.0.0rc1/cordova/notification/notification.confirm.md
new file mode 100755
index 0000000..77c581a
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/notification/notification.confirm.md
@@ -0,0 +1,129 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+notification.confirm
+====================
+
+Displays a customizable confirmation dialog box.
+
+ navigator.notification.confirm(message, confirmCallback, [title], [buttonLabels])
+
+- __message__: Dialog message. _(String)_
+- __confirmCallback__: Callback to invoke with index of button pressed (1, 2, or 3) or when the dialog is dismissed without a button press (0). _(Function)_
+- __title__: Dialog title. _(String)_ (Optional, defaults to `Confirm`)
+- __buttonLabels__: Comma-separated string specifying button labels. _(String)_ (Optional, defaults to `OK,Cancel`)
+
+Description
+-----------
+
+The `notification.confirm` method displays a native dialog box that is
+more customizable than the browser's `confirm` function.
+
+confirmCallback
+---------------
+
+The `confirmCallback` executes when the user presses one of the
+buttons in the confirmation dialog box.
+
+The callback takes the argument `buttonIndex` _(Number)_, which is the
+index of the pressed button. Note that the index uses one-based
+indexing, so the value is `1`, `2`, `3`, etc.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // process the confirmation dialog result
+ function onConfirm(buttonIndex) {
+ alert('You selected button ' + buttonIndex);
+ }
+
+ // Show a custom confirmation dialog
+ //
+ function showConfirm() {
+ navigator.notification.confirm(
+ 'You are the winner!', // message
+ onConfirm, // callback to invoke with index of button pressed
+ 'Game Over', // title
+ 'Restart,Exit' // buttonLabels
+ );
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Notification Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // process the confirmation dialog result
+ function onConfirm(buttonIndex) {
+ alert('You selected button ' + buttonIndex);
+ }
+
+ // Show a custom confirmation dialog
+ //
+ function showConfirm() {
+ navigator.notification.confirm(
+ 'You are the winner!', // message
+ onConfirm, // callback to invoke with index of button pressed
+ 'Game Over', // title
+ 'Restart,Exit' // buttonLabels
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showConfirm(); return false;">Show Confirm</a></p>
+ </body>
+ </html>
+
+Windows Phone 7 and 8 Quirks
+----------------------
+
+- There is no built-in browser function for `window.confirm`, but you can bind it by assigning:
+
+ window.confirm = navigator.notification.confirm;
+
+- Calls to `alert` and `confirm` are non-blocking, so the result is only available asynchronously.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/notification/notification.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/notification/notification.md b/docs/en/3.0.0rc1/cordova/notification/notification.md
new file mode 100644
index 0000000..d72d51b
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/notification/notification.md
@@ -0,0 +1,69 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Notification
+============
+
+> Visual, audible, and tactile device notifications.
+
+Methods
+-------
+
+- `notification.alert`
+- `notification.confirm`
+- `notification.prompt`
+- `notification.beep`
+- `notification.vibrate`
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Notification" value="org.apache.cordova.Notification"/>
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.VIBRATE" />
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Notification" value="org.apache.cordova.notification.Notification" />
+
+#### www/config.xml
+
+ <feature id="blackberry.ui.dialog" />
+
+### iOS
+
+#### config.xml
+
+ <plugin name="Notification" value="CDVNotification" />
+
+### Windows Phone
+
+ No permissions are required.
+
+### Tizen
+
+ No permissions are required.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/notification/notification.prompt.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/notification/notification.prompt.md b/docs/en/3.0.0rc1/cordova/notification/notification.prompt.md
new file mode 100644
index 0000000..8b654c7
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/notification/notification.prompt.md
@@ -0,0 +1,124 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+notification.prompt
+====================
+
+Shows a customizable prompt dialog box.
+
+ navigator.notification.prompt(message, promptCallback, [title], [buttonLabels], [defaultText])
+
+- __message__: Dialog message. _(String)_
+- __promptCallback__: Callback to invoke when a button is pressed. _(Function)_
+- __title__: Dialog title _(String)_ (Optional, defaults to `Prompt`)
+- __buttonLabels__: Array of strings specifying button labels _(Array)_ (Optional, defaults to `["OK","Cancel"]`)
+- __defaultText__: Default textbox input value (`String`) (Optional, Default: "Default text")
+
+Description
+-----------
+
+The `notification.prompt` method displays a native dialog box that is
+more customizable than the browser's `prompt` function.
+
+promptCallback
+---------------
+
+The `promptCallback` executes when the user presses one of the buttons
+in the prompt dialog box. The `results` object passed to the callback
+contains the following properties:
+
+- __buttonIndex__: The index of the pressed button. _(Number)_ Note that the index uses one-based indexing, so the value is `1`, `2`, `3`, etc.
+- __input1__: The text entered in the prompt dialog box. _(String)_
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ // process the promp dialog results
+ function onPrompt(results) {
+ alert("You selected button number " + results.buttonIndex + " and entered " + results.input1);
+ }
+
+ // Show a custom prompt dialog
+ //
+ function showPrompt() {
+ navigator.notification.prompt(
+ 'Please enter your name', // message
+ onPrompt, // callback to invoke
+ 'Registration', // title
+ ['Ok','Exit'], // buttonLabels
+ 'Jane Doe' // defaultText
+ );
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Notification Prompt Dialog Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // process the promptation dialog result
+ function onPrompt(results) {
+ alert("You selected button number " + results.buttonIndex + " and entered " + results.input1);
+ }
+
+ // Show a custom prompt dialog
+ //
+ function showPrompt() {
+ navigator.notification.prompt(
+ 'Please enter your name', // message
+ onPrompt, // callback to invoke
+ 'Registration', // title
+ ['Ok','Exit'], // buttonLabels
+ 'Jane Doe' // defaultText
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showPrompt(); return false;">Show Prompt</a></p>
+ </body>
+ </html>
+
+Android Quirks
+----------------------
+
+- Android supports a maximum of three buttons, and ignores any more than that.
+- On Android 3.0 and later, buttons are displayed in reverse order for devices that use the Holo theme.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/notification/notification.vibrate.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/notification/notification.vibrate.md b/docs/en/3.0.0rc1/cordova/notification/notification.vibrate.md
new file mode 100644
index 0000000..ecf8cdb
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/notification/notification.vibrate.md
@@ -0,0 +1,102 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+notification.vibrate
+====================
+
+Vibrates the device for the specified amount of time.
+
+ navigator.notification.vibrate(milliseconds)
+
+- __time__: Milliseconds to vibrate the device, where 1000 milliseconds equals 1 second. _(Number)_
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+
+Quick Example
+-------------
+
+ // Vibrate for 2.5 seconds
+ //
+ navigator.notification.vibrate(2500);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Notification Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Empty
+ }
+
+ // Show a custom alert
+ //
+ function showAlert() {
+ navigator.notification.alert(
+ 'You are the winner!', // message
+ 'Game Over', // title
+ 'Done' // buttonName
+ );
+ }
+
+ // Beep three times
+ //
+ function playBeep() {
+ navigator.notification.beep(3);
+ }
+
+ // Vibrate for 2 seconds
+ //
+ function vibrate() {
+ navigator.notification.vibrate(2000);
+ }
+
+ </script>
+ </head>
+ <body>
+ <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
+ <p><a href="#" onclick="playBeep(); return false;">Play Beep</a></p>
+ <p><a href="#" onclick="vibrate(); return false;">Vibrate</a></p>
+ </body>
+ </html>
+
+iOS Quirks
+-------------
+
+- __time__: Ignores the specified time and vibrates for a pre-set amount of time.
+
+ navigator.notification.vibrate();
+ navigator.notification.vibrate(2500); // 2500 is ignored
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.hide.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.hide.md b/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.hide.md
new file mode 100644
index 0000000..2ef8c77
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.hide.md
@@ -0,0 +1,80 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+splashscreen.hide
+===============
+
+Dismiss the splash screen.
+
+ navigator.splashscreen.hide();
+
+Description
+-----------
+
+This method dismisses the application's splash screen.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ navigator.splashscreen.hide();
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Splashscreen Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ navigator.splashscreen.hide();
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ </body>
+ </html>
+
+iOS Quirk
+------------
+
+The `config.xml` file's `AutoHideSplashScreen` setting must be
+`false`. To delay hiding the splash screen for two seconds, add a
+timer such as the following in the `deviceready` event handler:
+
+ setTimeout(function() {
+ navigator.splashscreen.hide();
+ }, 2000);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.md b/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.md
new file mode 100644
index 0000000..c2cc060
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.md
@@ -0,0 +1,81 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Splashscreen
+==========
+
+> Displays and hides the application's splash screen.
+
+Methods
+-------
+
+- splashscreen.show
+- splashscreen.hide
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="SplashScreen" value="org.apache.cordova.SplashScreen"/>
+
+### iOS
+
+#### config.xml
+
+ <plugin name="SplashScreen" value="CDVSplashScreen" />
+
+Setup
+-----
+
+### Android
+
+1. Copy the splash screen image into the Android project's `res/drawable` directory. The size for each image should be:
+
+ - xlarge (xhdpi): at least 960 × 720
+ - large (hdpi): at least 640 × 480
+ - medium (mdpi): at least 470 × 320
+ - small (ldpi): at least 426 × 320
+
+ You should use a [9-patch image](https://developer.android.com/tools/help/draw9patch.html) for your splash screen.
+
+2. In the `onCreate` method of the class that extends `DroidGap`, add the following two lines:
+
+ super.setIntegerProperty("splashscreen", R.drawable.splash);
+ super.loadUrl(Config.getStartUrl(), 10000);
+
+ The first line sets the image to display as the splashscreen. If you name your image anything other than `splash.png`, you need to modify this line.
+ The second line is the normal `super.loadUrl` line, but it has a second parameter that specifies a timeout value for the splash screen. In this example the splash screen displays for 10 seconds. To dismiss the splash screen once the app receives the `deviceready` event, call the `navigator.splashscreen.hide()` method.
+
+### iOS
+
+Copy your splash screen images into the iOS project's
+`Resources/splash` directory. Only add the images for the devices you
+want to support, such as iPad or iPhone. The size of each image
+should be:
+
+- Default-568h@2x~iphone.png (640x1136 pixels)
+- Default-Landscape@2x~ipad.png (2048x1496 pixels)
+- Default-Landscape~ipad.png (1024x748 pixels)
+- Default-Portrait@2x~ipad.png (1536x2008 pixels)
+- Default-Portrait~ipad.png (768x1004 pixels)
+- Default@2x~iphone.png (640x960 pixels)
+- Default~iphone.png (320x480 pixels)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.show.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.show.md b/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.show.md
new file mode 100644
index 0000000..f4f4d8a
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/splashscreen/splashscreen.show.md
@@ -0,0 +1,69 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+splashscreen.show
+===============
+
+Displays the splash screen.
+
+ navigator.splashscreen.show();
+
+Description
+-----------
+
+This method displays the application's splash screen.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ navigator.splashscreen.show();
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Splashscreen Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ navigator.splashscreen.show();
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/database/database.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/database/database.md b/docs/en/3.0.0rc1/cordova/storage/database/database.md
new file mode 100644
index 0000000..97b3ffd
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/database/database.md
@@ -0,0 +1,119 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Database
+=======
+
+Provides access to an SQL database.
+
+Methods
+-------
+
+- __transaction__: Runs a database transaction.
+- __changeVersion__: Allows scripts to automatically verify the version number and change it when updating a schema.
+
+Details
+-------
+
+The `window.openDatabase()` method returns a `Database` object.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iOS
+- Tizen
+
+Transaction Quick Example
+------------------
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ function errorCB(err) {
+ alert("Error processing SQL: "+err.code);
+ }
+
+ function successCB() {
+ alert("success!");
+ }
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+
+Change Version Quick Example
+-------------------
+
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.changeVersion("1.0", "1.1");
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000);
+ db.transaction(populateDB, errorCB, successCB);
+ }
+
+ // Populate the database
+ //
+ function populateDB(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS DEMO');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")');
+ tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")');
+ }
+
+ // Transaction error callback
+ //
+ function errorCB(tx, err) {
+ alert("Error processing SQL: "+err);
+ }
+
+ // Transaction success callback
+ //
+ function successCB() {
+ alert("success!");
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Database</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/localstorage/localstorage.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/localstorage/localstorage.md b/docs/en/3.0.0rc1/cordova/storage/localstorage/localstorage.md
new file mode 100644
index 0000000..9d36dd8
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/localstorage/localstorage.md
@@ -0,0 +1,122 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+localStorage
+===============
+
+Provides access to a [W3C Storage interface](http://dev.w3.org/html5/webstorage/#the-localstorage-attribute)
+
+ var storage = window.localStorage;
+
+Methods
+-------
+
+- __key__: Returns the name of the key at the specified position.
+- __getItem__: Returns the item identified by the specified key.
+- __setItem__: Assigns a keyed item's value.
+- __removeItem__: Removes the item identified by the specified key.
+- __clear__: Removes all of the key/value pairs.
+
+Details
+-----------
+
+The `window.localStorage` interface is based on the W3C Web Storage
+interface. An app can use it to save persistent data using key-value
+pairs. The `window.sessionStorage` interface works the same way, but
+all data is cleared each time the app closes.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 6.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+
+Key Quick Example
+-------------
+
+ var keyName = window.localStorage.key(0);
+
+Set Item Quick Example
+-------------
+
+ window.localStorage.setItem("key", "value");
+
+Get Item Quick Example
+-------------
+
+ var value = window.localStorage.getItem("key");
+ // value is now equal to "value"
+
+Remove Item Quick Example
+-------------
+
+ window.localStorage.removeItem("key");
+
+Clear Quick Example
+-------------
+
+ window.localStorage.clear();
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Storage Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ window.localStorage.setItem("key", "value");
+ var keyname = window.localStorage.key(i);
+ // keyname is now equal to "key"
+ var value = window.localStorage.getItem("key");
+ // value is now equal to "value"
+ window.localStorage.removeItem("key");
+ window.localStorage.setItem("key2", "value2");
+ window.localStorage.clear();
+ // localStorage is now empty
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>localStorage</p>
+ </body>
+ </html>
+
+Windows Phone 7 Quirks
+-------------
+
+Dot notation is _not_ available on Windows Phone 7. Be sure to use
+`setItem` or `getItem`, rather than accessing keys directly from the
+storage object, such as `window.localStorage.someKey`.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/parameters/display_name.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/parameters/display_name.md b/docs/en/3.0.0rc1/cordova/storage/parameters/display_name.md
new file mode 100644
index 0000000..226a0c6
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/parameters/display_name.md
@@ -0,0 +1,23 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+database_displayname
+==================
+
+The display name of the database.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/storage/parameters/name.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/storage/parameters/name.md b/docs/en/3.0.0rc1/cordova/storage/parameters/name.md
new file mode 100644
index 0000000..b1c6a85
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/storage/parameters/name.md
@@ -0,0 +1,23 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+database_name
+============
+
+The name of the database.
[11/12] Version 3.0.0rc1
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/compass/compass.md b/docs/en/3.0.0rc1/cordova/compass/compass.md
new file mode 100755
index 0000000..43ca2bc
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/compass/compass.md
@@ -0,0 +1,73 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Compass
+=======
+
+> Obtains the direction that the device is pointing.
+
+Methods
+-------
+
+- compass.getCurrentHeading
+- compass.watchHeading
+- compass.clearWatch
+- compass.watchHeadingFilter (obsolete)
+- compass.clearWatchFilter (obsolete)
+
+Arguments
+---------
+
+- compassSuccess
+- compassError
+- compassOptions
+- compassHeading
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Compass" value="org.apache.cordova.CompassListener" />
+
+### BlackBerry WebWorks
+
+ No permissions are required.
+
+### iOS
+
+#### config.xml
+
+ <plugin name="Compass" value="CDVLocation" />
+
+### Windows Phone
+
+#### Properties/WPAppManifest.xml
+
+ <Capabilities>
+ <Capability Name="ID_CAP_SENSORS" />
+ </Capabilities>
+
+Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+
+### Tizen
+
+ No permissions are required.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/compass/compass.watchHeading.md b/docs/en/3.0.0rc1/cordova/compass/compass.watchHeading.md
new file mode 100755
index 0000000..7abf436
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/compass/compass.watchHeading.md
@@ -0,0 +1,152 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+compass.watchHeading
+====================
+
+At a regular interval, get the compass heading in degrees.
+
+ var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
+
+Description
+-----------
+
+The compass is a sensor that detects the direction or heading that the
+device is pointed. It measures the heading in degrees from 0 to
+359.99.
+
+The `compass.watchHeading` gets the device's current heading at a
+regular interval. Each time the heading is retrieved, the
+`headingSuccess` callback function is executed. Specify the interval
+in milliseconds via the `frequency` parameter in the `compassOptions`
+object.
+
+The returned watch ID references the compass watch interval. The watch
+ID can be used with `compass.clearWatch` to stop watching the compass.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+- Tizen
+- Windows Phone 7 and 8 (if available in hardware)
+- Windows 8
+
+Quick Example
+-------------
+
+ function onSuccess(heading) {
+ var element = document.getElementById('heading');
+ element.innerHTML = 'Heading: ' + heading.magneticHeading;
+ };
+
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
+ };
+
+ var options = {
+ frequency: 3000
+ }; // Update every 3 seconds
+
+ var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Compass Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // The watch id references the current `watchHeading`
+ var watchID = null;
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ startWatch();
+ }
+
+ // Start watching the compass
+ //
+ function startWatch() {
+
+ // Update compass every 3 seconds
+ var options = { frequency: 3000 };
+
+ watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+ }
+
+ // Stop watching the compass
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.compass.clearWatch(watchID);
+ watchID = null;
+ }
+ }
+
+ // onSuccess: Get the current heading
+ //
+ function onSuccess(heading) {
+ var element = document.getElementById('heading');
+ element.innerHTML = 'Heading: ' + heading.magneticHeading;
+ }
+
+ // onError: Failed to get the heading
+ //
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <div id="heading">Waiting for heading...</div>
+ <button onclick="startWatch();">Start Watching</button>
+ <button onclick="stopWatch();">Stop Watching</button>
+ </body>
+ </html>
+
+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 executes. Specify the degrees of
+change via the `filter` parameter in the `compassOptions` object.
+Clear the watch as usual by passing the returned watch ID to
+`compass.clearWatch`. This functionality replaces the previously
+separate, iOS-only `watchHeadingFilter` and `clearWatchFilter`
+functions, which were removed in version 1.6.
+
+Only one `watchHeading` can be in effect at one time in iOS. If a
+`watchHeading` uses a filter, calling `getCurrentHeading` or
+`watchHeading` uses the existing filter value to specify heading
+changes. Watching heading changes with a filter is more efficient than
+with time intervals.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/compass/compass.watchHeadingFilter.md b/docs/en/3.0.0rc1/cordova/compass/compass.watchHeadingFilter.md
new file mode 100644
index 0000000..f64c2c7
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/compass/compass.watchHeadingFilter.md
@@ -0,0 +1,23 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+compass.watchHeadingFilter
+==========================
+
+No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/compass/compassError/compassError.md b/docs/en/3.0.0rc1/cordova/compass/compassError/compassError.md
new file mode 100644
index 0000000..7f320f2
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/compass/compassError/compassError.md
@@ -0,0 +1,39 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+CompassError
+==========
+
+A `CompassError` object is returned to the `compassError` callback function when an error occurs.
+
+Properties
+----------
+
+- __code__: One of the predefined error codes listed below.
+
+Constants
+---------
+- `CompassError.COMPASS_INTERNAL_ERR`
+- `CompassError.COMPASS_NOT_SUPPORTED`
+
+Description
+-----------
+
+When an error occurs, the `CompassError` object is passed as a
+parameter to a `compassError` callback function.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/compass/parameters/compassError.md b/docs/en/3.0.0rc1/cordova/compass/parameters/compassError.md
new file mode 100755
index 0000000..7a8fe49
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/compass/parameters/compassError.md
@@ -0,0 +1,30 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+compassError
+==========
+
+onError callback function for compass functions.
+
+Example
+-------
+
+ function(CompassError) {
+ // Handle the error
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/compass/parameters/compassHeading.md b/docs/en/3.0.0rc1/cordova/compass/parameters/compassHeading.md
new file mode 100644
index 0000000..d1064fb
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/compass/parameters/compassHeading.md
@@ -0,0 +1,47 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+compassHeading
+==========
+
+A `CompassHeading` object is returned to the `compassSuccess` callback function.
+
+Properties
+----------
+
+- __magneticHeading__: The heading in degrees from 0 - 359.99 at a single moment in time. _(Number)_
+- __trueHeading__: The heading relative to the geographic North Pole in degrees 0 - 359.99 at a single moment in time. A negative value indicates that the true heading cannot be determined. _(Number)_
+- __headingAccuracy__: The deviation in degrees between the reported heading and the true heading. _(Number)_
+- __timestamp__: The time at which this heading was determined. _(milliseconds)_
+
+Description
+-----------
+
+The `CompassHeading` object is returned to the `compassSuccess` callback function.
+
+Android Quirks
+--------------
+- `trueHeading` is not supported, but reports the same value as `magneticHeading`
+- `headingAccuracy` is always 0 because there is no difference between the `magneticHeading` and `trueHeading`.
+
+iOS Quirks
+----------
+
+- `trueHeading` is only returned when location services are enabled via `navigator.geolocation.watchLocation()`
+- For iOS 4 devices and above, heading factors in the device's current orientation, not in reference to its absolute position, for apps that supports that orientation.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/compass/parameters/compassOptions.md b/docs/en/3.0.0rc1/cordova/compass/parameters/compassOptions.md
new file mode 100755
index 0000000..aed37ca
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/compass/parameters/compassOptions.md
@@ -0,0 +1,41 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+compassOptions
+==============
+
+An optional parameter to customize the retrieval of the compass.
+
+Options
+-------
+
+- __frequency__: How often to retrieve the compass heading in milliseconds. _(Number)_ (Default: 100)
+- __filter__: The change in degrees required to initiate a watchHeading success callback. _(Number)_
+
+Android Quirks
+______________
+- `filter` is not supported.
+
+Tizen Quirks
+-----------
+- `filter` is not supported.
+
+Windows Phone 7 and 8 Quirks
+--------------
+- `filter` is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/compass/parameters/compassSuccess.md b/docs/en/3.0.0rc1/cordova/compass/parameters/compassSuccess.md
new file mode 100644
index 0000000..2e56f69
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/compass/parameters/compassSuccess.md
@@ -0,0 +1,39 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+compassSuccess
+==============
+
+onSuccess callback function that provides the compass heading information via a `compassHeading` object.
+
+ function(heading) {
+ // Do something
+ }
+
+Parameters
+----------
+
+- __heading__: The heading information. _(compassHeading)_
+
+Example
+-------
+
+ function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+ };
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/connection/connection.md b/docs/en/3.0.0rc1/cordova/connection/connection.md
new file mode 100644
index 0000000..8831dcf
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/connection/connection.md
@@ -0,0 +1,85 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Connection
+==========
+
+> The `connection` object, exposed via `navigator.connection`, provides information about the device's cellular and wifi connection.
+
+Properties
+----------
+
+- connection.type
+
+Constants
+---------
+
+- Connection.UNKNOWN
+- Connection.ETHERNET
+- Connection.WIFI
+- Connection.CELL_2G
+- Connection.CELL_3G
+- Connection.CELL_4G
+- Connection.CELL
+- Connection.NONE
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="NetworkStatus" value="org.apache.cordova.NetworkManager" />
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.INTERNET" />
+ <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+ <uses-permission android:name="android.permission.READ_PHONE_STATE" />
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Network Status" value="org.apache.cordova.network.Network" />
+
+### iOS
+
+#### config.xml
+
+ <plugin name="NetworkStatus" value="CDVConnection" />
+
+### Windows Phone
+
+#### Properties/WPAppManifest.xml
+
+ <Capabilities>
+ <Capability Name="ID_CAP_NETWORKING" />
+ </Capabilities>
+
+Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+
+### Tizen
+
+#### config.xml
+
+ <feature name="http://tizen.org/api/systeminfo" required="true"/>
+
+Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/connection/connection.type.md b/docs/en/3.0.0rc1/cordova/connection/connection.type.md
new file mode 100644
index 0000000..4caefb2
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/connection/connection.type.md
@@ -0,0 +1,132 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+connection.type
+===================
+
+Checks the currently active network connection.
+
+Description
+-----------
+
+This property offers a fast way to determine the device's network
+connection state, and type of connection.
+
+Supported Platforms
+-------------------
+
+- iOS
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ function checkConnection() {
+ var networkState = navigator.connection.type;
+
+ var states = {};
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.CELL] = 'Cell generic connection';
+ states[Connection.NONE] = 'No network connection';
+
+ alert('Connection type: ' + states[networkState]);
+ }
+
+ checkConnection();
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>navigator.connection.type Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ checkConnection();
+ }
+
+ function checkConnection() {
+ var networkState = navigator.connection.type;
+
+ var states = {};
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.CELL] = 'Cell generic connection';
+ states[Connection.NONE] = 'No network connection';
+
+ alert('Connection type: ' + states[networkState]);
+ }
+
+ </script>
+ </head>
+ <body>
+ <p>A dialog box will report the network state.</p>
+ </body>
+ </html>
+
+API Change
+----------
+
+Until Cordova 2.3.0, the `Connection` object was accessed via
+`navigator.network.connection`, after which it was changed to
+`navigator.connection` to match the W3C specification. It's still
+available at its original location, but is deprecated and will
+eventually be removed.
+
+iOS Quirks
+----------
+
+- iOS cannot detect the type of cellular network connection.
+ - `navigator.connection.type` is set to `Connection.CELL` for all cellular data.
+
+Windows Phone Quirks
+--------------------
+
+- When running in the emulator, always detects `navigator.connection.type` as `Connection.UNKNOWN`.
+- Windows Phone cannot detect the type of cellular network connection.
+ - `navigator.connection.type` is set to `Connection.CELL` for all cellular data.
+
+Tizen Quirks
+--------------------
+
+- Tizen can only detect a WiFi or cellular connection.
+ - `navigator.connection.type` is set to `Connection.CELL_2G` for all cellular data.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/Contact/contact.md b/docs/en/3.0.0rc1/cordova/contacts/Contact/contact.md
new file mode 100644
index 0000000..f50e8a6
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/Contact/contact.md
@@ -0,0 +1,232 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Contact
+=======
+
+Contains properties that describe a contact, such as a user's personal or business contact.
+
+Properties
+----------
+
+- __id__: A globally unique identifier. _(DOMString)_
+- __displayName__: The name of this Contact, suitable for display to end-users. _(DOMString)_
+- __name__: An object containing all components of a persons name. _(ContactName)_
+- __nickname__: A casual name by which to address the contact. _(DOMString)_
+- __phoneNumbers__: An array of all the contact's phone numbers. _(ContactField[])_
+- __emails__: An array of all the contact's email addresses. _(ContactField[])_
+- __addresses__: An array of all the contact's addresses. _(ContactAddress[])_
+- __ims__: An array of all the contact's IM addresses. _(ContactField[])_
+- __organizations__: An array of all the contact's organizations. _(ContactOrganization[])_
+- __birthday__: The birthday of the contact. _(Date)_
+- __note__: A note about the contact. _(DOMString)_
+- __photos__: An array of the contact's photos. _(ContactField[])_
+- __categories__: An array of all the user-defined categories associated with the contact. _(ContactField[])_
+- __urls__: An array of web pages associated with the contact. _(ContactField[])_
+
+Methods
+-------
+
+- __clone__: Returns a new `Contact` object that is a deep copy of the calling object, with the `id` property set to `null`.
+- __remove__: Removes the contact from the device contacts database, otherwise executes an error callback with a `ContactError` object.
+- __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists.
+
+Details
+-------
+
+The `Contact` object represents a user's contact. Contacts can be
+created, stored, or removed from the device contacts database.
+Contacts can also be retrieved (individually or in bulk) from the
+database by invoking the `contacts.find` method.
+
+__NOTE:__ Not all of the contact fields listed above are supported on
+every device platform. Please check each platform's _Quirks_ section
+for details.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Save Quick Example
+------------------
+
+ function onSuccess(contact) {
+ alert("Save Success");
+ };
+
+ function onError(contactError) {
+ alert("Error = " + contactError.code);
+ };
+
+ // create a new contact object
+ var contact = navigator.contacts.create();
+ contact.displayName = "Plumber";
+ contact.nickname = "Plumber"; // specify both to support all devices
+
+ // populate some fields
+ var name = new ContactName();
+ name.givenName = "Jane";
+ name.familyName = "Doe";
+ contact.name = name;
+
+ // save to device
+ contact.save(onSuccess,onError);
+
+Clone Quick Example
+-------------------
+
+ // clone the contact object
+ var clone = contact.clone();
+ clone.name.givenName = "John";
+ console.log("Original contact name = " + contact.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
+
+Remove Quick Example
+--------------------
+
+ function onSuccess() {
+ alert("Removal Success");
+ };
+
+ function onError(contactError) {
+ alert("Error = " + contactError.code);
+ };
+
+ // remove the contact from the device
+ contact.remove(onSuccess,onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Contact Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // create
+ var contact = navigator.contacts.create();
+ contact.displayName = "Plumber";
+ contact.nickname = "Plumber"; // specify both to support all devices
+ var name = new ContactName();
+ name.givenName = "Jane";
+ name.familyName = "Doe";
+ contact.name = name;
+
+ // save
+ contact.save(onSaveSuccess,onSaveError);
+
+ // clone
+ var clone = contact.clone();
+ clone.name.givenName = "John";
+ console.log("Original contact name = " + contact.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
+
+ // remove
+ contact.remove(onRemoveSuccess,onRemoveError);
+ }
+
+ // onSaveSuccess: Get a snapshot of the current contacts
+ //
+ function onSaveSuccess(contact) {
+ alert("Save Success");
+ }
+
+ // onSaveError: Failed to get the contacts
+ //
+ function onSaveError(contactError) {
+ alert("Error = " + contactError.code);
+ }
+
+ // onRemoveSuccess: Get a snapshot of the current contacts
+ //
+ function onRemoveSuccess(contacts) {
+ alert("Removal Success");
+ }
+
+ // onRemoveError: Failed to get the contacts
+ //
+ function onRemoveError(contactError) {
+ alert("Error = " + contactError.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
+ </body>
+ </html>
+
+Android 2.X Quirks
+------------------
+
+- __categories__: Not supported on Android 2.X devices, returning `null`.
+
+BlackBerry WebWorks (OS 5.0 and higher) Quirks
+---------------------------------------------
+
+- __id__: Supported. Assigned by the device when saving the contact.
+- __displayName__: Supported. Stored in BlackBerry __user1__ field.
+- __nickname__: Not supported, returning `null`.
+- __phoneNumbers__: Partially supported. Phone numbers are stored in BlackBerry fields __homePhone1__ and __homePhone2__ if _type_ is 'home', __workPhone1__ and __workPhone2__ if _type_ is 'work', __mobilePhone__ if _type_ is 'mobile', __faxPhone__ if _type_ is 'fax', __pagerPhone__ if _type_ is 'pager', and __otherPhone__ if _type_ is none of the above.
+- __emails__: Partially supported. The first three email addresses are stored in the BlackBerry __email1__, __email2__, and __email3__ fields, respectively.
+- __addresses__: Partially supported. The first and second addresses are stored in the BlackBerry __homeAddress__ and __workAddress__ fields, respectively.
+- __ims__: Not supported, returning `null`.
+- __organizations__: Partially supported. The __name__ and __title__ of the first organization are stored in the BlackBerry __company__ and __title__ fields, respectively.
+- __photos__: Partially supported. A single thumbnail-sized photo is supported. To set a contact's photo, pass in a either a base64-encoded image, or a URL pointing to the image. The image is scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a base64-encoded image.
+- __categories__: Partially supported. Only _Business_ and _Personal_ categories are supported.
+- __urls__: Partially supported. The first URL is stored in BlackBerry __webpage__ field.
+
+iOS Quirks
+----------
+
+- __displayName__: Not supported on iOS, returning `null` unless there is no `ContactName` specified, in which case it returns the composite name, __nickname__ or `""`, respectively.
+- __birthday__: Must be input as a JavaScript `Date` object, the same way it is returned.
+- __photos__: Returns a File URL to the image, which is stored in the application's temporary directory. Contents of the temporary directory are removed when the application exits.
+- __categories__: This property is currently not supported, returning `null`.
+
+Windows Phone 7 and 8 Quirks
+-----------
+
+- __displayName__: When creating a contact, the value provided for the display name parameter differs from the display name retrieved when finding the contact.
+- __urls__: When creating a contact, users can input and save more than one web address, but only one is available is available when searching the contact.
+- __phoneNumbers__: The _pref_ option is not supported. The _type_ is not supported in a _find_ operation. Only one `phoneNumber` is allowed for each _type_.
+- __emails__: The _pref_ option is not supported. Home and personal references same email entry. Only one entry is allowed for each _type_.
+- __addresses__: Supports only work, and home/personal _type_. The home and personal _type_ reference the same address entry. Only one entry is allowed for each _type_.
+- __organizations__: Only one is allowed, and does not support the _pref_, _type_, and _department_ attributes.
+- __note__: Not supported, returning `null`.
+- __ims__: Not supported, returning `null`.
+- __birthdays__: Not supported, returning `null`.
+- __categories__: Not supported, returning `null`.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/ContactAddress/contactaddress.md b/docs/en/3.0.0rc1/cordova/contacts/ContactAddress/contactaddress.md
new file mode 100644
index 0000000..c3502bf
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/ContactAddress/contactaddress.md
@@ -0,0 +1,160 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+ContactAddress
+==============
+
+Contains address properties for a `Contact` object.
+
+Properties
+----------
+
+- __pref__: Set to `true` if this `ContactAddress` contains the user's preferred value. _(boolean)_
+- __type__: A string indicating what type of field this is, _home_ for example. _(DOMString)_
+- __formatted__: The full address formatted for display. _(DOMString)_
+- __streetAddress__: The full street address. _(DOMString)_
+- __locality__: The city or locality. _(DOMString)_
+- __region__: The state or region. _(DOMString)_
+- __postalCode__: The zip code or postal code. _(DOMString)_
+- __country__: The country name. _(DOMString)_
+
+Details
+-------
+
+The `ContactAddress` object stores the properties of a single address
+of a contact. A `Contact` object may include more than one address in
+a `ContactAddress[]` array.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // display the address information for all contacts
+
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ for (var j = 0; j < contacts[i].addresses.length; j++) {
+ alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
+ "Type: " + contacts[i].addresses[j].type + "\n" +
+ "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
+ "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
+ "Locality: " + contacts[i].addresses[j].locality + "\n" +
+ "Region: " + contacts[i].addresses[j].region + "\n" +
+ "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
+ "Country: " + contacts[i].addresses[j].country);
+ }
+ }
+ };
+
+ function onError(contactError) {
+ alert('onError!');
+ };
+
+ // find all contacts
+ var options = new ContactFindOptions();
+ options.filter = "";
+ var filter = ["displayName", "addresses"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Contact Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // find all contacts
+ var options = new ContactFindOptions();
+ options.filter = "";
+ var filter = ["displayName", "addresses"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+ //
+ function onSuccess(contacts) {
+ // display the address information for all contacts
+ for (var i = 0; i < contacts.length; i++) {
+ for (var j = 0; j < contacts[i].addresses.length; j++) {
+ alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
+ "Type: " + contacts[i].addresses[j].type + "\n" +
+ "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
+ "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
+ "Locality: " + contacts[i].addresses[j].locality + "\n" +
+ "Region: " + contacts[i].addresses[j].region + "\n" +
+ "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
+ "Country: " + contacts[i].addresses[j].country);
+ }
+ }
+ };
+
+ // onError: Failed to get the contacts
+ //
+ function onError(contactError) {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
+ </body>
+ </html>
+
+Android 2.X Quirks
+------------------
+
+- __pref__: Not supported, returning `false` on Android 2.X devices.
+
+BlackBerry WebWorks (OS 5.0 and higher) Quirks
+--------------------------------------------
+- __pref__: Not supported on BlackBerry devices, returning `false`.
+- __type__: Partially supported. Only one each of _Work_ and _Home_ type addresses can be stored per contact.
+- __formatted__: Partially supported. Returns a concatenation of all BlackBerry address fields.
+- __streetAddress__: Supported. Returns a concatenation of BlackBerry __address1__ and __address2__ address fields.
+- __locality__: Supported. Stored in BlackBerry __city__ address field.
+- __region__: Supported. Stored in BlackBerry __stateProvince__ address field.
+- __postalCode__: Supported. Stored in BlackBerry __zipPostal__ address field.
+- __country__: Supported.
+
+iOS Quirks
+----------
+- __pref__: Not supported on iOS devices, returning `false`.
+- __formatted__: Currently not supported.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/ContactError/contactError.md b/docs/en/3.0.0rc1/cordova/contacts/ContactError/contactError.md
new file mode 100644
index 0000000..8f17362
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/ContactError/contactError.md
@@ -0,0 +1,46 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+ContactError
+========
+
+A `ContactError` object is passed to the `contactError` callback when an error occurs.
+
+Properties
+----------
+
+- __code__: One of the predefined error codes listed below.
+
+Constants
+---------
+
+- `ContactError.UNKNOWN_ERROR`
+- `ContactError.INVALID_ARGUMENT_ERROR`
+- `ContactError.TIMEOUT_ERROR`
+- `ContactError.PENDING_OPERATION_ERROR`
+- `ContactError.IO_ERROR`
+- `ContactError.NOT_SUPPORTED_ERROR`
+- `ContactError.PERMISSION_DENIED_ERROR`
+
+Description
+-----------
+
+The `ContactError` object is returned to the user through the
+`contactError` callback function when an error occurs.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/ContactField/contactfield.md b/docs/en/3.0.0rc1/cordova/contacts/ContactField/contactfield.md
new file mode 100644
index 0000000..175429f
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/ContactField/contactfield.md
@@ -0,0 +1,159 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+ContactField
+============
+
+Supports generic fields in a `Contact` object. Some properties stored
+as `ContactField` objects include email addresses, phone numbers, and
+URLs.
+
+Properties
+----------
+
+- __type__: A string that indicates what type of field this is, _home_ for example. _(DOMString)_
+- __value__: The value of the field, such as a phone number or email address. _(DOMString)_
+- __pref__: Set to `true` if this `ContactField` contains the user's preferred value. _(boolean)_
+
+Details
+-------
+
+The `ContactField` object is a reusable component that represents
+contact fields generically. Each `ContactField` object contains a
+`value`, `type`, and `pref` property. A `Contact` object stores
+several properties in `ContactField[]` arrays, such as phone numbers
+and email addresses.
+
+In most instances, there are no pre-determined values for a
+`ContactField` object's __type__ attribute. For example, a phone
+number can specify __type__ values of _home_, _work_, _mobile_,
+_iPhone_, or any other value that is supported by a particular device
+platform's contact database. However, for the `Contact` __photos__
+field, the __type__ field indicates the format of the returned image:
+__url__ when the __value__ attribute contains a URL to the photo
+image, or _base64_ when the __value__ contains a base64-encoded image
+string.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // create a new contact
+ var contact = navigator.contacts.create();
+
+ // store contact phone numbers in ContactField[]
+ var phoneNumbers = [];
+ phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
+ phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
+ contact.phoneNumbers = phoneNumbers;
+
+ // save the contact
+ contact.save();
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Contact Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+
+ function onDeviceReady() {
+ // create a new contact
+ var contact = navigator.contacts.create();
+
+ // store contact phone numbers in ContactField[]
+ var phoneNumbers = [];
+ phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
+ phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
+ contact.phoneNumbers = phoneNumbers;
+
+ // save the contact
+ contact.save();
+
+ // search contacts, returning display name and phone numbers
+ var options = new ContactFindOptions();
+ options.filter = "";
+ filter = ["displayName", "phoneNumbers"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+ //
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ // display phone numbers
+ for (var j = 0; j < contacts[i].phoneNumbers.length; j++) {
+ alert("Type: " + contacts[i].phoneNumbers[j].type + "\n" +
+ "Value: " + contacts[i].phoneNumbers[j].value + "\n" +
+ "Preferred: " + contacts[i].phoneNumbers[j].pref);
+ }
+ }
+ };
+
+ // onError: Failed to get the contacts
+ //
+ function onError(contactError) {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
+ </body>
+ </html>
+
+Android Quirks
+--------------
+
+- __pref__: Not supported, returning `false`.
+
+BlackBerry WebWorks (OS 5.0 and higher) Quirks
+--------------------------------------------
+
+- __type__: Partially supported. Used for phone numbers.
+- __value__: Supported.
+- __pref__: Not supported, returning `false`.
+
+iOS Quirks
+-----------
+- __pref__: Not supported, returning `false`.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/3.0.0rc1/cordova/contacts/ContactFindOptions/contactfindoptions.md
new file mode 100644
index 0000000..b002626
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -0,0 +1,113 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+ContactFindOptions
+==================
+
+Contains properties that can be used to filter the results of a `contacts.find` operation.
+
+Properties
+----------
+
+- __filter__: The search string used to find contacts. _(DOMString)_ (Default: `""`)
+- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: false)
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // success callback
+ function onSuccess(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ alert(contacts[i].displayName);
+ }
+ };
+
+ // error callback
+ function onError(contactError) {
+ alert('onError!');
+ };
+
+ // specify contact search criteria
+ var options = new ContactFindOptions();
+ options.filter=""; // empty search string returns all contacts
+ options.multiple=true; // return multiple results
+ filter = ["displayName"]; // return contact.displayName field
+
+ // find contacts
+ navigator.contacts.find(filter, onSuccess, onError, options);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Contact Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // specify contact search criteria
+ var options = new ContactFindOptions();
+ options.filter = ""; // empty search string returns all contacts
+ options.multiple = true; // return multiple results
+ filter = ["displayName"]; // return contact.displayName field
+
+ // find contacts
+ navigator.contacts.find(filter, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+ //
+ function onSuccess(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ alert(contacts[i].displayName);
+ }
+ };
+
+ // onError: Failed to get the contacts
+ //
+ function onError(contactError) {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/ContactName/contactname.md b/docs/en/3.0.0rc1/cordova/contacts/ContactName/contactname.md
new file mode 100644
index 0000000..8876201
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/ContactName/contactname.md
@@ -0,0 +1,142 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+ContactName
+===========
+
+Contains different kinds of information about a `Contact` object's name.
+
+Properties
+----------
+
+- __formatted__: The complete name of the contact. _(DOMString)_
+- __familyName__: The contact's family name. _(DOMString)_
+- __givenName__: The contact's given name. _(DOMString)_
+- __middleName__: The contact's middle name. _(DOMString)_
+- __honorificPrefix__: The contact's prefix (example _Mr._ or _Dr._) _(DOMString)_
+- __honorificSuffix__: The contact's suffix (example _Esq._). _(DOMString)_
+
+Details
+-------
+
+The `ContactName` object stores a contact's name properties.
+
+Supported Platforms
+-------------------
+
+- Android 2.X
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ alert("Formatted: " + contacts[i].name.formatted + "\n" +
+ "Family Name: " + contacts[i].name.familyName + "\n" +
+ "Given Name: " + contacts[i].name.givenName + "\n" +
+ "Middle Name: " + contacts[i].name.middleName + "\n" +
+ "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
+ "Prefix: " + contacts[i].name.honorificSuffix);
+ }
+ };
+
+ function onError(contactError) {
+ alert('onError!');
+ };
+
+ var options = new ContactFindOptions();
+ options.filter = "";
+ filter = ["displayName", "name"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Contact Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var options = new ContactFindOptions();
+ options.filter="";
+ filter = ["displayName","name"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+ //
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i ++) {
+ alert("Formatted: " + contacts[i].name.formatted + "\n" +
+ "Family Name: " + contacts[i].name.familyName + "\n" +
+ "Given Name: " + contacts[i].name.givenName + "\n" +
+ "Middle Name: " + contacts[i].name.middleName + "\n" +
+ "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
+ "Prefix: " + contacts[i].name.honorificPrefix);
+ }
+ };
+
+ // onError: Failed to get the contacts
+ //
+ function onError(contactError) {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
+ </body>
+ </html>
+
+Android Quirks
+------------
+
+- __formatted__: Partially supported, and read-only. Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
+
+BlackBerry WebWorks (OS 5.0 and higher) Quirks
+---------------------------------------------
+
+- __formatted__: Partially supported. Returns a concatenation of BlackBerry __firstName__ and __lastName__ fields.
+- __familyName__: Supported. Stored in BlackBerry __lastName__ field.
+- __givenName__: Supported. Stored in BlackBerry __firstName__ field.
+- __middleName__: Not supported, returning `null`.
+- __honorificPrefix__: Not supported, returning `null`.
+- __honorificSuffix__: Not supported, returning `null`.
+
+iOS Quirks
+------------
+
+- __formatted__: Partially supported. Returns iOS Composite Name, but is read-only.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/ContactOrganization/contactorganization.md b/docs/en/3.0.0rc1/cordova/contacts/ContactOrganization/contactorganization.md
new file mode 100644
index 0000000..bc3dd44
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/ContactOrganization/contactorganization.md
@@ -0,0 +1,147 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+ContactOrganization
+===================
+
+Contains a `Contact` object's organization properties.
+
+Properties
+----------
+
+- __pref__: Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_
+- __type__: A string that indicates what type of field this is, _home_ for example. _(DOMString)
+- __name__: The name of the organization. _(DOMString)_
+- __department__: The department the contract works for. _(DOMString)_
+- __title__: The contact's title at the organization. _(DOMString)_
+
+Details
+-------
+
+The `ContactOrganization` object stores a contact's organization
+properties. A `Contact` object stores one or more
+`ContactOrganization` objects in an array.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ for (var j = 0; j < contacts[i].organizations.length; j++) {
+ alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
+ "Type: " + contacts[i].organizations[j].type + "\n" +
+ "Name: " + contacts[i].organizations[j].name + "\n" +
+ "Department: " + contacts[i].organizations[j].department + "\n" +
+ "Title: " + contacts[i].organizations[j].title);
+ }
+ }
+ };
+
+ function onError(contactError) {
+ alert('onError!');
+ };
+
+ var options = new ContactFindOptions();
+ options.filter = "";
+ filter = ["displayName", "organizations"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Contact Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var options = new ContactFindOptions();
+ options.filter="";
+ filter = ["displayName","organizations"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+ //
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ for (var j = 0; j < contacts[i].organizations.length; j++) {
+ alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
+ "Type: " + contacts[i].organizations[j].type + "\n" +
+ "Name: " + contacts[i].organizations[j].name + "\n" +
+ "Department: " + contacts[i].organizations[j].department + "\n" +
+ "Title: " + contacts[i].organizations[j].title);
+ }
+ }
+ };
+
+ // onError: Failed to get the contacts
+ //
+ function onError(contactError) {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
+ </body>
+ </html>
+
+
+Android 2.X Quirks
+------------------
+
+- __pref__: Not supported by Android 2.X devices, returning `false`.
+
+BlackBerry WebWorks (OS 5.0 and higher) Quirks
+--------------------------------------------
+- __pref__: Not supported by BlackBerry devices, returning `false`.
+- __type__: Not supported by BlackBerry devices, returning `null`.
+- __name__: Partially supported. The first organization name is stored in the BlackBerry __company__ field.
+- __department__: Not supported, returning `null`.
+- __title__: Partially supported. The first organization title is stored in the BlackBerry __jobTitle__ field.
+
+iOS Quirks
+-----------
+- __pref__: Not supported on iOS devices, returning `false`.
+- __type__: Not supported on iOS devices, returning `null`.
+- __name__: Partially supported. The first organization name is stored in the iOS __kABPersonOrganizationProperty__ field.
+- __department__: Partially supported. The first department name is stored in the iOS __kABPersonDepartmentProperty__ field.
+- __title__: Partially supported. The first title is stored in the iOS __kABPersonJobTitleProperty__ field.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/contacts.create.md b/docs/en/3.0.0rc1/cordova/contacts/contacts.create.md
new file mode 100644
index 0000000..b4c9aac
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/contacts.create.md
@@ -0,0 +1,78 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+contacts.create
+===============
+
+Returns a new Contact object.
+
+ var contact = navigator.contacts.create(properties);
+
+Description
+-----------
+
+The `contacts.create` method is synchronous, and returns a new `Contact` object.
+
+This method does not retain the Contact object in the device contacts
+database, for which you need to invoke the `Contact.save` method.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+
+Quick Example
+-------------
+
+ var myContact = navigator.contacts.create({"displayName": "Test User"});
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Contact Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var myContact = navigator.contacts.create({"displayName": "Test User"});
+ myContact.note = "This contact has a note.";
+ console.log("The contact, " + myContact.displayName + ", note: " + myContact.note);
+ }
+
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>Create Contact</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/contacts.find.md b/docs/en/3.0.0rc1/cordova/contacts/contacts.find.md
new file mode 100644
index 0000000..074fe84
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/contacts.find.md
@@ -0,0 +1,127 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+contacts.find
+=============
+
+Queries the device contacts database and returns one or more `Contact`
+objects, each containing the fields specified.
+
+ navigator.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions);
+
+Description
+-----------
+
+The `contacts.find` method executes asynchronously, querying the
+device contacts database and returning an array of `Contact` objects.
+The resulting objects are passed to the `contactSuccess` callback
+function specified by the __contactSuccess__ parameter.
+
+The __contactFields__ parameter specifies the fields to be used as a
+search qualifier, and only those results are passed to the
+__contactSuccess__ callback function. A zero-length __contactFields__
+parameter is invalid and results in
+`ContactError.INVALID_ARGUMENT_ERROR`. A __contactFields__ value of
+`"*"` returns all contact fields.
+
+The __contactFindOptions.filter__ string can be used as a search
+filter when querying the contacts database. If provided, a
+case-insensitive, partial value match is applied to each field
+specified in the __contactFields__ parameter. If there's a match for
+_any_ of the specified fields, the contact is returned.
+
+Parameters
+----------
+
+- __contactFields__: Contact fields to use as a search qualifier. The resulting `Contact` object only features values for these fields. _(DOMString[])_ [Required]
+- __contactSuccess__: Success callback function invoked with the contacts returned from the database. [Required]
+- __contactError__: Error callback function, invoked when an error occurs. [Optional]
+- __contactFindOptions__: Search options to filter contacts. [Optional]
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ function onSuccess(contacts) {
+ alert('Found ' + contacts.length + ' contacts.');
+ };
+
+ function onError(contactError) {
+ alert('onError!');
+ };
+
+ // find all contacts with 'Bob' in any name field
+ var options = new ContactFindOptions();
+ options.filter = "Bob";
+ options.multiple = true;
+ var fields = ["displayName", "name"];
+ navigator.contacts.find(fields, onSuccess, onError, options);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Contact Example</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+
+ function onDeviceReady() {
+ // find all contacts with 'Bob' in any name field
+ var options = new ContactFindOptions();
+ options.filter = "Bob";
+ var fields = ["displayName", "name"];
+ navigator.contacts.find(fields, onSuccess, onError, options);
+ }
+
+ // onSuccess: Get a snapshot of the current contacts
+
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ console.log("Display Name = " + contacts[i].displayName);
+ }
+ }
+
+ // onError: Failed to get the contacts
+
+ function onError(contactError) {
+ alert('onError!');
+ }
+ </script>
+ </head>
+
+ <body>
+ <h1>Example</h1>
+ <p>Find Contacts</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/contacts.md b/docs/en/3.0.0rc1/cordova/contacts/contacts.md
new file mode 100644
index 0000000..ec50fd7
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/contacts.md
@@ -0,0 +1,94 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Contacts
+========
+
+> The `contacts` object provides access to the device contacts database.
+
+**Important privacy note:** Collection and use of contact data raises important privacy issues. Your app's privacy policy should discuss how the app uses contact data and whether it is shared with any other parties. Contact information is considered sensitive because it reveals the people with whom a person communicates. Therefore, in addition to your app's privacy policy, you should strongly consider providing a just-in-time notice prior to your app accessing or using contact data (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for "OK" and "No Thanks"). Note that some app marketplaces may require your app to provide just-in-time notice and obtain permission from the user prior to accessing contact data. A clear and easy to understand user experience surrounding the use of contact data will help avoid user confusion and perceived misuse o
f contact data. For more information, please see the Privacy Guide.
+
+Methods
+-------
+
+- contacts.create
+- contacts.find
+
+Arguments
+---------
+
+- contactFields
+- contactSuccess
+- contactError
+- contactFindOptions
+
+Objects
+-------
+
+- Contact
+- ContactName
+- ContactField
+- ContactAddress
+- ContactOrganization
+- ContactFindOptions
+- ContactError
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Contacts" value="org.apache.cordova.ContactManager" />
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.GET_ACCOUNTS" />
+ <uses-permission android:name="android.permission.READ_CONTACTS" />
+ <uses-permission android:name="android.permission.WRITE_CONTACTS" />
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Contact" value="org.apache.cordova.pim.Contact" />
+
+#### www/config.xml
+
+ <feature id="blackberry.find" required="true" version="1.0.0.0" />
+ <feature id="blackberry.identity" required="true" version="1.0.0.0" />
+ <feature id="blackberry.pim.Address" required="true" version="1.0.0.0" />
+ <feature id="blackberry.pim.Contact" required="true" version="1.0.0.0" />
+
+### iOS
+
+#### config.xml
+
+ <plugin name="Contacts" value="CDVContacts" />
+
+### Windows Phone
+
+#### Properties/WPAppManifest.xml
+
+ <Capabilities>
+ <Capability Name="ID_CAP_CONTACTS" />
+ </Capabilities>
+
+Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/parameters/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/parameters/contactError.md b/docs/en/3.0.0rc1/cordova/contacts/parameters/contactError.md
new file mode 100644
index 0000000..5c451b1
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/parameters/contactError.md
@@ -0,0 +1,27 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+contactError
+============
+
+Error callback function for contact functions.
+
+ function(error) {
+ // Handle the error
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/parameters/contactFields.md b/docs/en/3.0.0rc1/cordova/contacts/parameters/contactFields.md
new file mode 100644
index 0000000..d3b5988
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/parameters/contactFields.md
@@ -0,0 +1,25 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+contactFields
+=============
+
+Required parameter for the `contacts.find` method, used to specify which fields should be included in the `Contact` objects resulting from a find operation.
+
+ ["name", "phoneNumbers", "emails"]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/parameters/contactFindOptions.md b/docs/en/3.0.0rc1/cordova/contacts/parameters/contactFindOptions.md
new file mode 100644
index 0000000..0b40bcd
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/parameters/contactFindOptions.md
@@ -0,0 +1,35 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+contactFindOptions
+==================
+
+Optional parameter of the `contacts.find` method, used to filter the
+contacts returned from the contacts database.
+
+ {
+ filter: "",
+ multiple: true,
+ };
+
+Options
+-------
+
+- __filter__: The search string used to filter contacts. _(DOMString)_ (Default: `""`)
+- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: `false`)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/contacts/parameters/contactSuccess.md b/docs/en/3.0.0rc1/cordova/contacts/parameters/contactSuccess.md
new file mode 100644
index 0000000..694bb8b
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/contacts/parameters/contactSuccess.md
@@ -0,0 +1,41 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+contactSuccess
+==============
+
+Success callback function that provides the `Contact` array resulting from a `contacts.find` operation.
+
+ function(contacts) {
+ // Do something
+ }
+
+Parameters
+----------
+
+- __contacts__: The contact array resulting from a find operation. _(Contact)_
+
+Example
+-------
+
+ function contactSuccess(contacts) {
+ for (var i=0; i<contacts.length; i++) {
+ console.log("Display Name = " + contacts[i].displayName);
+ }
+ }
[04/12] Version 3.0.0rc1
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/android/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/android/upgrading.md b/docs/en/3.0.0rc1/guide/platforms/android/upgrading.md
new file mode 100644
index 0000000..392b8d8
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/android/upgrading.md
@@ -0,0 +1,244 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Upgrading Android
+
+This guide shows how to modify Android projects to upgrade from older versions of Cordova.
+Most of these instructions apply to projects created with an older set
+of command-line tools that precede the `cordova` CLI utility. See The
+Cordova Command-line Interface for information how to update the
+version of the CLI.
+
+## Upgrade to 2.9.0 from 2.8.0
+1. Run `bin/update <project_path>`
+
+## Upgrade to 2.8.0 from 2.7.0 ##
+1. Remove `cordova-2.7.0.jar` from the project's `libs` directory
+2. Add `cordova-2.8.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new cordova.js into your project
+5. Update your HTML to use the new cordova.js file
+6. Copy the `res/xml/config.xml` file to match `framework/res/xml/config.xml`
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+## Upgrade to 2.7.0 from 2.6.0 ##
+1. Remove `cordova-2.6.0.jar` from the project's `libs` directory
+2. Add `cordova-2.7.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-2.7.0.js` into your project
+5. Update your HTML to use the new `cordova-2.7.0.js` file
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+## Upgrade to 2.6.0 from 2.5.0 ##
+1. Remove `cordova-2.5.0.jar` from the project's `libs` directory
+2. Add `cordova-2.6.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-2.6.0.js` into your project
+5. Update your HTML to use the new `cordova-2.6.0.js` file
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+Run `bin/update <project>` with the project path listed in the Cordova Source directory.
+
+## Upgrade to 2.5.0 from 2.4.0 ##
+
+1. Remove `cordova-2.4.0.jar` from the project's `libs` directory
+2. Add `cordova-2.5.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-2.5.0.js` into your project
+5. Update your HTML to use the new `cordova-2.5.0.js` file
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
+7. Update `framework/res/xml/config.xml` to have similar settings as it did previously
+8. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+## Upgrade to 2.4.0 from 2.3.0 ##
+
+1. Remove `cordova-2.3.0.jar` from the project's `libs` directory
+2. Add `cordova-2.4.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-2.4.0.js` into your project
+5. Update your HTML to use the new `cordova-2.4.0.js` file
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+## Upgrade to 2.3.0 from 2.2.0 ##
+
+1. Remove `cordova-2.2.0.jar` from the project's `libs` directory
+2. Add `cordova-2.3.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-2.3.0.js` into your project
+5. Update your HTML to use the new `cordova-2.3.0.js` file
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+## Upgrade to 2.2.0 from 2.1.0 ##
+
+1. Remove `cordova-2.1.0.jar` from the project's `libs` directory
+2. Add `cordova-2.2.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-2.2.0.js` into your project
+5. Update your HTML to use the new `cordova-2.2.0.js` file
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+## Upgrade to 2.1.0 from 2.0.0 ##
+
+1. Remove `cordova-2.0.0.jar` from the project's `libs` directory
+2. Add `cordova-2.1.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-2.1.0.js` into your project
+5. Update your HTML to use the new `cordova-2.1.0.js` file
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
+7. Copy files from `bin/templates/cordova` to the project's `cordova` directory
+
+## Upgrade to 2.0.0 from 1.9.0 ##
+
+1. Remove `cordova-1.9.0.jar` from the project's `libs` directory
+2. Add `cordova-2.0.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-2.0.0.js` into your project
+5. Update your HTML to use the new `cordova-2.0.0.js` file
+6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`
+
+### Notes about 2.0.0 release
+config.xml will be replacing cordova.xml and plugins.xml. This new file is a combination of the previous two. However, the
+old files are deprecated, and while currently still work, will cease working in a future release.
+
+## Upgrade to 1.9.0 from 1.8.1 ##
+
+1. Remove `cordova-1.8.0.jar` from the project's `libs` directory
+2. Add `cordova-1.9.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-1.9.0.js` into your project
+5. Update your HTML to use the new `cordova-1.9.0.js` file
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
+### Notes about 1.9.0 release
+
+- Third-Party plugins may or may not work. This is because of the introduction of the CordovaWebView. These plugins need to get a context from the CordovaInterface using
+getContext() or getActivity(). If you are not an experienced Android developer, please contact the plugin maintainer and add this task to their bug tracker.
+
+## Upgrade to 1.8.0 from 1.8.0 ##
+
+1. Remove `cordova-1.8.0.jar` from the project's `libs` directory
+2. Add `cordova-1.8.1.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-1.8.1.js` into your project
+5. Update your HTML to use the new `cordova-1.8.1.js` file
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
+## Upgrade to 1.8.0 from 1.7.0 ##
+
+1. Remove `cordova-1.7.0.jar` from the project's `libs` directory
+2. Add `cordova-1.8.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-1.8.0.js` into your project
+5. Update your HTML to use the new `cordova-1.8.0.js` file
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
+## Upgrade to 1.8.0 from 1.7.0 ##
+
+1. Remove `cordova-1.7.0.jar` from the project's `libs` directory
+2. Add `cordova-1.8.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-1.8.0.js` into your project
+5. Update your HTML to use the new `cordova-1.8.0.js` file
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
+## Upgrade to 1.7.0 from 1.6.1 ##
+
+1. Remove `cordova-1.6.1.jar` from the project's `libs` directory
+2. Add `cordova-1.7.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-1.7.0.js` into your project
+5. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
+## Upgrade to 1.6.1 from 1.6.0 ##
+
+1. Remove `cordova-1.6.0.jar` from the project's `libs` directory
+2. Add `cordova-1.6.1.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-1.6.1.js` into your project
+5. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
+## Upgrade to 1.6.0 from 1.5.0 ##
+1. Remove `cordova-1.5.0.jar` from the project's `libs` directory
+2. Add `cordova-1.6.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-1.6.0.js` into your project
+5. Update your HTML to use the new `cordova-1.6.0.js` file
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+7. Replace `res/xml/phonegap.xml` with `res/xml/cordova.xml` to match `framework/res/xml/cordova.xml`
+
+## Upgrade to 1.5.0 from 1.4.0##
+1. Remove `phonegap-1.4.0.jar` from the project's `libs` directory
+2. Add `cordova-1.5.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `cordova-1.5.0.js` into your project
+5. Update your HTML to use the new `cordova-1.5.0.js` file
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+7. Replace `res/xml/phonegap.xml` with `res/xml/cordova.xml` to match `framework/res/xml/cordova.xml`
+
+## Upgrade to 1.4.0 from 1.3.0 ##
+1. Remove `phonegap-1.3.0.jar` from the project's `libs` directory
+2. Add `phonegap-1.4.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `phonegap-1.4.0.js` into your project
+5. Update your HTML to use the new `phonegap-1.4.0.js` file
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`
+
+## Upgrade to 1.3.0 from 1.2.0 ##
+1. Remove `phonegap-1.2.0.jar` from the project's `libs` directory
+2. Add `phonegap-1.3.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `phonegap-1.3.0.js` into your project
+5. Update your HTML to use the new `phonegap-1.2.0.js` file
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`
+
+## Upgrade to 1.2.0 from 1.1.0 ##
+1. Remove `phonegap-1.1.0.jar` from the project's `libs` directory
+2. Add `phonegap-1.2.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `phonegap-1.2.0.js` into your project
+5. Update your HTML to use the new `phonegap-1.2.0.js` file
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+7. Update `res/xml/phonegap.xml` to match `framework/res/xml/phonegap.xml`
+
+## Upgrade to 1.1.0 from 1.0.0 ##
+1. Remove `phonegap-1.0.0.jar` from the project's `libs` directory
+2. Add `phonegap-1.1.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `phonegap-1.1.0.js` into your project
+5. Update your HTML to use the new `phonegap-1.1.0.js` file
+6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
+## Upgrade to 1.0.0 from 0.9.6 ##
+1. Remove `phonegap-0.9.6.jar` from the project's `libs` directory
+2. Add `phonegap-1.0.0.jar` to the project's `libs` directory
+3. If you are using Eclipse, please refresh your eclipse project and do a clean
+4. Copy the new `phonegap-1.0.0.js` into your project
+5. Update your HTML to use the new `phonegap-1.0.0.js` file
+6. Add the `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/android/webview.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/android/webview.md b/docs/en/3.0.0rc1/guide/platforms/android/webview.md
new file mode 100644
index 0000000..ebf6b22
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/android/webview.md
@@ -0,0 +1,119 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Android WebViews
+
+Beginning in Cordova 1.9, with the assistance of the
+`CordovaActivity`, you can use Cordova as a component in a larger
+native Android application. Android refers to this component as the
+`CordovaWebView`. New Cordova-based applications from 1.9 onwards use
+the `CordovaWebView` as its main view, regardless of whether the
+legacy `DroidGap` approach is used.
+
+If you're unfamiliar with Android application development, please read
+the Android Platform Guide to developing a Cordova Application before
+attempting to include a WebView. It's not the main way to author
+Android Cordova applications. These instructions are currently manual,
+but may be eventually be automated.
+
+## Prerequisites
+
+1. **Cordova 1.9** or greater
+2. Android SDK updated with 15
+
+## Guide to using CordovaWebView in an Android Project
+
+1. Use `bin/create` to fetch the `commons-codec-1.6.jar` file.
+2. `cd` into `/framework` and run `ant jar` to build the cordova jar. It creates the .jar file formed as `cordova-3.0.0.jar` in the `/framework` folder.
+3. Copy the cordova jar into your Android project's `/libs` directory.
+4. Edit your application's `main.xml` file (under `/res/xml`) to look like the following, with the `layout_height`, `layout_width` and `id` modified to suit your application:
+
+ <org.apache.cordova.CordovaWebView
+ android:id="@+id/tutorialView"
+ android:layout_width="match_parent"
+ android:layout_height="match_parent" />
+
+5. Modify your activity so that it implements the `CordovaInterface`. You should implement the included methods. You may wish to copy them from `/framework/src/org/apache/cordova/DroidGap.java`, or implement them on your own. The code fragment below shows a basic application that uses the interface. Note how the referenced view id matches the `id` attribute specified in the XML fragment shown above:
+
+ public class CordovaViewTestActivity extends Activity implements CordovaInterface {
+ CordovaWebView cwv;
+ /* Called when the activity is first created. */
+ @Override
+ public void onCreate(Bundle savedInstanceState) {
+ super.onCreate(savedInstanceState);
+ setContentView(R.layout.main);
+ cwv = (CordovaWebView) findViewById(R.id.tutorialView);
+ Config.init(this);
+ cwv.loadUrl(Config.getStartUrl());
+ }
+
+ If you use the camera, you should also implement this:
+
+ @Override
+ public void setActivityResultCallback(CordovaPlugin plugin) {
+ this.activityResultCallback = plugin;
+ }
+ /**
+ * Launch an activity for which you would like a result when it finished. When this activity exits,
+ * your onActivityResult() method is called.
+ *
+ * @param command The command object
+ * @param intent The intent to start
+ * @param requestCode The request code that is passed to callback to identify the activity
+ */
+ public void startActivityForResult(CordovaPlugin command, Intent intent, int requestCode) {
+ this.activityResultCallback = command;
+ this.activityResultKeepRunning = this.keepRunning;
+
+ // If multitasking turned on, then disable it for activities that return results
+ if (command != null) {
+ this.keepRunning = false;
+ }
+
+ // Start activity
+ super.startActivityForResult(intent, requestCode);
+ }
+
+ @Override
+ /**
+ * Called when an activity you launched exits, giving you the requestCode you started it with,
+ * the resultCode it returned, and any additional data from it.
+ *
+ * @param requestCode The request code originally supplied to startActivityForResult(),
+ * allowing you to identify who this result came from.
+ * @param resultCode The integer result code returned by the child activity through its setResult().
+ * @param data An Intent, which can return result data to the caller (various data can be attached to Intent "extras").
+ */
+ protected void onActivityResult(int requestCode, int resultCode, Intent intent) {
+ super.onActivityResult(requestCode, resultCode, intent);
+ CordovaPlugin callback = this.activityResultCallback;
+ if (callback != null) {
+ callback.onActivityResult(requestCode, resultCode, intent);
+ }
+ }
+
+ Finally, remember to add the thread pool, otherwise the plugins have no threads to run on:
+
+ @Override
+ public ExecutorService getThreadPool() {
+ return threadPool;
+ }
+
+6. Copy your application's HTML and JavaScript files to your Android project's `/assets/www` directory.
+7. Copy `cordova.xml` and `plugins.xml` from `/framework/res/xml` to your project's `/res/xml` folder.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/blackberry/config.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/blackberry/config.md b/docs/en/3.0.0rc1/guide/platforms/blackberry/config.md
new file mode 100644
index 0000000..399b553
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/blackberry/config.md
@@ -0,0 +1,26 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# BlackBerry Configuration
+
+BlackBerry fully supports the
+[W3C Widget Specification](http://www.w3.org/TR/widgets/)
+as well as proprietary RIM extensions. Please see the full
+[BlackBerry WebWorks documentation regarding config.xml](https://developer.blackberry.com/html5/documentation/working_with_config_xml_file_1866970_11.html)
+for details.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/blackberry/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/blackberry/index.md b/docs/en/3.0.0rc1/guide/platforms/blackberry/index.md
new file mode 100644
index 0000000..07998ee
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/blackberry/index.md
@@ -0,0 +1,212 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# BlackBerry Platform Guide
+
+This guide shows you how to set up an SDK environment to target
+applications for the BlackBerry platform prior to version 10. If you
+want to target the most recent version, see the BlackBerry 10 Platform
+Guide. See the following for more detailed platform-specific
+information:
+
+* BlackBerry Configuration
+* Upgrading BlackBerry
+* BlackBerry Plugins
+* BlackBerry Command-line Tools
+
+The command-line tools above refer to versions prior to Cordova 3.0.
+See The Cordova Command-line Interface for information about the
+current interface.
+
+## Requirements and Support
+
+This version of BlackBerry is not supported by the `cordova` utility
+described in The Command-line Interface, but by a separate set of
+command-line tools. Download the Cordova distribution from
+[cordova.apache.org](http://cordova.apache.org/#download).
+
+Cordova for BlackBerry relies on the [BlackBerry WebWorks
+framework](https://bdsc.webapps.blackberry.com/html5), which is
+available for Windows XP (32-bit), Windows 7 (32-bit and 64-bit), and
+Mac (OS X 10.6.4+). WebWorks applications can _only_ be deployed on
+the following BlackBerry platforms:
+
+* BlackBerry OS 5.0 and higher
+* BlackBerry PlayBook
+* BlackBerry 10 (QNX)
+
+WebWorks requires the Java Development Kit (JDK). For Windows, use the
+32-bit version of
+[Oracle JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html#jdk).
+Java in installed by default on Mac OS X up to version 10.7, which
+requires
+[a separate installation](http://support.apple.com/kb/DL1421).
+It also requires Apache Ant, which on Mac is part of the Java
+installation. The Windows version is available from
+[ant.apache.org](http://ant.apache.org/bindownload.cgi).
+
+## Install the SDK
+
+Download and install the appropriate WebWorks SDK for your
+development. BlackBerry PlayBook and BlackBerry Smartphone WebWorks
+SDKs can be downloaded from the following locations.
+
+- [BlackBerry PlayBook SDK] (https://developer.blackberry.com/html5/download/#playbook) and [Adobe Air SDK](http://www.adobe.com/devnet/air/air-sdk-download.html)
+- [BlackBerry Smartphones SDK] (https://developer.blackberry.com/html5/download/#smartphones)
+
+## 3. Register for Signing Keys
+
+If you wish to publish your application on BlackBerry App World, or deploy on an actual device you’ll need to register for a set of free Code Signing Keys.
+
+To register for Signing Keys visit, and complete the [BlackBerry Keys Order Form](https://www.blackberry.com/SignedKeys).
+
+Once you receive your Signing Keys, they'll need to be setup. To learn how to setup your Signing Keys visit the [BlackBerry HTML5/WebWorks website](https://developer.blackberry.com/html5/documentation/signing_setup_bb10_apps_2008396_11.html).
+
+## 4. Install Cordova
+
+Download and extract the latest copy of [Cordova](http://cordova.apache.org/#download).
+
+## 5. Set up New Project
+
+- Open up a command-line terminal and navigate to where you extracted Cordova.
+- There is a directory for each platform that Cordova supports. CD into the `blackberry` directory.
+- The blackberry directory contains several directories. The `example` folder contains a complete Cordova project. Copy the `example` folder to another location on your computer.
+- Change to the newly created directory.
+- Open up the project.properties file with your favorite editor and edit the entries for the WebWorks SDKs you are using. For example...
+
+BlackBerry 10 (QNX)
+- `qnx.bbwp.dir=C:\\Program Files (x86)\\Research In Motion\\BlackBerry 10 WebWorks SDK 1.0.2.9`
+
+Along with the SDK, you also need to register for a code signing key
+and debug token. The signing key allows you to distribute apps through
+BlackBerry World. The debug token allows you to test unsigned apps on
+a BlackBerry emulator or device. You do not need to create and
+install the debug token yourself; if you supply the keystore password,
+the build script creates and installs the debug token for you. To set
+up the signing key, go to the Blackberry website to obtain it, making
+sure to retain the password you specify. Then run the
+`blackberry-signer` utility that is included with the SDK. Consult the
+following for more information:
+
+* [Register for your code signing key](https://www.blackberry.com/SignedKeys/codesigning.html)
+
+* [Set up your computer for code signing](http://developer.blackberry.com/html5/documentation/set_up_for_signing.html)
+
+Build the Cordova sample project by typing `./cordova/build <target>` in your command prompt while you are in your project's directory. Replace `<target>` with either `qnx` `playbook` or `blackberry`. For example...
+
+* [Comprehensive guide to setting up your SDK environment](http://developer.blackberry.com/native/documentation/bb10/com.qnx.doc.native_sdk.quickstart/topic/set_up_your_environment.html)
+
+## Set up a New Project
+
+* Open up a command-line terminal. From the directory where you
+ extracted Cordova, navigate to the `blackberry` subdirectory.
+
+* Copy the `blackberry` directory's `example` subdirectory to another
+ location on your computer and navigate there.
+
+* Edit the `project.properties` file to specify the WebWorks SDK you
+ are using. For example, here are the respective settings for
+ BlackBerry PlayBook or BlackBerry Smartphone (OS5-7):
+
+ playbook.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks SDK for TabletOS 2.1.0.6\\bbwp
+ blackberry.bbwp.dir=C:\\Program Files\\Research In Motion\\BlackBerry WebWorks Packager
+
+These correspond to parameters you specify when building your project.
+The first time you run these commands, they generate a "Hello World"
+application:
+
+ cordova/build playbook
+ cordova/build blackberry
+
+## Deploy to Emulator
+
+BlackBerry smartphone emulators are only available on Windows.
+BlackBerry PlayBook emulators require VMWare Player (Windows) or
+VMWare Fusion (Mac OS X). The WebWorks SDK provides a default
+emulator, but additional emulators are [available through
+BlackBerry](http://us.blackberry.com/developers/resources/simulators.jsp).
+
+While in your project directory, in command prompt type `./cordova/run <target>`. Replace `<target>` with either `qnx`, `playbook`, or `blackberry`. Note, for BlackBerry 10 and PlayBook, the emulator virtual image must already be started. For example...
+
+* [BlackBerry PlayBook](https://developer.blackberry.com/html5/documentation/using_the_tablet_simulator_1866980_11.html)
+
+* [BlackBerry Smartphone](https://developer.blackberry.com/html5/documentation/run_your_app_on_smartphone_sim_1876976_11.html)
+
+For BlackBerry Playbook, edit the `project.properties` file to
+customize the `playbook.sim.ip` and `playbook.sim.password`
+properties. The emulator's IP address is available through the
+__Settings__ application on the home screen. Enable the __Security and
+Privacy → Development Mode__ option to display the address. The
+password can also be set in the __Security and Privacy__ tab.
+
+For BlackBerry Smartphone, edit the `project.properties` file to
+customize the `blackberry.sim.dir` and `blackberry.sim.bin`
+properties. You need to escape path delimiters when specifying
+directory paths on Windows, for example: `C:\\Program
+Files\\BlackBerry\\Simulator`.
+
+Once the emulator is installed and running, run either of the
+following to install an application to the home screen:
+
+ cordova/run playbook
+ cordova/run blackberry
+
+If you are prompted whether a device is connected to your computer,
+answer no.
+
+__NOTE:__ On BlackBerry OS 5, the application is installed in the
+`Downloads` folder.
+
+## Deploy to Device
+
+To deploy your app to a device, it must be connected, and you must be
+registered for code signing keys as described above. Also, to deploy
+apps on BlackBerry PlayBook, the __Settings → Security →
+Development Mode__ option must be enabled.
+
+On Blackberry PlayBook, edit the `project.properties` file and modify
+the following to reflect the device's IP and password as descibed
+above, along with the signing key password you set up:
+
+While in your project directory, in command prompt type `./cordova/run <target>`. Replace `<target>` with either `qnx`, `playbook`, or `blackberry`. For example...
+
+On BlackBerry Smartphone (OS5-7), specify the
+`blackberry.sigtool.password` property as the signing key password.
+
+Then from the project's directory, run either of the commands you
+would to view the app in an emulator:
+
+ cordova/run playbook
+ cordova/run blackberry
+
+If you are prompted whether a device is connected to your computer,
+answer yes.
+
+__NOTE:__ On BlackBerry OS 5, the application is installed in the
+`Downloads` folder.
+
+## Additional Information
+
+The following articles may help resolve common problems when
+developing applications built for the BlackBerry WebWorks framework:
+
+* [BlackBerry WebWorks Development Pitfalls](http://supportforums.blackberry.com/t5/Web-and-WebWorks-Development/Common-BlackBerry-WebWorks-development-pitfalls-that-can-be/ta-p/624712)
+
+* [Best practices for packaging WebWorks applications](https://bdsc.webapps.blackberrycom/html5/documentation/ww_developing/bestpractice_compiling_ww_apps_1873324_11.html)
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/blackberry/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/blackberry/plugin.md b/docs/en/3.0.0rc1/guide/platforms/blackberry/plugin.md
new file mode 100644
index 0000000..56ba5ac
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/blackberry/plugin.md
@@ -0,0 +1,146 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# BlackBerry Plugins
+
+This guide shows how to develop an Echo plugin on BlackBerry. The
+Plugin Development Guide provides a broad overview with which you
+should already be familiar, and this guide picks up where it leaves
+off. In addition, download the [Cordova BlackBerry
+repository](https://git-wip-us.apache.org/repos/asf?p=cordova-blackberry-webworks.git;a=summary).
+
+The `Cordova-BlackBerry` project allows you to deploy to BlackBerry
+devices such as the Torch, Bold, and Playbook. The Playbook uses a
+different code base than other BlackBerry handheld devices, for which
+you need to duplicate your development efforts. This guide focuses on
+the handheld devices rather than tablets. (In the future, this guide
+should cover both platforms.)
+
+The Echo plugin essentially returns whatever message a user provides
+to the `window.echo` function:
+
+ window.echo = function(str, callback) {
+ cordova.exec(callback, function(err) {
+ callback('Nothing to echo.');
+ }, "Echo", "echo", [str]);
+ };
+
+## Modifying plugins.xml
+
+Your project's `www/plugins.xml` folder contains all of the necessary
+references to your Cordova project's plugins. Add an
+additional reference so that when `cordova.exec` is called, Cordova
+knows how to map the `Echo` argument of `cordova.exec` to the `Echo`
+class that we want to write natively:
+
+ <plugins>
+ ...
+ <plugin name="Echo" value="org.apache.cordova.echo.Echo"/>
+ ...
+ </plugins>
+
+## Adding Echo.java
+
+If you notice the structure of the value attribute, you'll see a
+defined path that leads to the Echo plugin. In the root folder of the
+Cordova BlackBerry WebWorks repo, look for a folder called framework.
+This folder contains all of the source code that runs natively on the
+BlackBerry. Navigate to `framework/ext/src/org/apache/cordova`. At
+this point, you'll see all of the plugin folders, inside of which is
+the source code. So add the folder echo to
+`framework/ext/src/org/apache/cordova/echo` and create a file called
+`Echo.java` at `framework/ext/src/org/apache/cordova/echo/Echo.java`.
+
+## Writing Echo.java
+
+The basic idea behind writing a plugin is to create a class that
+extends the Plugin class and have a method called `execute` to return
+a `PluginResult` class. Any call to `cordova.exec` passes in the
+action to execute within the class, as well as the arguments. In this
+case, "echo" is the action we want to execute within the class "Echo"
+and [str] are the arguments we are passing in.
+
+ package org.apache.cordova.echo;
+
+ import org.apache.cordova.api.Plugin;
+ import org.apache.cordova.api.PluginResult;
+ import org.apache.cordova.json4j.JSONArray;
+ import org.apache.cordova.json4j.JSONException;
+ import org.apache.cordova.json4j.JSONObject;
+ /**
+ * A simple plugin to demonstrate how to build a plugin for BlackBerry
+ * Basically echos back the msg that a user calls to this plugin
+ */
+ public final class Echo extends Plugin {
+
+ public static final String echo = "echo";
+
+ public PluginResult execute(String action, JSONArray args, String callbackId) {
+ PluginResult result = new PluginResult(PluginResult.Status.INVALID_ACTION, "Echo: Invalid action:" + action);
+ if(action.equals(echo)){
+ try {
+ String theMsg = args.getString(0);
+ if(theMsg!= null || theMsg.length()>0){
+ result = new PluginResult(PluginResult.Status.OK, theMsg);
+ }else{
+ result = new PluginResult(PluginResult.Status.ERROR, "Nothing to echo.");
+ }
+ } catch (JSONException e) {
+ result = new PluginResult(PluginResult.Status.JSON_EXCEPTION, e.getMessage());
+ }
+ }
+
+ return result;
+ }
+
+ }
+
+So if we look at the code above, we can see that within the execute
+method, we are first looking for what actions are coming in. The Echo
+plugin has only one action, `echo`, so we will be only checking for
+that. If our plugin had more actions, it's simply a matter of adding
+more conditional tests to check for those actions.
+
+We are then going to grab the message coming in from the arguments
+which is supplied by the args parameter. We can grab the first
+argument by simply doing `String theMsg = args.getString(0);`.
+
+We will do some error checking and if the message looks okay, we will
+instantiate a new PluginResult with an ok status:
+`PluginResult.Status.OK` and return the message: `theMsg`. After this,
+we return the result which to be passed back to JavaScript to be fired
+in the success callback. If something fails, we can return various
+status exceptions like `PluginResult.Status.ERROR`,
+`PluginResult.Status.JSON_EXCEPTION`, or
+`PluginResult.Status.INVALID_ACTION`. When passed back, these types of
+results fire the fail callback in JavaScript.
+
+## Updating the .jar in your project's www folder
+
+The added `Echo.java` needs to be updated in your project. To build
+the `.jar` file, Navigate to the BlackBerry WebWorks repo's root
+directory and run the `ant` command:
+
+ ant update -Dproject.path="~/path_to_my_project"
+
+This builds a new `.jar` file in the `build/ext` directory. Copy the
+`build/ext/cordova.jar` file into your `project/www/ext` directory.
+
+If all goes well, that allows you to use the Echo plugin in
+BlackBerry.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/blackberry/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/blackberry/tools.md b/docs/en/3.0.0rc1/guide/platforms/blackberry/tools.md
new file mode 100644
index 0000000..ee9f3b3
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/blackberry/tools.md
@@ -0,0 +1,84 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# BlackBerry Command-line Tools
+
+The `cordova` command-line utility is a high-level tool that allows
+you to build applications across several platforms at once. An older
+version of the Cordova framework provides sets of command-line tools
+specific to each platform. To use them as an alternative to the CLI,
+you need to download this version of Cordova from
+[cordova.apache.org](http://cordova.apache.org). The download contains
+separate archives for each platform. Expand the platform you wish to
+target. The tools described here are typically available in the
+top-level `bin` directory, otherwise consult the __README__ file for
+more detailed directions.
+
+## Create a project
+
+Run the `create` command, specifying the existing path to the project,
+the reverse-domain-style package identifier, and the app's display
+name. Here is the syntax for both Mac and Windows:
+
+ $ /path/to/cordova-blackberry-webworks/bin/create /path/to/my_new_project com.example.project_name ProjectName
+ $ /path/to/cordova-blackberry-webworks/bin/create.bat /path/to/my_new_project com.example.project_name ProjectName
+
+__NOTE:__ The BlackBerry platform ignores the package name placeholder
+(`com.example.project_name`), but it's still required for use by
+cross-platform tools.
+
+## Build a project
+
+For BlackBerry projects, please make sure you customize the
+`project.properties` file in your Cordova project's root directory.
+You need to do so to supply your BlackBerry signing key password, and
+specify locations for the BlackBerry WebWorks SDK and BlackBerry
+emulator executables.
+
+ $ /path/to/my_new_project/cordova/build <platform>
+ $ /path/to/my_new_project/cordova/build.bat <platform>
+
+## Launch emulator
+
+For BlackBerry projects, please make sure you customize the
+`project.properties` file in the root of your Cordova project folder.
+You need to do so to supply your BlackBerry signing key password, and
+specify locations for the BlackBerry WebWorks SDK and BlackBerry
+emulator executables.
+
+ $ /path/to/my_new_project/cordova/run <platform>
+
+and then choose 'no' when prompted with:
+
+ Do you have a BlackBerry device connected to your computer? (y/n)
+ $ /path/to/my_new_project/cordova/run <platform>
+
+and then choose 'no' when prompted with:
+
+ Do you have a BlackBerry device connected to your computer? (y/n)
+
+## Logging
+
+Unfortunately, streaming logs directly from the device is currently
+unsupported. However, BlackBerry offers built-in Web Inspector support
+for Playbook and BlackBerry smartphone devices running BlackBerry OS
+7.0 and above. You can also access your application's logs (including
+any calls to `console.log`) on your device by holding down the ''ALT''
+key from the home screen and typing ''lglg'' keys.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/blackberry/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/blackberry/upgrading.md b/docs/en/3.0.0rc1/guide/platforms/blackberry/upgrading.md
new file mode 100644
index 0000000..8c17b29
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/blackberry/upgrading.md
@@ -0,0 +1,310 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Upgrading BlackBerry
+
+This guide shows how to modify BlackBerry projects to upgrade from older versions of Cordova.
+Most of these instructions apply to projects created with an older set
+of command-line tools that precede the `cordova` CLI utility. See The
+Cordova Command-line Interface for information how to update the
+version of the CLI.
+
+## Upgrading 2.8.0 projects to 2.9.0 ##
+
+BlackBerry 10:
+
+1. **Download and extract the Cordova 2.9.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.9.0)
+2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
+3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
+4. **Create a new project**, as described in BlackBerry Command-line Tools. This becomes the home of your updated project.
+5. **Copy** your projects source from the old project's /www folder to the new project's /www folder
+6. **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.js** file
+
+### BlackBerryOS/Playbook ###
+
+1. **Download and extract the Cordova 2.9.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.9.0)
+2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
+3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
+4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+5. **Copy** the **www/cordova.js** file from the new project into your **www** folder, and delete your **www/cordova.js** file
+6. **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.js** file
+7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder
+8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder
+9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder
+
+## Upgrading 2.7.0 projects to 2.8.0 ##
+
+BlackBerry 10:
+
+BlackBerry 10 uses the new CLI tooling and manages core APIs as plugins. The instructions migrate your project to a new project, rather than updating an existing project, due to the complexity of updating an old project.
+Also note that the cordova js script file is now called 'cordova.js' and no longer contains a version string.
+
+1. **Download and extract the Cordova 2.8.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.8.0)
+2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
+3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
+4. **Create a new project**, as described in BlackBerry Command-line Tools. This becomes the home of your updated project.
+5. **Copy** your projects source from the old project's /www folder to the new project's /www folder
+6. **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.js** file
+
+BlackBerryOS/Playbook:
+
+1. **Download and extract the Cordova 2.8.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.8.0)
+2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
+3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
+4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+5. **Copy** the **www/cordova.js** file from the new project into your **www** folder, and delete your **www/cordova.js** file
+6. **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.js** file
+7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder
+8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder
+9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder
+
+## Upgrading 2.6.0 projects to 2.7.0 ##
+
+1. **Download and extract the Cordova 2.7.0 source** to a **permanent folder location** on your hard drive (say to ~/Cordova-2.7.0)
+2. **Quit any running SDK tools**: Eclipse, Momentics and the like.
+3. **Navigate** to the directory where you put the downloaded source above, using a unix like terminal: **Terminal.app**, **Bash**, **Cygwin**, etc.
+4. **Create a new project**, as described in BlackBerry Command-line Tools. You need the assets from this new project.
+5. **Copy** the **www/cordova-2.7.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.6.0.js** file
+6. **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-2.7.0.js** file
+7. **Copy** the **native** folder from the new project into the existing project, overwriting the old **native** folder
+8. **Copy** the **lib** folder from the new project into the existing project, overwriting the old **lib** folder
+9. **Copy** the **cordova** folder from the new project into the existing project, overwriting the old **cordova** folder
+
+## Upgrade to 2.6.0 from 2.5.0 ##
+
+Updating the PhoneGap download folder:
+
+It is recommended that you download a fresh copy of the entire folder.
+
+However, here are the new parts needed for the piecemeal update:
+1. Update the cordova.blackberry.js file in the ‘Phonegap-2.6.0/lib/blackberry/javascript’ folder
+2. Update the ‘ext’, ‘ext-air’, and ‘ext-qnx’ in the ‘Phonegap-2.6.0/lib/blackberry/framework’ folder
+3. Update the ‘build.xml’ file in the ‘Phonegap-2.6.0/lib/blackberry’ folder
+4. Update the ‘Phonegap-2.6.0/lib/blackberry/bin’ folder
+5. Update the ‘VERSION’ file in the ‘Phonegap-2.6.0/lib/blackberry’ folder
+
+Updating the example/ folder or migrating an existing project:
+
+1. Open your `www/` folder, which contains your app.
+2. Remove and update the .jar file in the `ext/` folder.
+3. Update the contents of the `ext-air/` folder.
+4. Update the contents of the `ext-qnx/` folder.
+4. Copy the new `cordova-2.6.0.js` into your project.
+5. Update your HTML to use the new `cordova-2.6.0.js` file.
+
+## Upgrade to 2.5.0 from 2.4.0 ##
+
+Updating the PhoneGap download folder:
+
+It is recommended that you download a fresh copy of the entire folder.
+
+However, here are the new parts needed for the piecemeal update:
+1. Update the cordova.blackberry.js file in the ‘Phonegap-2.5.0/lib/blackberry/javascript’ folder
+2. Update the ‘ext’, ‘ext-air’, and ‘ext-qnx’ in the ‘Phonegap-2.5.0/lib/blackberry/framework’ folder
+3. Update the ‘build.xml’ file in the ‘Phonegap-2.5.0/lib/blackberry’ folder
+4. Update the ‘Phonegap-2.5.0/lib/blackberry/bin’ folder
+5. Update the ‘VERSION’ file in the ‘Phonegap-2.5.0/lib/blackberry’ folder
+
+Updating the example/ folder or migrating an existing project:
+
+1. Open your `www/` folder, which contains your app.
+2. Remove and update the .jar file in the `ext/` folder.
+3. Update the contents of the `ext-air/` folder.
+4. Update the contents of the `ext-qnx/` folder.
+4. Copy the new `cordova-2.5.0.js` into your project.
+5. Update your HTML to use the new `cordova-2.5.0.js` file.
+
+## Upgrade to 2.4.0 from 2.3.0 ##
+
+Updating just the `www` folder:
+
+1. Open your `www/` folder, which contains your app.
+2. Remove and update the .jar file in the `ext/` folder.
+3. Update the contents of the `ext-air/` folder.
+4. Copy the new `cordova-2.4.0.js` into your project.
+ - If playbook, then update the .js file in the `playbook/` folder.
+ - If BlackBerry 10, then update the .js file in the `qnx/` folder.
+5. Update your HTML to use the new `cordova-2.4.0.js` file.
+
+Updating the sample folder (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` folder.
+2. Update the .jar file in the `cordova.2.3.0/ext/` folder.
+3. Update the contents of the `cordova.2.3.0/ext-air/` folder.
+4. Update the contents of the `cordova.2.3.0/ext-qnx/` folder.
+5. Update the .js file in the `cordova.2.3.0/javascript/` folder.
+6. Open the `sample/lib/` folder and rename the `cordova.2.3.0/` folder to `cordova.2.4.0/`.
+7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
+8. Open the `www/` folder and update your HTML to use the new `cordova-2.4.0.js` file
+
+## Upgrade to 2.3.0 from 2.2.0 ##
+
+Updating just the `www` folder:
+
+1. Open your `www/` folder, which contains your app.
+2. Remove and update the .jar file in the `ext/` folder.
+3. Update the contents of the `ext-air/` folder.
+4. Copy the new `cordova-2.3.0.js` into your project.
+ - If playbook, then update the .js file in the `playbook/` folder.
+ - If BlackBerry 10, then update the .js file in the `qnx/` folder.
+5. Update your HTML to use the new `cordova-2.3.0.js` file.
+
+Updating the sample folder (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` folder.
+2. Update the .jar file in the `cordova.2.2.0/ext/` folder.
+3. Update the contents of the `cordova.2.2.0/ext-air/` folder.
+4. Update the contents of the `cordova.2.2.0/ext-qnx/` folder.
+5. Update the .js file in the `cordova.2.2.0/javascript/` folder.
+6. Open the `sample/lib/` folder and rename the `cordova.2.2.0/` folder to `cordova.2.3.0/`.
+7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
+8. Open the `www/` folder and update your HTML to use the new `cordova-2.3.0.js` file
+
+## Upgrade to 2.2.0 from 2.1.0 ##
+
+Updating just the www folder:
+
+1. Open your `www/` folder, which contains your app.
+2. Remove and update the .jar file in the `ext/` folder.
+3. Update the contents of the `ext-air/` folder.
+4. Copy the new `cordova-2.2.0.js` into your project.
+ - If playbook, then update the .js file in the `playbook/` folder.
+ - If BlackBerry 10, then update the .js file in the `qnx/` folder.
+5. Update your HTML to use the new `cordova-2.2.0.js` file.
+
+Updating the sample folder (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` folder.
+2. Update the .jar file in the `cordova.2.1.0/ext/` folder.
+3. Update the contents of the `cordova.2.1.0/ext-air/` folder.
+4. Update the contents of the `cordova.2.1.0/ext-qnx/` folder.
+5. Update the .js file in the `cordova.2.1.0/javascript/` folder.
+6. Open the `sample/lib/` folder and rename the `cordova.2.1.0/` folder to `cordova.2.2.0/`.
+7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
+8. Open the `www/` folder and update your HTML to use the new `cordova-2.2.0.js` file.
+
+## Upgrade to 2.1.0 from 2.0.0 ##
+
+Updating just the `www` folder:
+
+1. Open your `www/` folder, which contains your app.
+2. Remove and update the .jar file in the `ext/` folder.
+3. Update the contents of the `ext-air/` folder.
+4. Copy the new `cordova-2.1.0.js` into your project.
+ - If playbook, then update the .js file in the `playbook/` folder.
+5. Update your HTML to use the new `cordova-2.1.0.js` file.
+
+Updating the sample folder (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` folder.
+2. Update the .jar file in the `cordova.2.0.0/ext/` folder.
+3. Update the contents of the `cordova.2.0.0/ext-air/` folder.
+4. Update the .js file in the `cordova.2.0.0/javascript/` folder.
+5. Open the `sample/lib/` folder and rename the `cordova.2.0.0/` folder to `cordova.2.1.0/`.
+6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
+7. Open the `www/` folder and update your HTML to use the new `cordova-2.1.0.js` file.
+
+## Upgrade to 2.0.0 from 1.9.0 ##
+
+Updating just the `www` folder:
+
+1. Open your `www/` folder, which contains your app.
+2. Remove and update the .jar file in the `ext/` folder.
+3. Update the contents of the `ext-air/` folder.
+4. Copy the new `cordova-2.0.0.js` into your project.
+ - If playbook, then update the .js file in the `playbook/` folder.
+5. Update your HTML to use the new `cordova-2.0.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:
+
+ <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/>
+ <plugin name="Contact" value="org.apache.cordova.pim.Contact"/>
+
+ To:
+
+ <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
+ <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
+
+Updating the sample folder (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` folder.
+2. Update the .jar file in the `cordova.1.9.0/ext/` folder.
+3. Update the contents of the `cordova.1.9.0/ext-air/` folder.
+4. Update the .js file in the `cordova.1.9.0/javascript/` folder.
+5. Open the `sample/lib/` folder and rename the `cordova.1.9.0/` folder to `cordova.2.0.0/`.
+6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
+7. Open the `www/` folder and update your HTML to use the new `cordova-2.0.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:
+
+ <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/>
+ <plugin name="Contact" value="org.apache.cordova.pim.Contact"/>
+
+ To:
+
+ <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
+ <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
+
+- To upgrade to 1.8.0, please go from 1.7.0
+
+## Upgrade to 1.8.0 from 1.7.0 ##
+
+Updating just the `www` folder:
+
+1. Open your `www/` folder, which contains your app.
+2. Remove and update the .jar file in the `ext/` folder.
+3. Update the contents of the `ext-air/` folder.
+4. Copy the new `cordova-1.8.0.js` into your project.
+ - 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:
+
+ <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/>
+ <plugin name="Contact" value="org.apache.cordova.pim.Contact"/>
+
+ To:
+
+ <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
+ <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
+
+Updating the sample folder (ie, updating using the ant tools):
+
+1. Open the `sample/lib/` folder.
+2. Update the .jar file in the `cordova.1.7.0/ext/` folder.
+3. Update the contents of the `cordova.1.7.0/ext-air/` folder.
+4. Update the .js file in the `cordova.1.7.0/javascript/` folder.
+5. Open the `sample/lib/` folder and rename the `cordova.1.7.0/` folder to `cordova.1.8.0/`.
+6. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova.
+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:
+
+ <plugin name="Capture" value="org.apache.cordova.media.MediaCapture"/>
+ <plugin name="Contact" value="org.apache.cordova.pim.Contact"/>
+
+ To:
+
+ <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture"/>
+ <plugin name="Contacts" value="org.apache.cordova.pim.Contact"/>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/blackberry10/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/blackberry10/index.md b/docs/en/3.0.0rc1/guide/platforms/blackberry10/index.md
new file mode 100644
index 0000000..f3c35cf
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/blackberry10/index.md
@@ -0,0 +1,165 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# BlackBerry 10 Platform Guide
+
+This guide shows how to set up your SDK development environment to
+deploy Cordova apps for BlackBerry 10 devices. See the following for more
+detailed platform-specific information:
+
+* BlackBerry 10 Plugins
+* BlackBerry 10 Command-line Tools
+
+The command-line tools above refer to versions prior to Cordova 3.0.
+See The Cordova Command-line Interface for information about the
+current interface.
+
+## Requirements
+
+Cordova for BlackBerry has the following software requirements:
+
+- Windows XP (32-bit) or Windows 7 (32-bit and 64-bit) or Mac OSX 10.6.4+
+- node.js (> 0.9.9) [Download node.js now](http://nodejs.org/)
+- BlackBerry 10 Native SDK. [Download the BlackBerry 10 Native SDK now.](http://developer.blackberry.com/native/download/)
+
+## Setting up your signing keys
+
+Before starting development, you'll need to register for your code signing key and debug token. The signing key allows you to sign your completed app so that you can distribute it through BlackBerry World. The debug token allows you to test an unsigned app on a BlackBerry 10 device. You do not need to create and install the debug token yourself; if you supply the keystore password, the build script will create and install the debug token for you.
+
+- [Register for your code signing key now.](https://www.blackberry.com/SignedKeys/codesigning.html)
+- [Set your computer up for code signing. ](http://developer.blackberry.com/html5/documentation/set_up_for_signing.html)
+- [Learn more about debug tokens.](http://developer.blackberry.com/html5/documentation/running_your_bb10_app_2008471_11.html)
+
+## Creating your project
+
+To create a new project, you use the `create` command to set up the folder structure for your app.
+
+1. On the command line, navigate to the folder where you extracted Cordova.
+2. Run the `create` command using the following syntax:
+
+ bin/create <path-to-project>
+
+This command creates the folder structure for your project at the specified location. All of your project resource files should be stored in the *<path-to-project>*/www folder, or in a subfolder within it.
+
+## Adding and managing targets
+
+A target refers to a BlackBerry device or emulator that you will use to test your app. Targets are added directly to your project; you can add multiple targets to your project, each with a unique name. Then, when you want to deploy your app to a particular target, you can simply refer to that target by name when you run your script.
+
+###Add a target
+
+To add a target, on the command line, type the following command:
+
+ <path-to-project>/cordova/target add <name> <ip-address> [-t | --type <device | simulator>] [-p | --password <password>] [--pin <device-pin>]
+
+where
+
+- `<name>` specifies a unique name for the target.
+- `<ip-address>` specifies the ip address of the BlackBerry device or emulator.
+- `-t <device | simulator>` specifies the target type. If not provided, the default value is device.
+- `-p|--password <password>` specifies the password for the device or emulator. This is required only if the device or emulator is password protected.
+- `--pin <device-pin>` specifies the PIN of the BlackBerry device, which identifies that device as a valid host for the debug token. This argument is required only if you are creating a debug token.
+
+###Remove a target
+
+To remove a target, on the command line, type the following command:
+
+ <path-to-project>/cordova/target remove <name>
+
+###Set a target as the default
+
+To specify a specific target as the default, on the command line, type the following command:
+
+ <path-to-project>/cordova/target default <name>
+
+## Building your app
+
+To build your app, run the build script. You can build the app in either release mode or in debug mode.
+
+- When you build the app in release mode, you are preparing it for distribution through BlackBerry World. The script packages your app resources and plugins together in a .bar file, then signs the app.
+- When you build the app in debug mode, you are preparing it to be tested. The script packages your app resources and plugins together in a .bar file, but does not sign it. The script can also deploy the app onto a previously defined target. If you have not already created and installed a debug token, you can supply the keystore password, and the build script will create and install the debug token for you as well.
+
+ Debug mode also enables Web Inspector for the app, which allows you to remotely inspect the source code. A prompt displays the URL that you can use to connect to and inspect your app. For more information on using Web Inspector, see [Debugging using Web Inspector](http://developer.blackberry.com/html5/documentation/web_inspector_overview_1553586_11.html).
+
+###Build your app in release mode
+
+To build your app in release mode, on the command line, type the following command:
+
+ <path-to-project>/cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-file>]
+
+where
+
+- `-k|--keystorepass <password>` specifies the password you defined when you configured your computer to sign applications.
+- `-b|--buildId <number>` specifies the build version number of your application. Typically, this number should be incremented from the previous signed version. This argument is optional.
+- `-p|--params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools. This argument is optional.
+
+###Build your app in debug mode
+
+To build your app in release mode, on the command line, type the following command:
+
+ <path-to-project>/cordova/build debug [<target>] [-k|--keystorepass <password>] [-p|--params <params-JSON-file>] [-ll|--loglevel <error|warn|verbose>]
+
+where
+
+- `<target>` specifies the name of a previously added target. If `<target>` is not specified, the default target is used, if one has been created. This argument is only required if you want the script to deploy your app to a BlackBerry device or emulator and you have not created a default target. Additionally, if `<target>` is a device, then that device must be connected to your computer by USB connection or be connected to the same Wi-Fi network as your computer.
+- `-k|--keystorepass <password>` specifies the password you defined when you configured your computer to sign applications. This password is also used to create your debug token. This argument is only required if you want the script to create and install the debug token for you.
+- `-p|--params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools.
+- `-ll|--loglevel <level>` specifies the log level. The log level may be one of `error`, `warn`, or `verbose`.
+
+Note that all of these parameters are optional. If you have previously defined a default target (and installed a debug token, if that target is a BlackBerry device), you can run the script with no arguments, and the script will package your app and deploy it to the default target. For example:
+
+ <path-to-project>/cordova/build debug
+
+## Deploying an app
+
+You can test your app using either a BlackBerry device or an emulator. Before deploying your app, you must first create a target for the device or emulator you want to deploy your app to.
+
+The run script will first build your app. If you intend to deploy an app to a physical device for testing, you must first install a debug token on that device. If you specify the `--keystorepass <password>` argument when running the run script, the script will create and install the debug token for you. You do not need a debug token to test your app on an emulator, even if that app is unsigned.
+
+To deploy your app to a device or emulator, on a command line type the following command:
+
+ <path-to-project>/cordova/run <target> [--no-build]
+
+where
+- `<target>` specifies the name of a previously added target. If `<target>` is a device, then that device must be connected to your computer by USB connection or be connected to the same Wi-Fi network as your computer.
+
+- `-no--build` will use the most recently built version of the application rather than re-building. This is useful to test an application in release mode.
+
+## Adding and managing plugins
+
+To add additional functionality that is outside of the core features of Cordova, you'll need to add plugins. A plugin represents a set of APIs that provide access to additional features of the platform.
+
+In order to use a plugin, you must first add it into your project. Once added into your project, the plugin will be bundled with your project during the build process, to ensure that your app has access to all the APIs it needs.
+
+###Add a plugin
+
+To add a plugin, on the command line, type the following command:
+
+ <path-to-project>/cordova/plugin add <path to plugin>
+
+###Remove a plugin
+
+To remove a plugin, on the command line, type the following command:
+
+ <path-to-project>/cordova/plugin rm <name>
+
+###View a list of installed plugins
+
+To view a list of installed plugins, on the command line, type the following command:
+
+ <path-to-project>/cordova/plugin ls
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/blackberry10/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/blackberry10/plugin.md b/docs/en/3.0.0rc1/guide/platforms/blackberry10/plugin.md
new file mode 100644
index 0000000..aceb335
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/blackberry10/plugin.md
@@ -0,0 +1,190 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# BlackBerry 10 Plugins
+
+This is a continuation of the Plugin Development Guide for Cordova. Once you have reviewed that content, now let's look at things we need to have the Echo plugin for the BlackBerry 10 platform. Recall that the Echo plugin basically returns whatever string a user provides to the `window.echo` function:
+
+ window.echo = function(str, callback) {
+ cordova.exec(callback, function(err) {
+ callback('Nothing to echo.');
+ }, "Echo", "echo", [str]);
+ };
+
+A native BlackBerry 10 plugin for Cordova contains JavaScript code and may also contain native code. The Echo plugin example demonstrates how to invoke native functionality from JavaScript. The native and JavaScript code communicate with each other through a framework provided by JNEXT. Every plugin must also include a plugin.xml file.
+
+## Creating the native part of your plugin ##
+
+To create the native portion of your plugin, open the BlackBerry 10 NDK IDE and select File > New > BlackBerry Project > Native Extension > BlackBerry WebWorks. Enter your desired project name / location and click finish.
+
+The project created by the IDE contains sample code for a memory plugin. You may replace or modify these files to include your own functionality.
+
+- ***name*_js.hpp**: C++ header for the JNEXT code.
+- ***name*_js.cpp**: C++ code for JNEXT.
+
+The native interface for the JNEXT extension can be viewed in the plugin header file located in the public folder of your project. It also contains constants and utility functions that can be used in your native code. Your plugin must be derived from JSExt which is defined in plugin.h. That is, you must implement the following class:
+
+ class JSExt
+ {
+ public:
+ virtual ~JSExt() {};
+ virtual string InvokeMethod( const string& strCommand ) = 0;
+ virtual bool CanDelete( void ) = 0;
+ private:
+ std::string m_id;
+ };
+
+Therefore, your extension should include the plugin.h header file. In the Echo example, you use JSExt as follows in the echo_js.hpp file:
+
+ #include "../public/plugin.h"
+ #include <string>
+
+ #ifndef ECHO_JS_H_
+ #define ECHO_JS_H_
+
+ class Echo : public JSExt
+ {
+ public:
+ explicit Echo(const std::string& id);
+ virtual ~Echo();
+ virtual std::string InvokeMethod(const std::string& command);
+ virtual bool CanDelete();
+ private:
+ std::string m_id;
+ };
+
+ #endif // ECHO_JS_H_
+
+The `m_id` is an attribute that contains the JNEXT id for this object. The id is passed to the class as an argument to the constructor. It is needed to trigger events on the JavaScript side from native.
+The CanDelete method is used by JNEXT to determine whether your native object can be deleted.
+The InvokeMethod function is called as a result from a request from JavaScript to invoke a method of this particular object. The only argument to this function is a string passed from JavaScript that this method should parse in order to determine which method of the native object should be executed.
+Now we implement these functions in echo_js.cpp. For the Echo example, we implement InvokeMethod function as follows:
+
+ string Echo::InvokeMethod(const string& command) {
+
+ //parse command and args from string
+ int index = command.find_first_of(" ");
+ string strCommand = command.substr(0, index);
+ string strValue = command.substr(index + 1, command.length());
+
+ // Determine which function should be executed
+ if (strCommand == "echo") {
+ return strValue;
+ } else {
+ return "Unsupported Method";
+ }
+ }
+
+Your native plugin must also implement the following callback functions:
+
+- `extern char* onGetObjList( void );`
+- `extern JSExt* onCreateObject( const string& strClassName, const string& strObjId );`
+
+The `onGetObjList` function returns a comma separated list of classes supported by JNEXT. JNEXT uses this function to determine the set of classes that JNEXT can instantiate. In our Echo plugin, we have the following in `echo_js.cpp`:
+
+ char* onGetObjList() {
+ static char name[] = "Echo";
+ return name;
+ }
+
+The `onCreateObject ` function takes two parameters. The first parameter is the name of the class requested to be created from the JavaScript side. Valid names are those that are returned in `onGetObjList`. The second parameter is the unique object id for the class. This method returns a pointer to the created plugin object. In our Echo plugin, we have the following in `echo_js.cpp`:
+
+ JSExt* onCreateObject(const string& className, const string& id) {
+ if (className == "Echo") {
+ return new Echo(id);
+ }
+ return NULL;
+ }
+
+##Creating the JavaScript part of your plugin##
+
+The JavaScript portion of your plugin must contain the following files:
+
+- **client.js**: This is considered the client side and contains the API that a Cordova application can call. The API in client.js calls makes calls to index.js. The API in client.js also connects callback functions to the events that fire the callbacks.
+
+- **index.js**: Cordova loads index.js and makes it accessible through the cordova.exec bridge. The client.js file makes calls to the API in the index.js file, which in turn makes call to JNEXT to communicate with the native side.
+
+The client and server side (client.js and index.js) interacts through the `Cordova.exec `function. So, in client.js you invoke the exec function and provide the necessary arguments. In the Echo plugin, we have the following in the client.js file:
+
+ var service = "org.apache.cordova.blackberry.echo",
+ exec = cordova.require("cordova/exec");
+
+ module.exports = {
+ echo: function (data, success, fail) {
+ exec(success, fail, service, "echo", { data: data });
+ }
+ };
+
+Now, index.js interacts with the native side using JNEXT. So you attach a constructor function named Echo to JNEXT. Within the constructor you perform the following key operations using the init function:
+
+- Specify the required module exported by the native side. The name of the required module must match the name of a shared library file (.so file).
+
+`JNEXT.require("libecho")`
+
+- Create an object by using an acquired module and save the ID that's returned by the call.
+self.m_id = JNEXT.createObject("libecho.Echo");
+When your application calls the echo function in client.js, that call in turn calls the echo function in index.js, where the PluginResult object sends a response (data) back to client.js. Since the args argument passed into the functions was converted by JSON.stringfy() and encoded as a URIcomponent, you must call the following:
+
+`data = JSON.parse(decodeURIComponent(args.data));`
+
+You can now send the data back. Let’s put it all together:
+
+ module.exports = {
+
+ echo: function (success, fail, args, env) {
+
+ var result = new PluginResult(args, env),
+ data = JSON.parse(decodeURIComponent(args.data)),
+ response = echo.getInstance().echo(data);
+ result.ok(response, false);
+ }
+ };
+
+## Architecture of the plugin ##
+
+You can place the artifacts of the plugin, which includes the plugin.xml file, the source files (JavaScript, C++), and the binary files (.so) within any directory structure, as long as you correctly specify the file locations in the plugin.xml file. Below we show a typical structure that you can follow:
+
+***your_project_folder*** (>plugin.xml)
+
+- **www** (>client.js)
+- **src**
+ - **blackberry10** (>index.js, **native** >*.cpp, *.hpp)
+ - **device** (>*biary file* *.so)
+ - **simulator** (>*binary file* *.so)
+
+(The list shows the hierarchical relationship among the top level folders. The parenthesis shows the contents of a given folder. All folder names appear in bold text. File names are preceded by the '>' sign.)
+
+## Contents of the plugin.xml file##
+The plugin.xml file contains the namespace of the extension and other metadata. Define the namespace and specify other metadata for the Echo plugin as follows:
+
+ <plugin xmlns="http://www.phonegap.com/ns/plugins/1.0"
+ id="org.apache.cordova.blackberry.echo"
+ version="1.0.0">
+ <js-module src="www/client.js">
+ <merges target="navigator" />
+ </js-module>
+ <platform name="blackberry10">
+ <source-file src="src/blackberry10/index.js" />
+ <lib-file src="src/blackberry10/native/device/libecho.so" arch="device" />
+ <lib-file src="src/blackberry10/native/simulator/libecho.so" arch="simulator" />
+ <config-file target="www/config.xml" parent="/widget">
+ <feature name="org.apache.cordova.blackberry.echo" value="org.apache.cordova.blackberry.echo" />
+ </config-file>
+ </platform>
+ </plugin>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/blackberry10/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/blackberry10/tools.md b/docs/en/3.0.0rc1/guide/platforms/blackberry10/tools.md
new file mode 100644
index 0000000..a605680
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/blackberry10/tools.md
@@ -0,0 +1,162 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# BlackBerry 10 Command-line Tools
+
+The `cordova` command-line utility is a high-level tool that allows
+you to build applications across several platforms at once. An older
+version of the Cordova framework provides sets of command-line tools
+specific to each platform. To use them as an alternative to the CLI,
+you need to download this version of Cordova from
+[cordova.apache.org](http://cordova.apache.org). The download contains
+separate archives for each platform. Expand the platform you wish to
+target. The tools described here are typically available in the
+top-level `bin` directory, otherwise consult the __README__ file for
+more detailed directions.
+
+If you need help with any command listed below, type the command along
+with the `-h` or `-help` arguments, which are supported by all
+commands and which provide descriptions for each of the available
+arguments.
+
+## create
+
+The 'create' command creates a new project:
+
+ bin/create <path-to-project>
+
+## target
+
+The `target` command allows you to manage the BlackBerry device(s) or
+emulator that you will use to test your app. You can add or remove a
+target, or set a target as the default target.
+
+### Add a target
+
+ <path-to-project>/cordova/target add <name> <ip-address> [-t | --type <device | simulator>] [-p | --password <password>] [--pin <device-pin>]
+
+where
+
+- `<name>` specifies a unique name for the target.
+
+- `<ip-address>` specifies the ip address of the BlackBerry device or
+ simulator.
+
+- `-p | --password <password>` specifies the password for the device or
+ emulator. This is required only if the device or emulator is
+ password protected.
+
+- `--pin <device-pin>` specifies the PIN of the BlackBerry device,
+ which identifies that device as a valid host for the debug
+ token. This argument is required only if you are creating a debug
+ token.
+
+### Remove a target
+
+ <path-to-project>/cordova/target remove <name>
+
+### Set a target as the default
+
+ <path-to-project>/cordova/target default <name>
+
+## build
+
+The `build` command builds the project as a .bar file. You can build
+your app in either release mode (which produces a signed .bar file) or
+in debug mode (which produces an unsigned .bar file).
+
+### Build your project in release mode
+
+ <path-to-project>/cordova/build release [-k | --keystorepass <password>] [-b | --buildId <number>] [-p | --params <params-JSON-file>]
+
+where
+
+- `-k | --keystorepass <password>` specifies the password you defined when you configured your computer to sign applications.
+- `-b | --buildId <number>` specifies the build version number of your application. Typically, this number should be incremented from the previous signed version. This argument is optional.
+- `-p | --params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools. This argument is optional.
+
+### Build your project in debug mode
+
+ <path-to-project>/cordova/build debug [<target>] [-k | --keystorepass <password>] [-p | --params <params-JSON-file>] [-ll | --loglevel <error|warn|verbose>]
+
+where
+
+- `<target>` specifies the name of a previously added target. If
+ `<target>` is not specified, the default target is used, if one has
+ been created. This argument is only required if you want the script
+ to deploy your app to a BlackBerry device or emulator and you have
+ not created a default target. Additionally, if `<target>` is a
+ device, then that device must be connected to your computer by USB
+ connection or be connected to the same Wi-Fi network as your
+ computer.
+
+- `-k | --keystorepass <password>` specifies the password you defined
+ when you configured your computer to sign applications. This
+ password is also used to create your debug token. This argument is
+ only required if you want the script to create and install the debug
+ token for you.
+
+- `-p | --params <params-JSON-file>` specifies a JSON file containing
+ additional parameters to pass to downstream tools.
+
+- `-ll | --loglevel <level>` specifies the log level. The log level may
+ be one of `error`, `warn`, or `verbose`.
+
+If you have previously defined a default target (and previously
+installed a debug token, if that target is a BlackBerry device), you
+can run the script with no arguments, and the script will package your
+app and deploy it to the default target. For example:
+
+ <path-to-project>/cordova/build debug
+
+## run
+
+The `run` command deploys the app on the specified BlackBerry device
+or an emulator. Before deploying your app, you must first create a
+target for the device or emulator you want to deploy your app to using
+the target script. The deploy script will deploy the most recent build of your app.
+
+ <path-to-project>/cordova/run <target>
+
+where
+
+- `<target> `specifies the name of a previously added target. If
+ `<target> `is a device, then that device must be connected to your
+ computer by USB connection or be connected to the same Wi-Fi network
+ as your computer.
+
+## plugin
+
+The `target` command allows you to add and remove plugins
+
+### Fetch a locally hosted plugin
+
+ <path-to-project>/cordova/plugin fetch <path-to-plugin>
+
+### View a list of installed plugins
+
+ <path-to-project>/cordova/plugin ls
+
+### Add a plugin
+
+ <path-to-project>/cordova/plugin add <name>
+
+### Remove a plugin
+
+ <path-to-project>/cordova/plugin rm <name>
[10/12] Version 3.0.0rc1
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/device/device.cordova.md b/docs/en/3.0.0rc1/cordova/device/device.cordova.md
new file mode 100644
index 0000000..0ba4c80
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/device/device.cordova.md
@@ -0,0 +1,79 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.cordova
+===============
+
+Get the version of Cordova running on the device.
+
+ var string = device.cordova;
+
+Description
+-----------
+
+`device.cordova` returns the version of Cordova running on the device.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ var name = device.cordova;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/device/device.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/device/device.md b/docs/en/3.0.0rc1/cordova/device/device.md
new file mode 100644
index 0000000..38abb0c
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/device/device.md
@@ -0,0 +1,92 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Device
+======
+
+> The `device` object describes the device's hardware and software.
+
+Properties
+----------
+
+- device.name
+- device.cordova
+- device.platform
+- device.uuid
+- device.version
+- device.model
+
+Variable Scope
+--------------
+
+Since `device` is assigned to the `window` object, it is implicitly in the global scope.
+
+ // These reference the same `device`
+ var phoneName = window.device.name;
+ var phoneName = device.name;
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Device" value="org.apache.cordova.Device" />
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.READ_PHONE_STATE" />
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Device" value="org.apache.cordova.device.Device" />
+
+#### www/config.xml
+
+ <feature id="blackberry.app" required="true" version="1.0.0.0" />
+ <rim:permissions>
+ <rim:permit>read_device_identifying_information</rim:permit>
+ </rim:permissions>
+
+### iOS
+
+ No permissions are required.
+
+### Windows Phone
+
+#### Properties/WPAppManifest.xml
+
+ <Capabilities>
+ <Capability Name="ID_CAP_WEBBROWSERCOMPONENT" />
+ <Capability Name="ID_CAP_IDENTITY_DEVICE" />
+ <Capability Name="ID_CAP_IDENTITY_USER" />
+ </Capabilities>
+
+Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+
+### Tizen
+
+#### config.xml
+
+ <feature name="http://tizen.org/api/systeminfo" required="true"/>
+
+Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/device/device.model.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/device/device.model.md b/docs/en/3.0.0rc1/cordova/device/device.model.md
new file mode 100644
index 0000000..8d366c4
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/device/device.model.md
@@ -0,0 +1,100 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.model
+===========
+
+Get the device's model name.
+
+ var string = device.model;
+
+Description
+-----------
+
+The `device.model` returns the name of the device's model or
+product. The value is set by the device manufacturer and may be
+different across versions of the same product.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // Android: Nexus One returns "Passion" (Nexus One code name)
+ // Motorola Droid returns "voles"
+ // BlackBerry: Torch 9800 returns "9800"
+ // iOS: for the iPad Mini, returns iPad2,5; iPhone 5 is iPhone 5,1. See http://theiphonewiki.com/wiki/index.php?title=Models
+ //
+ var model = device.model;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
+
+Android Quirks
+--------------
+
+- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL), which is often the production code name. For example, the Nexus One returns `Passion`, and Motorola Droid returns `voles`.
+
+Tizen Quirks
+-----------
+- Returns the device model assigned by the vendor, for example, `TIZEN`
+
+Windows Phone 7 and 8 Quirks
+-------------
+
+- Returns the device model specified by the manufacturer. For example, the Samsung Focus returns `SGH-i917`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/device/device.name.md b/docs/en/3.0.0rc1/cordova/device/device.name.md
new file mode 100644
index 0000000..c2b6dd6
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/device/device.name.md
@@ -0,0 +1,103 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.name
+===========
+
+__WARNING:__ `device.name` is deprecated as of version 2.3.0. Use `device.model` instead.
+
+Get the device's model name.
+
+ var string = device.name;
+
+Description
+-----------
+
+`device.name` returns the name of the device's model or product. This
+value is set by the device manufacturer and may be different across
+versions of the same product.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // Android: Nexus One returns "Passion" (Nexus One code name)
+ // Motorola Droid returns "voles"
+ // BlackBerry: Torch 9800 returns "9800"
+ // iOS: All devices returns either "iPhone", "iPod Touch", "iPhone Simulator", "iPad", "iPad Simulator"
+ //
+ var name = device.name;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Model: ' + device.model + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
+
+Android Quirks
+--------------
+
+- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL), which is often the production code name. For example, the Nexus One returns `Passion`, and Motorola Droid returns `voles`.
+
+Windows Phone 7 and 8 Quirks
+-------------
+
+- Returns the device model specified by the manufacturer. For example, the Samsung Focus returns `SGH-i917`.
+
+
+Tizen Quirks
+-----------
+- Returns the device model assigned by the vendor, for example, `TIZEN`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/device/device.platform.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/device/device.platform.md b/docs/en/3.0.0rc1/cordova/device/device.platform.md
new file mode 100644
index 0000000..f1e1d03
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/device/device.platform.md
@@ -0,0 +1,96 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.platform
+===============
+
+Get the device's operating system name.
+
+ var string = device.platform;
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // Depending on the device, a few examples are:
+ // - "Android"
+ // - "BlackBerry"
+ // - "iOS"
+ // - "WinCE"
+ // - "Tizen"
+ var devicePlatform = device.platform;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
+
+BlackBerry Quirks
+-----------------
+
+Devices may return the device platform version number instead of the
+platform name. For example, the Storm2 9550 returns a value such as
+`2.13.0.95`.
+
+Windows Phone 7 Quirks
+-----------------
+
+Windows Phone 7 devices report the platform as `WinCE`.
+
+Windows Phone 8 Quirks
+-----------------
+
+Windows Phone 8 devices report the platform as `Win32NT`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/device/device.uuid.md b/docs/en/3.0.0rc1/cordova/device/device.uuid.md
new file mode 100644
index 0000000..f2b0c39
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/device/device.uuid.md
@@ -0,0 +1,110 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.uuid
+===========
+
+Get the device's Universally Unique Identifier ([UUID](http://en.wikipedia.org/wiki/Universally_Unique_Identifier)).
+
+ var string = device.uuid;
+
+Description
+-----------
+
+The details of how a UUID is generated are determined by the device manufacturer and are specific to the device's platform or model.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // Android: Returns a random 64-bit integer (as a string, again!)
+ // The integer is generated on the device's first boot
+ //
+ // BlackBerry: Returns the PIN number of the device
+ // This is a nine-digit unique integer (as a string, though!)
+ //
+ // iPhone: (Paraphrased from the UIDevice Class documentation)
+ // Returns a string of hash values created from multiple hardware identifies.
+ // It is guaranteed to be unique for every device and cannot be tied
+ // to the user account.
+ // Windows Phone 7 : Returns a hash of device+current user,
+ // if the user is not defined, a guid is generated and will persist until the app is uninstalled
+ // Tizen: returns the device IMEI (International Mobile Equipment Identity or IMEI is a number
+ // unique to every GSM and UMTS mobile phone.
+ var deviceID = device.uuid;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
+
+iOS Quirk
+-------------
+
+The `uuid` on iOS is not unique to a device, but varies for each
+application, for each installation. It changes if you delete and
+re-install the app, and possibly also when you upgrade iOS, or even
+upgrade your app per version (apparent in iOS 5.1). The `uuid` is not
+a reliable value.
+
+Windows Phone 7 and 8 Quirks
+-------------
+
+The `uuid` for Windows Phone 7 requires the permission
+`ID_CAP_IDENTITY_DEVICE`. Microsoft will likely deprecate this
+property soon. If the capability is not available, the application
+generates a persistent guid that is maintained for the duration of the
+application's installation on the device.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/device/device.version.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/device/device.version.md b/docs/en/3.0.0rc1/cordova/device/device.version.md
new file mode 100644
index 0000000..07d99ad
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/device/device.version.md
@@ -0,0 +1,83 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+device.version
+==============
+
+Get the operating system version.
+
+ var string = device.version;
+
+Supported Platforms
+-------------------
+
+- Android 2.1+
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ // Android: Froyo OS would return "2.2"
+ // Eclair OS would return "2.1", "2.0.1", or "2.0"
+ // Version can also return update level "2.1-update1"
+ //
+ // BlackBerry: Torch 9800 using OS 6.0 would return "6.0.0.600"
+ //
+ // iPhone: iOS 3.2 returns "3.2"
+ //
+ // Windows Phone 7: returns current OS version number, ex. on Mango returns 7.10.7720
+ // Tizen: returns "TIZEN_20120425_2"
+ var deviceVersion = device.version;
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ var element = document.getElementById('deviceProperties');
+ element.innerHTML = 'Device Name: ' + device.name + '<br />' +
+ 'Device Cordova: ' + device.cordova + '<br />' +
+ 'Device Platform: ' + device.platform + '<br />' +
+ 'Device UUID: ' + device.uuid + '<br />' +
+ 'Device Version: ' + device.version + '<br />';
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="deviceProperties">Loading device properties...</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.backbutton.md b/docs/en/3.0.0rc1/cordova/events/events.backbutton.md
new file mode 100644
index 0000000..384fc92
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.backbutton.md
@@ -0,0 +1,86 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+backbutton
+===========
+
+The event fires when the user presses the back button.
+
+ document.addEventListener("backbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+To override the default back-button behavior, register an event
+listener for the `backbutton` event, typically by calling
+`document.addEventListener` once you receive the `deviceready` event.
+It is no longer necessary to call any other method to override the
+back-button behavior.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- Windows Phone 7 and 8
+
+Quick Example
+-------------
+
+ document.addEventListener("backbutton", onBackKeyDown, false);
+
+ function onBackKeyDown() {
+ // Handle the back button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Back Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("backbutton", onBackKeyDown, false);
+ }
+
+ // Handle the back button
+ //
+ function onBackKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.batterycritical.md b/docs/en/3.0.0rc1/cordova/events/events.batterycritical.md
new file mode 100644
index 0000000..cb52e7b
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.batterycritical.md
@@ -0,0 +1,94 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+batterycritical
+===========
+
+The event fires when the battery has reached the critical level
+threshold.
+
+ window.addEventListener("batterycritical", yourCallbackFunction, false);
+
+Details
+-------
+
+The event fires when the percentage of battery charge has reached the
+critical battery threshold. The value is device-specific.
+
+The `batterycritical` handler is passed an object that contains two
+properties:
+
+- __level__: The percentage of battery charge (0-100). _(Number)_
+- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
+
+Applications typically should use `window.addEventListener` to attach
+an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- iOS
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- Tizen
+
+Quick Example
+-------------
+
+ window.addEventListener("batterycritical", onBatteryCritical, false);
+
+ function onBatteryCritical(info) {
+ // Handle the battery critical event
+ alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Battery Critical Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ window.addEventListener("batterycritical", onBatteryCritical, false);
+ }
+
+ // Handle the batterycritical event
+ //
+ function onBatteryCritical(info) {
+ alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.batterylow.md b/docs/en/3.0.0rc1/cordova/events/events.batterylow.md
new file mode 100644
index 0000000..8246982
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.batterylow.md
@@ -0,0 +1,93 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+batterylow
+===========
+
+The event fires when the battery has reached the low level threshold.
+
+ window.addEventListener("batterylow", yourCallbackFunction, false);
+
+Details
+-------
+
+The event fires when the percentage of battery charge has reached the
+low battery threshold, device-specific value.
+
+The `batterylow` handler is passed an object that contains two
+properties:
+
+- __level__: The percentage of battery charge (0-100). _(Number)_
+- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
+
+Applications typically should use `document.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- iOS
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- Tizen
+
+Quick Example
+-------------
+
+ window.addEventListener("batterylow", onBatteryLow, false);
+
+ function onBatteryLow(info) {
+ // Handle the battery low event
+ alert("Battery Level Low " + info.level + "%");
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Ready Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ window.addEventListener("batterylow", onBatteryLow, false);
+ }
+
+ // Handle the batterylow event
+ //
+ function onBatteryLow(info) {
+ alert("Battery Level Low " + info.level + "%");
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.batterystatus.md b/docs/en/3.0.0rc1/cordova/events/events.batterystatus.md
new file mode 100644
index 0000000..d0effb5
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.batterystatus.md
@@ -0,0 +1,101 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+batterystatus
+===========
+
+The event fires when there is a change in the battery status.
+
+ window.addEventListener("batterystatus", yourCallbackFunction, false);
+
+Details
+-------
+
+This event fires when the percentage of battery charge changes by at
+least 1 percent, or if the device is plugged in or unplugged.
+
+The battery status handler is passed an object that contains two
+properties:
+
+- __level__: The percentage of battery charge (0-100). _(Number)_
+- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
+
+Applications typically should use `window.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- iOS
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- Windows Phone 7 and 8
+- Tizen
+
+Windows Phone 7 and 8 Quirks
+----------------------
+
+Windows Phone 7 does not provide native APIs to determine battery
+level, so the `level` property is unavailable. The `isPlugged`
+parameter _is_ supported.
+
+Quick Example
+-------------
+
+ window.addEventListener("batterystatus", onBatteryStatus, false);
+
+ function onBatteryStatus(info) {
+ // Handle the online event
+ console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Ready Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ window.addEventListener("batterystatus", onBatteryStatus, false);
+ }
+
+ // Handle the batterystatus event
+ //
+ function onBatteryStatus(info) {
+ console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.deviceready.md b/docs/en/3.0.0rc1/cordova/events/events.deviceready.md
new file mode 100644
index 0000000..a80674a
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.deviceready.md
@@ -0,0 +1,94 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+deviceready
+===========
+
+The event fires when Cordova is fully loaded.
+
+ document.addEventListener("deviceready", yourCallbackFunction, false);
+
+Details
+-------
+
+This event is essential to any application. It signals that Cordova's
+device APIs have loaded and are ready to access.
+
+Cordova consists of two code bases: native and JavaScript. While the
+native code loads, a custom loading image displays. However,
+JavaScript only loads once the DOM loads. This means your web
+application may potentially call a Cordova JavaScript function before
+the corresponding native code is available.
+
+The `deviceready` event fires once Cordova has fully loaded. Once the
+event fires, you can safely make calls to Cordova APIs. Applications
+typically attach an event listener with `document.addEventListener`
+once the HTML document's DOM has loaded.
+
+The `deviceready` event behaves somewhat differently from others. Any
+event handler registered after the `deviceready` event fires has its
+callback function called immediately.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ function onDeviceReady() {
+ // Now safe to use device APIs
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Ready Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Now safe to use device APIs
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.endcallbutton.md b/docs/en/3.0.0rc1/cordova/events/events.endcallbutton.md
new file mode 100644
index 0000000..3787eaa
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.endcallbutton.md
@@ -0,0 +1,83 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+endcallbutton
+===========
+
+This event fires when the user presses the end call button.
+
+ document.addEventListener("endcallbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+The event overrides the default end call behavior.
+
+Applications typically should use `document.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- BlackBerry WebWorks (OS 5.0 and higher)
+
+Quick Example
+-------------
+
+ document.addEventListener("endcallbutton", onEndCallKeyDown, false);
+
+ function onEndCallKeyDown() {
+ // Handle the end call button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>End Call Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("endcallbutton", onEndCallKeyDown, false);
+ }
+
+ // Handle the end call button
+ //
+ function onEndCallKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.md b/docs/en/3.0.0rc1/cordova/events/events.md
new file mode 100644
index 0000000..bdecd16
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.md
@@ -0,0 +1,85 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Events
+======
+
+> Cordova lifecycle events.
+
+Event Types
+-----------
+
+- deviceready
+- pause
+- resume
+- online
+- offline
+- backbutton
+- batterycritical
+- batterylow
+- batterystatus
+- menubutton
+- searchbutton
+- startcallbutton
+- endcallbutton
+- volumedownbutton
+- volumeupbutton
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Battery" value="org.apache.cordova.BatteryListener" />
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.BROADCAST_STICKY" />
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Battery" value="org.apache.cordova.battery.Battery" />
+
+#### www/config.xml
+
+ <feature id="blackberry.app" required="true" version="1.0.0.0" />
+ <feature id="blackberry.app.event" required="true" version="1.0.0.0" />
+ <feature id="blackberry.system.event" required="true" version="1.0.0.0" />
+
+### iOS
+
+#### config.xml
+
+ <plugin name="Battery" value="CDVBattery" />
+
+### Windows Phone
+
+ No permissions are required.
+
+### Tizen
+
+#### config.xml
+
+ <feature name="http://tizen.org/api/systeminfo" required="true"/>
+
+Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.menubutton.md b/docs/en/3.0.0rc1/cordova/events/events.menubutton.md
new file mode 100644
index 0000000..dd4b903
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.menubutton.md
@@ -0,0 +1,84 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+menubutton
+===========
+
+The event fires when the user presses the menu button.
+
+ document.addEventListener("menubutton", yourCallbackFunction, false);
+
+Details
+-------
+
+Applying an event handler overrides the default menu button behavior.
+
+Applications typically should use `document.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+
+Quick Example
+-------------
+
+ document.addEventListener("menubutton", onMenuKeyDown, false);
+
+ function onMenuKeyDown() {
+ // Handle the back button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Menu Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("menubutton", onMenuKeyDown, false);
+ }
+
+ // Handle the menu button
+ //
+ function onMenuKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.offline.md b/docs/en/3.0.0rc1/cordova/events/events.offline.md
new file mode 100644
index 0000000..ca3fb6f
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.offline.md
@@ -0,0 +1,103 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+offline
+===========
+
+The event fires when an application goes offline, and the device is
+not connected to the Internet.
+
+ document.addEventListener("offline", yourCallbackFunction, false);
+
+Details
+-------
+
+The `offline` event fires when a previously connected device loses a
+network connection so that an application can no longer access the
+Internet. It relies on the same information as the Connection API,
+and fires when the `connection.type` changes from `NONE` to any other
+value.
+
+Applications typically should use `document.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ document.addEventListener("offline", onOffline, false);
+
+ function onOffline() {
+ // Handle the offline event
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Offline Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ document.addEventListener("offline", onOffline, false);
+ }
+
+ // Handle the offline event
+ //
+ function onOffline() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
+
+iOS Quirks
+--------------------------
+During initial startup, the first offline event (if applicable) takes at least a second to fire.
+
+Windows Phone 7 Quirks
+--------------------------
+When running in the Emulator, the `connection.status` is always unknown, so this event does _not_ fire.
+
+Windows Phone 8 Quirks
+--------------------------
+The Emulator reports the connection type as `Cellular`, which does not change, so the event does _not_ fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.online.md b/docs/en/3.0.0rc1/cordova/events/events.online.md
new file mode 100644
index 0000000..c72e446
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.online.md
@@ -0,0 +1,105 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+online
+===========
+
+This event fires when an application goes online, and the device
+becomes connected to the Internet.
+
+ document.addEventListener("online", yourCallbackFunction, false);
+
+Details
+-------
+
+The `online` event fires when a previously unconnected device receives
+a network connection to allow an application access to the Internet.
+It relies on the same information as the Connection API, and fires
+when the value of `connection.type` becomes `NONE`.
+
+Applications typically should use `document.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ document.addEventListener("online", onOnline, false);
+
+ function onOnline() {
+ // Handle the online event
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Online Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("online", onOnline, false);
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ }
+
+ // Handle the online event
+ //
+ function onOnline() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
+
+iOS Quirks
+--------------------------
+
+During initial startup, the first `online` event (if applicable) takes
+at least a second to fire, prior to which `connection.type` is
+`UNKNOWN`.
+
+Windows Phone 7 Quirks
+--------------------------
+When running in the Emulator, the `connection.status` is always unknown, so this event will _not_ fire.
+
+Windows Phone 8 Quirks
+--------------------------
+The Emulator reports the connection type as `Cellular`, which does not change, so events will _not_ fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.pause.md b/docs/en/3.0.0rc1/cordova/events/events.pause.md
new file mode 100644
index 0000000..4e70316
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.pause.md
@@ -0,0 +1,107 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+pause
+===========
+
+The event fires when an application is put into the background.
+
+ document.addEventListener("pause", yourCallbackFunction, false);
+
+Details
+-------
+
+
+The `pause` event fires when the native platform puts the application
+into the background, typically when the user switches to a different
+application.
+
+Applications typically should use `document.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ document.addEventListener("pause", onPause, false);
+
+ function onPause() {
+ // Handle the pause event
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Pause Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ document.addEventListener("pause", onPause, false);
+ }
+
+ // Handle the pause event
+ //
+ function onPause() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
+
+iOS Quirks
+--------------------------
+
+In the `pause` handler, any calls to the Cordova API or to native
+plug-ins that go through Objective-C do not work, along with any
+interactive calls, such as alerts or `console.log()`. They are only
+processed when the app resumes, on the next run loop.
+
+The iOS-specific `resign` event is available as an alternative to
+`pause`, and detects when users enable the __Lock__ button to lock the
+device with the app running in the foreground. If the app (and
+device) is enabled for multi-tasking, this is paired with a subsequent
+`pause` event, but only under iOS 5. In effect, all locked apps in iOS
+5 that have multi-tasking enabled are pushed to the background. For
+apps to remain running when locked under iOS 5, disable the app's
+multi-tasking by setting
+[UIApplicationExitsOnSuspend](http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html)
+to `YES`. To run when locked on iOS 4, this setting does not matter.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.resume.md b/docs/en/3.0.0rc1/cordova/events/events.resume.md
new file mode 100644
index 0000000..cb777d9
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.resume.md
@@ -0,0 +1,119 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+resume
+===========
+
+The event fires when an application is retrieved from the background.
+
+ document.addEventListener("resume", yourCallbackFunction, false);
+
+Details
+-------
+
+The `resume` event fires when the native platform pulls the
+application out from the background.
+
+Applications typically should use `document.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ document.addEventListener("resume", onResume, false);
+
+ function onResume() {
+ // Handle the resume event
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Resume Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ document.addEventListener("resume", onResume, false);
+ }
+
+ // Handle the resume event
+ //
+ function onResume() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
+
+iOS Quirks
+--------------------------
+
+Any interactive functions called from a `pause` event handler execute
+later when the app resumes, as signaled by the `resume` event. These
+include alerts, `console.log()`, and any calls from plugins or the
+Cordova API, which go through Objective-C.
+
+- __active__ event
+
+ The iOS-specific `active` event is available as an alternative to
+`resume`, and detects when users disable the __Lock__ button to unlock
+the device with the app running in the foreground. If the app (and
+device) is enabled for multi-tasking, this is paired with a subsequent
+`resume` event, but only under iOS 5. In effect, all locked apps in
+iOS 5 that have multi-tasking enabled are pushed to the background.
+For apps to remain running when locked under iOS 5, disable the app's
+multi-tasking by setting [UIApplicationExitsOnSuspend](http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html)
+to `YES`. To run when locked on iOS 4, this setting does not matter.
+
+- __resume__ event
+
+ When called from a `resume` event handler, interactive functions such
+as `alert()` need to be wrapped in a `setTimeout()` call with a
+timeout value of zero, or else the app hangs. For example:
+
+ document.addEventListener("resume", onResume, false);
+ function onResume() {
+ setTimeout(function() {
+ // TODO: do your thing!
+ }, 0);
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.searchbutton.md b/docs/en/3.0.0rc1/cordova/events/events.searchbutton.md
new file mode 100644
index 0000000..8dcd779
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.searchbutton.md
@@ -0,0 +1,84 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+searchbutton
+===========
+
+The event fires when the user presses the search button on Android.
+
+ document.addEventListener("searchbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+If you need to override the default search button behavior on Android
+you can register an event listener for the 'searchbutton' event.
+
+Applications typically should use `document.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- Android
+
+Quick Example
+-------------
+
+ document.addEventListener("searchbutton", onSearchKeyDown, false);
+
+ function onSearchKeyDown() {
+ // Handle the search button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Search Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("searchbutton", onSearchKeyDown, false);
+ }
+
+ // Handle the search button
+ //
+ function onSearchKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.startcallbutton.md b/docs/en/3.0.0rc1/cordova/events/events.startcallbutton.md
new file mode 100644
index 0000000..7a19d58
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.startcallbutton.md
@@ -0,0 +1,84 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+startcallbutton
+===========
+
+The event fires when the user presses the start call button.
+
+ document.addEventListener("startcallbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+If you need to override the default start call behavior you can
+register an event listener for the `startcallbutton` event.
+
+Applications typically should use `document.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- BlackBerry WebWorks (OS 5.0 and higher)
+
+Quick Example
+-------------
+
+ document.addEventListener("startcallbutton", onStartCallKeyDown, false);
+
+ function onStartCallKeyDown() {
+ // Handle the start call button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Start Call Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("startcallbutton", onStartCallKeyDown, false);
+ }
+
+ // Handle the start call button
+ //
+ function onStartCallKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.volumedownbutton.md b/docs/en/3.0.0rc1/cordova/events/events.volumedownbutton.md
new file mode 100644
index 0000000..4700e5a
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.volumedownbutton.md
@@ -0,0 +1,84 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+volumedownbutton
+===========
+
+The event fires when the user presses the volume down button.
+
+ document.addEventListener("volumedownbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+If you need to override the default volume down behavior you can
+register an event listener for the `volumedownbutton` event.
+
+Applications typically should use `document.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- BlackBerry WebWorks (OS 5.0 and higher)
+
+Quick Example
+-------------
+
+ document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
+
+ function onVolumeDownKeyDown() {
+ // Handle the volume down button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Volume Down Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
+ }
+
+ // Handle the volume down button
+ //
+ function onVolumeDownKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/events/events.volumeupbutton.md b/docs/en/3.0.0rc1/cordova/events/events.volumeupbutton.md
new file mode 100644
index 0000000..c54b6ff
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/events/events.volumeupbutton.md
@@ -0,0 +1,84 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+volumeupbutton
+===========
+
+The event fires when the user presses the volume up button.
+
+ document.addEventListener("volumeupbutton", yourCallbackFunction, false);
+
+Details
+-------
+
+If you need to override the default volume up behavior you can
+register an event listener for the `volumeupbutton` event.
+
+Applications typically should use `document.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+Supported Platforms
+-------------------
+
+- BlackBerry WebWorks (OS 5.0 and higher)
+
+Quick Example
+-------------
+
+ document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
+
+ function onVolumeUpKeyDown() {
+ // Handle the volume up button
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+ <html>
+ <head>
+ <title>Volume Up Button Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ function onLoad() {
+ document.addEventListener("deviceready", onDeviceReady, false);
+ }
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ // Register the event listener
+ document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
+ }
+
+ // Handle the volume up button
+ //
+ function onVolumeUpKeyDown() {
+ }
+
+ </script>
+ </head>
+ <body onload="onLoad()">
+ </body>
+ </html>
[03/12] Version 3.0.0rc1
Posted by mw...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/firefoxos/config.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/firefoxos/config.md b/docs/en/3.0.0rc1/guide/platforms/firefoxos/config.md
new file mode 100644
index 0000000..8d2e96c
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/firefoxos/config.md
@@ -0,0 +1,23 @@
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+-->
+
+# FirefoxOS Configuration
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/index.md b/docs/en/3.0.0rc1/guide/platforms/index.md
new file mode 100644
index 0000000..45ea7e1
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/index.md
@@ -0,0 +1,92 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Platform Guides
+
+Before developing for any of the platforms listed below, install
+cordova's command-line interface (CLI).
+(For details, see The Command-line Interface.)
+
+To develop Cordova applications, you must install SDKs for each mobile
+platform you are targeting. This installation is necessary regardless
+of whether you do the majority of your work in the SDK or use the CLI
+for your build cycle.
+
+Each _Platform Guide_ listed below tells you what you need to know to
+set up each platform's development environment: where to obtain the
+SDK, how to set up device emulators, how to connect devices for direct
+testing, and how to manage signing key requirements. Additional
+guides provide information on each platform's unique set of
+configuration options, instructions to add plugins, how to upgrade
+each platform, and platform-specific command-line tools that serve as
+a lower-level alternative to the `cordova` command-line utility.
+
+## Android
+
+* Android Platform Guide
+* Android Configuration
+* Android WebViews
+* Android Plugins
+* Android Command-line Tools
+* Upgrading Android
+
+## BlackBerry
+
+* BlackBerry Platform Guide
+* BlackBerry Configuration
+* BlackBerry Command-line Tools
+* Upgrading BlackBerry
+
+## BlackBerry 10
+
+* BlackBerry 10 Platform Guide
+* BlackBerry 10 Plugins
+* BlackBerry 10 Command-line Tools
+
+## iOS
+
+* iOS Platform Guide
+* iOS Configuration
+* iOS WebViews
+* iOS Plugins
+* iOS Command-line Tools
+* Upgrading iOS
+
+## Windows Phone
+
+* Windows Phone 8 Platform Guide
+* Windows Phone 7 Platform Guide
+* Windows Phone Command-line Tools
+* Upgrading Windows Phone
+
+## Windows 8
+
+* Windows 8 Platform Guide
+* Windows 8 Command-line Tools
+* Upgrading Windows 8
+
+## Tizen
+
+* Tizen Platform Guide
+
+<!--
+## FirefoxOS
+
+* FirefoxOS Configuration
+-->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/ios/config.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/ios/config.md b/docs/en/3.0.0rc1/guide/platforms/ios/config.md
new file mode 100644
index 0000000..ba79cf8
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/ios/config.md
@@ -0,0 +1,57 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# iOS Configuration
+
+The `config.xml` settings file controls various settings of Cordova. This is application wide, and not set per CDVViewController instance.
+The `config.xml` file is located in your `<project folder>/<appname>` directory.
+
+## <preference>
+
+Various preferences (as **<preference>** tags) default on not breaking existing apps. The available preferences are:
+
+1. **DisallowOverscroll (boolean, defaults to false)** - set to true if you don't want the WebView to rubber-band
+
+2. **TopActivityIndicator (string, defaults to 'gray')** - this is the top spinning throbber in the status/battery bar, valid values are `whiteLarge`, `white`, and `gray`
+
+3. **EnableLocation (boolean, defaults to false)** - set to true, to initialize the Geolocation plugin at start-up (so the fix on your location can be more accurate) **DEPRECATED**: please set the **onload** attribute of the **Geolocation** plugin to **true** instead.
+
+4. **EnableViewportScale (boolean, defaults to false)** - set to true to prevent viewport scaling through a meta tag
+
+5. **AutoHideSplashScreen (boolean, defaults to true)** - set to false to control when the splashscreen is hidden through a JavaScript API
+
+6. **FadeSplashScreen (boolean, defaults to true)** - set to false to prevent the splash-screen to fade in and out when showing or hiding it.
+
+7. **FadeSplashScreenDuration (float, defaults to 2)** - The splash-screen Fade duration in seconds.
+
+8. **ShowSplashScreenSpinner (boolean, defaults to true)** - set to false to hide the splash-screen spinner
+
+9. **MediaPlaybackRequiresUserAction (boolean, defaults to false)** - set to true to not allow autoplayed HTML5 video
+
+10. **AllowInlineMediaPlayback (boolean, defaults to false)** - set to true to allow inline HTML5 media playback, also, the video element in the HTML document must also include the webkit-playsinline attribute
+
+11. **BackupWebStorage (string, defaults to 'cloud')** - valid values are 'none', 'cloud' and 'local'. Set to 'cloud' to allow the web storage data to be backed up to iCloud, and set to 'local' to only allow local backups (iTunes sync). Set to 'none' to not allow any backups of web storage.
+
+12. **KeyboardDisplayRequiresUserAction (boolean, defaults to true)** - set to false to open the keyboard when form elements get focus via the JavaScript focus() call.
+
+13. **SuppressesIncrementalRendering (boolean, defaults to false)** - set to true to wait until all new view content has been received before it is rendered.
+
+14. **HideKeyboardFormAccessoryBar (boolean, defaults to false)** - set to true to hide the additional toolbar that is on top of the keyboard (this is the toolbar that has the Prev, Next and Done buttons)
+
+15. **KeyboardShrinksView (boolean, defaults to false)** - set to true to shrink the WebView when the keyboard comes up. The WebView shrinks instead of the viewport shrinking and the page scrollable. This applies to apps that position their elements relative to the bottom of the WebView. This is the default behaviour on Android, and makes a lot of sense when building apps as opposed to webpages.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/ios/index.md b/docs/en/3.0.0rc1/guide/platforms/ios/index.md
new file mode 100644
index 0000000..d92045c
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/ios/index.md
@@ -0,0 +1,231 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# iOS Platform Guide
+
+This guide shows how to set up your SDK development environment to
+deploy Cordova apps for iOS devices such as iPhone and iPad. See the
+following for more detailed platform-specific information:
+
+* iOS Configuration
+* Upgrading iOS
+* iOS WebViews
+* iOS Plugins
+* iOS Command-line Tools
+
+The command-line tools above refer to versions prior to Cordova 3.0.
+See The Cordova Command-line Interface for information about the
+current interface.
+
+## Requirements and Support
+
+Apple® tools required to build iOS applications run only on the OS X
+operating system on Intel-based Macs. Xcode® 4.5 (the minimum required
+version) runs only on OS X version 10.7 (Lion) or greater, and
+includes the iOS 6 SDK (Software Development Kit). To submit apps to
+the Apple App Store℠ requires the latest versions of the Apple tools.
+
+You can test many of the Cordova features using the iOS emulator
+installed with the iOS SDK and Xcode, but you need an actual device to
+fully test all of the app's device features before submitting to the
+App Store. The device must have at least iOS 5.x installed, the
+minimum iOS version supported as of Cordova 2.3. Supporting devices
+include all iPad® models, iPhone® 3GS and above, and iPod® Touch 3rd
+Generation or later. To install apps onto a device, you must also be a
+member of Apple's
+[iOS Developer Program](https://developer.apple.com/programs/ios/),
+which costs $99 per year. This guide shows how to deploy apps to the
+iOS emulator, for which you don't need to register with the developer
+program.
+
+## Install the SDK
+
+There are two ways to download Xcode:
+
+* from the [App Store](https://itunes.apple.com/us/app/xcode/id497799835?mt=12),
+ available by searching for "Xcode" in the __App Store__ application.
+
+* from [Apple Developer Downloads](https://developer.apple.com/downloads/index.action),
+ which requires registration as an Apple Developer.
+
+Once Xcode is installed, several command-line tools need to be enabled
+for Cordova to run. From the __Xcode__ menu, select __Preferences__,
+then the __Downloads__ tab. From the __Components__ panel, press the
+__Install__ button next to the __Command Line Tools__ listing.
+
+## Open a Project in the SDK
+
+Use the `cordova` utility to set up a new project, as described in The
+Cordova The Command-line Interface. For example, in a source-code directory:
+
+ $ cordova create hello com.example.hello "Hello World"
+ $ cd hello
+ $ cordova platform add android
+ $ cordova prepare # or "cordova build"
+
+Once created, you can open it from within Xcode. Double-click to open
+the `hello/platforms/ios/hello.xcodeproj` file. The screen should
+look like this:
+
+
+
+## Deploy to Emulator
+
+To preview the app in the iOS emulator:
+
+1. Make sure the _.xcodeproj_ file is selected in the left panel.
+
+2. Select the __hello__ app in the panel immediately to the right.
+
+3. Select the intended device from the toolbar's __Scheme__ menu, such
+ as the iPhone 6.0 Simulator as highlighted here:
+
+ 
+
+4. Press the __Run__ button that appears in the same toolbar to the
+ left of the __Scheme__. That builds, deploys and runs the
+ application in the emulator. A separate emulator application opens
+ to display the app:
+
+ 
+
+ Only one emulator may run at a time, so if you want to test the app
+ in a different emulator, you need to quit the emulator application
+ and run a different target within Xcode.
+
+Xcode comes bundled with emulators for the lastest versions of iPhone
+and iPad. Older versions may be available from the __Xcode →
+Preferences → Downloads → Components__ panel.
+
+## Deploy to Device
+
+For details about various requirements to deploy to a device, refer
+to the _Configuring Development and Distribution Assets_ section of
+Apple's
+[Tools Workflow Guide for iOS](http://developer.apple.com/library/ios/#documentation/Xcode/Conceptual/ios_development_workflow/00-About_the_iOS_Application_Development_Workflow/introduction.html#//apple_ref/doc/uid/TP40007959).
+Briefly, you need to do the following before deploying:
+
+1. Join the Apple iOS Developer Program.
+
+2. Create a _Provisioning Profile_ within the
+ [iOS Provisioning Portal](https://developer.apple.com/ios/manage/overview/index.action).
+ You can use its _Development Provisioning Assistant_ to create and
+ install the profile and certificate Xcode requires.
+
+3. Verify that the _Code Signing_ section's _Code Signing Identity_
+ within the project settings is set to your provisioning profile
+ name.
+
+To deploy to the device:
+
+1. Use the USB cable to plug the device into your Mac.
+
+2. Select the name of the project in the Xcode window's __Scheme__
+ drop-down list.
+
+3. Select your device from the __Device__ drop-down list. If it is
+ plugged in via USB but still does not appear, press the
+ __Organizer__ button to resolve any errors.
+
+4. Press the __Run__ button to build, deploy and run the application
+ on your device.
+
+## Common Problems
+
+__Deprecation Warnings:__ When an application programming interface
+(API) is changed or replaced by another API, it is marked as
+_deprecated_. The API still works in the near term, but is eventually
+removed. Some of these deprecated interfaces are reflected in Apache
+Cordova, and Xcode issues warnings about them when you build and
+deploy an application.
+
+Xcode's warning about the `invokeString` method concerns functionality
+that launches an app from a custom URL. While the mechanism to load
+from a custom URL has changed, this code is still present to provide
+backwards functionality for apps created with older versions of
+Cordova. The sample app does not use this functionality, so these
+warnings can be ignored. To prevent these warnings from appearing,
+remove the code that references the deprecated invokeString API:
+
+* Edit the _Classes/MainViewController.m_ file, surround the following
+ block of code with `/*` and `*/` comments as shown below, then type
+ __Command-s__ to save the file:
+
+ (void)webViewDidFinishLoad:(UIWebView*)theWebView
+ {
+ // only valid if ___PROJECTNAME__-Info.plist specifies a protocol to handle
+ /*
+ if (self.invokeString) {
+ // this is passed before the deviceready event is fired, so you can access it in js when you receive deviceready
+ NSLog(@"DEPRECATED: window.invokeString - use the window.handleOpenURL(url) function instead, which is always called when the app is launched through a custom scheme url.");
+ NSString* jsString = [NSString stringWithFormat:@"var invokeString = \"%@\";", self.invokeString];
+ [theWebView stringByEvaluatingJavaScriptFromString:jsString];
+ }
+ */
+ // Black base color for background matches the native apps
+ theWebView.backgroundColor = [UIColor blackColor];
+
+ return [super webViewDidFinishLoad:theWebView];
+ }
+
+* Edit the _Classes/AppViewDelegate.m_ file, comment out the following
+ line by inserting a double slash as shown below, then type
+ __Command-s__ to save the file:
+
+ //self.viewController.invokeString = invokeString;
+
+* Press __Command-b__ to rebuild the project and eliminate the warnings.
+
+<!-- Does this fix only last until the next "cordova prepare"? -->
+
+__Missing Headers__: Compilation errors relating to missing headers
+result from problems with the build location, and can be fixed
+via Xcode preferences:
+
+1. Select __Xcode → Preferences → Locations__.
+
+2. In the __Derived Data__ section, press the __Advanced__ button and
+ select __Unique__ as the __Build Location__ as shown here:
+
+ 
+
+This is the default setting for a new Xcode install, but it may be set
+differently following an upgrade from an older version of Xcode.
+
+For further information, consult Apple's documentation:
+
+* [Start Developing iOS Apps Today](http://developer.apple.com/library/ios/#referencelibrary/GettingStarted/RoadMapiOS/index.html#//apple_ref/doc/uid/TP40011343) provides a quick overview of steps for developing iOS Apps.
+
+* [Member Center home page](https://developer.apple.com/membercenter/index.action)
+ provides links to several iOS technical resources including
+ technical resources, the provisioning portal, distribution guides
+ and community forums.
+
+* [Tools Workflow Guide for iOS](http://developer.apple.com/library/ios/#documentation/Xcode/Conceptual/ios_development_workflow/00-About_the_iOS_Application_Development_Workflow/introduction.html#//apple_ref/doc/uid/TP40007959)
+
+* [Xcode 4 User Guide](http://developer.apple.com/library/ios/#documentation/ToolsLanguages/Conceptual/Xcode4UserGuide/000-About_Xcode/about.html#//apple_ref/doc/uid/TP40010215)
+
+* [Session Videos](https://developer.apple.com/videos/wwdc/2012/) from
+ the Apple World Wide Developer Conference 2012 (WWDC2012)
+
+* The [xcode-select command](http://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/xcode-select.1.html),
+ which helps specify the correct version of Xcode if more than one is installed.
+
+(Mac®, OS X®, Apple®, Xcode®, App Store℠, iPad®, iPhone®, iPod® and Finder® are Trademarks of Apple Inc.)
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/ios/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/ios/plugin.md b/docs/en/3.0.0rc1/guide/platforms/ios/plugin.md
new file mode 100644
index 0000000..7256de1
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/ios/plugin.md
@@ -0,0 +1,201 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# iOS Plugins
+
+A plugin is an Objective-C class that extends the `CDVPlugin` class.
+
+Each plugin class must be registered using the config.xml file, as a <plugin> tag under the <plugins> key.
+
+## Plugin Class Mapping
+
+The JavaScript portion of a plugin always uses the `cordova.exec` method as follows:
+
+ exec(<successFunction>, <failFunction>, <service>, <action>, [<args>]);
+
+This marshals a request from the `UIWebView` to the iOS native side,
+more or less boiling down to calling the `action` method on the
+`service` class, with the arguments passed in the `args` array.
+
+The plugin must be added under the `<plugins>` tag of your Cordova-iOS
+application's project's `config.xml` file.
+
+ <feature name="LocalStorage">
+ <param name="ios-package" value="CDVLocalStorage" />
+ </feature>
+
+The feature name='name' should match what you use in the JavaScript
+`exec` call, and the value matches the name of the plugin's
+Objective-C class. param name should always be "ios-package".
+Otherwise the plugin may compile but would not be
+reachable by Cordova.
+
+## Plugin Initialization and Lifetime
+
+There is one instance of a plugin object that is created per-UIWebView, and the lifetime of the instance is tied to the UIWebView. Plugins are not instantiated until they are first referenced by a call from JS, unless the `onload` attribute set within config.xml. E.g.:
+
+ <plugin name="Echo" value="Echo" onload="true" />
+
+There is *no* designated initializer for plugins. Instead, plugins should use the `pluginInitialize` method for their start-up logic.
+
+Plugins with long-running requests, background activity (e.g. playing media), listeners or internal state should implement the `onReset` method and stop or clean up those activities. This method is run when the `UIWebView` navigates to a new page or refreshes, which reloads the JavaScript.
+
+## Writing an iOS Cordova Plugin
+
+We have JavaScript fire off a plugin request to the native side. We have the iOS Objective-C plugin mapped properly via the `config.xml` file. So what does the final iOS Objective-C Plugin class look like?
+
+What gets dispatched to the plugin via JavaScript's `exec` function gets passed into the corresponding Plugin class's `action` method. A plugin method has this signature:
+
+ - (void)myMethod:(CDVInvokedUrlCommand*)command
+ {
+ CDVPluginResult* pluginResult = nil;
+ NSString* myarg = [command.arguments objectAtIndex:0];
+
+ if (myarg != nil) {
+ pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK];
+ } else {
+ pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Arg was null"];
+ }
+ [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
+ }
+
+1. [CDVInvokedUrlCommand.h](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVInvokedUrlCommand.h)
+2. [CDVPluginResult.h](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVPluginResult.h)
+3. [CDVCommandDelegate.h](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVCommandDelegate.h)
+
+## iOS CDVPluginResult message types
+
+Using CDVPluginResult you can return a variety of result types back to your JavaScript callbacks, using class methods that look like:
+
+ + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAs...
+
+You can create `String`, `Int`, `Double`, `Bool`, `Array`,
+`Dictionary`, `ArrayBuffer`, and `Multipart` types. Or, don't attach
+any arguments (just send a status). Or, return an Error. You can
+even choose to not send any plugin result at all, in which case the
+callback does not fire.
+
+### Notes
+
+ * `messageAsArrayBuffer` expects `NSData*` and converts to an `ArrayBuffer` for your JavaScript callback (and `ArrayBuffers` sent to a plugin from JavaScript are converted to `NSData*`).
+ * `messageAsMultipart` expects an `NSArray*` containing any of the other supported types, and sends the whole array as the `arguments` to your JavaScript callback.
+ * Quirk: this is not just syntactic sugar (though it is sweet). This way, all of the arguments are serialized or deserialized as necessary. e.g. it is safe to return `NSData*` as multipart, but not as `Array`/`Dictionary`.
+
+## Echo Plugin iOS Plugin
+
+We would add the following to the `<plugins>` tag of the project's `config.xml` file:
+
+ <plugin name="Echo" value="Echo" />
+
+Then we would add the following files (`Echo.h` and `Echo.m`) to the Plugins folder inside our Cordova-iOS
+application folder:
+
+ /********* Echo.h Cordova Plugin Header *******/
+
+ #import <Cordova/CDV.h>
+
+ @interface Echo : CDVPlugin
+
+ - (void)echo:(CDVInvokedUrlCommand*)command;
+
+ @end
+
+ /********* Echo.m Cordova Plugin Implementation *******/
+
+ #import "Echo.h"
+ #import <Cordova/CDV.h>
+
+ @implementation Echo
+
+ - (void)echo:(CDVInvokedUrlCommand*)command
+ {
+ CDVPluginResult* pluginResult = nil;
+ NSString* echo = [command.arguments objectAtIndex:0];
+
+ if (echo != nil && [echo length] > 0) {
+ pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:echo];
+ } else {
+ pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR];
+ }
+
+ [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
+ }
+
+ @end
+
+Let's take a look at the code. At the top we have all of the necessary
+Cordova imports. Our class extends from `CDVPlugin` - very important.
+
+This plugin only supports one action, the `echo` action. First, we
+grab the echo string using the `objectAtIndex` method on our `args`,
+telling it we want to get the 0th parameter in the arguments array. We
+do a bit of parameter checking: make sure it is not `nil`, and make
+sure it is not a zero-length string.
+
+If it is, we return a `PluginResult` with an `ERROR` status. If all of
+those checks pass, then we return a `PluginResult` with an `OK`
+status, and pass in the `echo` string we received in the first place
+as a parameter.
+
+Finally, we send the result to `self.commandDelegate`, which executes
+the `exec` method's success or failure callbacks on the JavaScript
+side. If the success callback is called, it passes in the `echo`
+parameter.
+
+## Threading
+
+Plugin methods are executed in the same thread as the UI. If your
+plugin requires a great deal of processing or requires a blocking
+call, you should use a background thread. For example:
+
+ - (void)myPluginMethod:(CDVInvokedUrlCommand*)command
+ {
+ // Check command.arguments here.
+ [self.commandDelegate runInBackground:^{
+ NSString* payload = nil;
+ // Some blocking logic...
+ CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:payload];
+ // The sendPluginResult method is thread-safe.
+ [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
+ }];
+ }
+
+## Advanced Plugin Functionality
+
+See other methods that you can override in:
+
+1. [CDVPlugin.h](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVPlugin.h)
+2. [CDVPlugin.m](https://github.com/apache/cordova-ios/blob/master/CordovaLib/Classes/CDVPlugin.m)
+
+For example, you can hook into the `pause`, `resume`, app terminate and `handleOpenURL` events.
+
+## Debugging Plugins
+
+To debug the Objective-C side, you would use Xcode's built-in debugger.
+For JavaScript, on iOS 5.0 you can use
+[Weinre, an Apache Cordova Project](https://github.com/apache/cordova-weinre) or
+[iWebInspector, a third-party utility](http://www.iwebinspector.com/)
+
+For iOS 6, you would use Safari 6.0 to simply attach to your app
+running in the iOS 6 Simulator.
+
+## Common Pitfalls
+
+* Don't forget to add your plugin's mapping to config.xml. If you forget, an error is logged in the Xcode console.
+* Don't forget to add any hosts you connect to in the whitelist, as described in Domain Whitelist Guide. If you forget, an error is logged in the Xcode console.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/ios/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/ios/tools.md b/docs/en/3.0.0rc1/guide/platforms/ios/tools.md
new file mode 100644
index 0000000..c37dbcd
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/ios/tools.md
@@ -0,0 +1,59 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# iOS Command-line Tools
+
+The `cordova` command-line utility is a high-level tool that allows
+you to build applications across several platforms at once. An older
+version of the Cordova framework provides sets of command-line tools
+specific to each platform. To use them as an alternative to the CLI,
+you need to download this version of Cordova from
+[cordova.apache.org](http://cordova.apache.org). The download contains
+separate archives for each platform. Expand the platform you wish to
+target. The tools described here are typically available in the
+top-level `bin` directory, otherwise consult the __README__ file for
+more detailed directions.
+
+The iOS command-line tools are built upon shell scripts and rely on
+Xcode command-line tools such as `xcode-select` and `xcodebuild`.
+
+## Create a project
+
+Run the `create` command, specifying the existing path to the project,
+the reverse-domain-style package identifier, and the app's display
+name.
+
+ $ ./path/to/cordova-ios/bin/create /path/to/my_new_project com.example.project_name ProjectName
+
+## Build a project
+
+ $ /path/to/my_new_project/cordova/build
+
+## Run app on emulator
+
+ $ /path/to/my_new_project/cordova/run
+
+## Releasing
+
+ $ /path/to/my_new_project/cordova/release
+
+## Logging
+
+ $ /path/to/my_new_project/cordova/log
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/ios/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/ios/upgrading.md b/docs/en/3.0.0rc1/guide/platforms/ios/upgrading.md
new file mode 100644
index 0000000..0a8330f
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/ios/upgrading.md
@@ -0,0 +1,473 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Upgrading iOS
+
+This guide shows how to modify iOS projects to upgrade from older versions of Cordova.
+Most of these instructions apply to projects created with an older set
+of command-line tools that precede the `cordova` CLI utility. See The
+Cordova Command-line Interface for information how to update the
+version of the CLI.
+
+Please note that **Xcode 4.5 is required**. To submit to the Apple App Store, you must use the latest shipped version of the iOS SDK, which is iOS 6. The iOS 6 SDK requires Xcode 4.5.
+
+## Upgrade to the CLI (3.0.0) from 2.9.0 ##
+
+1. Create a new Apache Cordova 3.0.0 project using the cordova CLI, as
+ described in The Cordova Command-line Interface.
+2. Add your platforms the the cordova project, for example: `cordova
+ platform add ios`.
+3. Copy the contents of the project's `www` folder to the `www` folder
+ at the root of the cordova project you just created.
+4. Copy or overwrite any native assets from your original project
+ (`Resources`, etc.), making sure to add any
+ new files to the `.xcodeproj` project. The iOS project builds
+ inside the `platforms\ios` directory.
+5. Copy your config.xml into the www folder, and remove any plugin definitions. You will modify settings here instead of the platform folder.
+6. Use the cordova CLI tool to install any plugins you need. Note that
+ the CLI handles all core APIs as plugins, so they may need to be
+ added. Only 3.0.0 plugins are compatible with the CLI.
+7. Build and test.
+
+
+## Upgrading 2.9.0 projects to 3.0.0 ##
+
+1. **Download and extract the Cordova 3.0.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-3.0.0)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+5. **Copy** the **www/cordova.js** (note that it does not have a version suffix anymore, the version is in the file itself in the header) file from the new project into your **www** folder, and delete your **www/cordova.js** file
+6. **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.js** file
+7. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder
+
+NOTE: Starting with Cordova 3.0.0, projects do not come with any plugins, you will have to install the ones you require for your project using the `plugman` CLI utility - see the "Using Plugman to Manage Plugins".
+
+## Upgrading 2.8.0 projects to 2.9.0 ##
+
+1. **Download and extract the Cordova 2.9.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.9.0)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+5. **Copy** the **www/cordova.js** (note that it does not have a version suffix anymore, the version is in the file itself in the header) file from the new project into your **www** folder, and delete your **www/cordova.js** file
+6. **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.js** file
+7. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder
+
+## Upgrading 2.7.0 projects to 2.8.0 ##
+
+1. **Download and extract the Cordova 2.8.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.8.0)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+5. **Copy** the **www/cordova.js** (note that it does not have a version suffix anymore, the version is in the file itself in the header) file from the new project into your **www** folder, and delete your **www/cordova-2.7.0.js** file
+6. **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.js** file
+7. Update any <plugin> tags that are in your **config.xml** to <feature> tags. Note that existing <plugin> tags will still work, but are deprecated. You can copy this information in the **config.xml** for a new project. For example:
+
+ <plugins>
+ <plugin name="LocalStorage" value="CDVLocalStorage" />
+ <!-- other plugins -->
+ </plugins>
+
+ <!-- change to: (note that a <feature> tag is on the same level as <plugins> -->
+ <feature name="LocalStorage">
+ <param name="ios-package" value="CDVLocalStorage" />
+ </feature>
+ <!-- other <feature> tags -->
+
+8. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder
+9. Add these two frameworks to your project:
+
+ OpenAL
+ ImageIO
+
+10. Update your project's target **Build Settings**. Under **Linking** -> **Other Linker Flags**, edit **"-Obj-C"** to be **"-ObjC"**
+
+11. Update your project's target **Build Settings**. Under **Linking** -> **Other Linker Flags**, change **"-all\_load"** to be **"-force\_load ${BUILT\_PRODUCTS\_DIR}/libCordova.a"**. You would only need to do this if you have the problem defined in [this issue.](https://issues.apache.org/jira/browse/CB-3458)
+
+## Upgrading 2.6.0 projects to 2.7.0 ##
+
+1. **Download and extract the Cordova 2.7.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.7.0)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+4. **Create a new project**, as described in iOS Command-line Tools. you need the assets from this new project.
+5. **Copy** the **www/cordova-2.7.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.6.0.js** file
+6. **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-2.7.0.js** file
+7. Update (or replace, if you never changed the file) your **AppDelegate.m** file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=5c05ac80e056753c0e8736f887ba9f28d5b0774c;hp=623ad8ec3c46f656ea18c6c3a190d650dd64e479;hb=c6e71147386d4ad94b07428952d1aae0a9cbf3f5;hpb=c017fda8af00375a453cf27cfc488647972e9a23))
+8. In your **config.xml** file, [remove this line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=537705d76a5ef6bc5e57a8ebfcab78c02bb4110b;hp=8889726d9a8f8c530fe1371c56d858c34552992a;hb=064239b7b5fa9a867144cf1ee8b2fb798ce1f988;hpb=c9f233250d4b800f3412eeded811daaafb17b2cc).
+9. Delete your **"CordovaLib"** folder, and copy the **"CordovaLib"** folder from the new project into your project's root folder
+
+## Upgrading 2.5.0 projects to 2.6.0 ##
+
+1. **Download and extract the Cordova 2.6.0 source** to a **permanent folder location** on your hard drive (say to `~/Documents/Cordova-2.6.0`)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+5. **Copy** the project's `www/cordova-2.6.0.js` file into your `www` folder, and delete your `www/cordova-2.5.0.js` file.
+6. **Update** the Cordova script reference in your `www/index.html` file (along with any other files that reference the script) to refer to the new `cordova-2.6.0.js` file.
+7. Update (or replace, if you never changed the file) your `AppDelegate.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=124a56bb4f361e95616f44d6d6f5a96ffa439b60;hp=318f79326176be8f16ebc93bad85dd745f4205b6;hb=a28c7712810a63396e9f32fa4eb94fe3f8b93985;hpb=36acdf55e4cab52802d73764c8a4b5b42cf18ef9))
+8. In your `config.xml` file, [add this new line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=1555b5e81de326a07efe0bccaa5f5e2326b07a9a;hp=0652d60f8d35ac13c825c572dca6ed01fea4a540;hb=95f16a6dc252db0299b8e2bb53797995b1e39aa1;hpb=a2de90b8f5f5f68bd9520bcbbb9afa3ac409b96d).
+9. In your `config.xml` file, [add this new line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=d307827b7e67301171a913417fb10003d43ce39d;hp=04260aa9786d6d74ab20a07c86d7e8b34e31968c;hb=97b89edfae3527828c0ca6bb2f6d58d9ded95188;hpb=942d33c8e7174a5766029ea1232ba2e0df745c3f).
+10. In your `config.xml` file, [UIWebViewBounce has ben changed to DisallowOverscroll - and default values are different](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=8889726d9a8f8c530fe1371c56d858c34552992a;hp=d307827b7e67301171a913417fb10003d43ce39d;hb=57982de638a4dce6ae130a26662591741b065f00;hpb=ec411f18309d577b4debefd9a2f085ba719701d5).
+10. In your `config.xml` file, the **EnableLocation** preference has been **deprecated**.
+11. Delete your `CordovaLib` folder, and copy the `CordovaLib` folder from the new project into your project's root folder.
+
+## Upgrading 2.4.0 projects to 2.5.0 ##
+
+1. **Download and extract the Cordova 2.5.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.5.0)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+5. **Copy** the **www/cordova-2.5.0.js** file from the new project into your **www** folder and delete your **www/cordova-2.4.0.js** file
+6. **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-2.5.0.js** file
+7. Update (or replace, if you never changed the file) your `AppDelegate.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=318f79326176be8f16ebc93bad85dd745f4205b6;hp=6dc7bfc84f0ecede4cc43d2a3256ef7c5383b9fe;hb=4001ae13fcb1fcbe73168327630fbc0ce44703d0;hpb=299a324e8c30065fc4511c1fe59c6515d4842f09))
+8. In your `config.xml` file, [add these new lines](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=903944c4b1e58575295c820e154be2f5f09e6314;hp=721c734120b13004a4a543ee25f4287e541f34be;hb=ae467249b4a256bd31ee89aea7a06f4f2316b8ac;hpb=9e39f7ef8096fb15b38121ab0e245a3a958d9cbb).
+9. In your `config.xml` file, [edit the root element, change it from cordova to widget](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=64e71636f5dd79fa0978a97b9ff5aa3860a493f5;hp=d8579352dfb21c14e5748e09b2cf3f4396450163;hb=0e711f8d09377a7ac10ff6be4ec17d22cdbee88d;hpb=57c3c082ed9be41c0588d0d63a1d2bfcd2ed878c).
+10. In your `config.xml` file, [remove the OpenAllWhitelistURLsInWebView preference](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=721c734120b13004a4a543ee25f4287e541f34be;hp=7d67508b70914aa921a16e79f79c00512502a8b6;hb=187bf21b308551bfb4b98b1a5e11edf04f699791;hpb=03b8854bdf039bcefbe0212db937abd81ac675e4).
+11. Delete your **cordova** folder, and copy the **cordova** folder from the new project into your project's root folder **(in 2.5.0, this has updated scripts)**
+12. Delete your **CordovaLib** folder, and copy the **CordovaLib** folder from the new project into your project's root folder
+
+## Upgrading 2.3.0 projects to 2.4.0 ##
+
+1. **Download and extract the Cordova 2.4.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.4.0)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+5. **Copy** the **www/cordova-2.4.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.3.0.js** file
+6. **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-2.4.0.js** file
+7. Update (or replace, if you never changed the files) your `MainViewController.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/MainViewController.m;h=5f9eeac15c2437cd02a6eb5835b48374e9b94100;hp=89da1082d06ba5e5d0dffc5b2e75a3a06d5c2aa6;hb=b4a2e4ae0445ba7aec788090dce9b822d67edfd8;hpb=a484850f4610e73c7b20cd429a7794ba829ec997)).
+8. Update (or replace, if you never changed the file) your `AppDelegate.m` file according to the one from the new project (see [this diff](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/Classes/AppDelegate.m;h=6dc7bfc84f0ecede4cc43d2a3256ef7c5383b9fe;hp=1ca3dafeb354c4442b7e149da4f281675aa6b740;hb=6749c17640c5fed8a7d3a0b9cca204b89a855baa;hpb=deabeeb6fcb35bac9360b053c8bf902b45e6de4d))
+9. In your `config.xml` file, [add this new line](https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=blobdiff;f=bin/templates/project/__TESTING__/config.xml;h=7d67508b70914aa921a16e79f79c00512502a8b6;hp=337d38da6f40c7432b0bce05aa3281d797eec40a;hb=6749c17640c5fed8a7d3a0b9cca204b89a855baa;hpb=deabeeb6fcb35bac9360b053c8bf902b45e6de4d).
+10. Delete your **cordova** folder, and copy the **cordova** folder from the new project into your project's root folder **(in 2.4.0, this has fixed scripts)**
+11. Delete your **CordovaLib** folder, and copy the **CordovaLib** folder from the new project into your project's root folder
+12. Add AssetsLibrary.framework as a resource to your project. (Go [here](https://developer.apple.com/library/ios/#recipes/xcode_help-project_editor/Articles/AddingaLibrarytoaTarget.html) for instructions on how to do so.)
+
+## Upgrading 2.2.0 projects to 2.3.0 ##
+
+1. **Download and extract the Cordova 2.3.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.3.0)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+5. **Copy** the **www/cordova-2.3.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.2.0.js** file
+6. **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-2.3.0.js** file
+7. Update (or replace, if you never changed the file) your `MainViewController.m` according to the one from the new project.
+8. Delete your **cordova** folder, and copy the **cordova** folder from the new project into your project's root folder **(in 2.3.0, this has new scripts)**
+9. Delete your **CordovaLib** folder, and copy the **CordovaLib** folder from the new project into your project's root folder
+10. Convert your `Cordova.plist` file to `config.xml`, by running the script **bin/cordova\_plist\_to\_config\_xml** on your project file.
+11. Add the InAppBrowser plugin to your `config.xml`, by adding this tag under **<cordova><plugins>**:
+
+ <plugin name="InAppBrowser" value="CDVInAppBrowser" />
+12. Note that Objective-C plugins are **not** whitelisted anymore. To whitelist your connections with the app whitelist, you will need to set the “User-Agent” header of the connection to the same user-agent as the main Cordova WebView.
+You can get this by accessing the **userAgent** property off the main view-controller. The main view-controller (CDVViewController) also has a **URLisAllowed** method for you to check whether a URL will pass the whitelist.
+13. Device API changes:
+ * For iOS, device.platform used to return “iPhone”, “iPad” or “iPod Touch” — now it returns (correctly) “iOS”.
+ * For iOS, device.name (now deprecated for all platforms) used to return the name of the user’s device (e.g ‘Shazron’s iPhone 5′) — now it returns what device.platform used to return: ”iPhone”, “iPad” or “iPod Touch”.
+ * For all platforms, there is a new property called device.model — this returns the specific device model, e.g “iPad2,5″ (for other platforms, this returns what device.name used to return).
+
+## Upgrading 2.1.0 projects to 2.2.0 ##
+
+1. **Download and extract the Cordova 2.2.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.2.0)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+4. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+5. **Copy** the **www/cordova-2.2.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.1.0.js** file
+6. **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-2.2.0.js** file
+7. Update (or replace, if you never changed the file) your `MainViewController.m` according to the one from the new project:
+ - Updated → viewWillAppear
+8. Copy the **cordova** folder from the new project into your project's root folder **(in 2.2.0, this has an updated 'emulate' script)**
+9. Next, update your CordovaLib sub-project reference. Beginning with Cordova 2.1.0, we are not using the CORDOVALIB Xcode variable anymore when referencing where CordovaLib resides, the reference is an absolute file reference now.
+ 1. Launch **Terminal.app**
+ 2. Go to the location where you installed Cordova (see Step 1), in the **bin** sub-folder
+ 3. Run the script below where the first parameter is the path to your project's **.xcodeproj** file:
+
+ `update_cordova_subproject path/to/your/project/xcodeproj`
+
+__NOTE:__ In 2.2.0, the `bin/create` script copy in the CordovaLib sub-project into your project. To have the same kind of setup, just copy in the right CordovaLib into your project folder, and update the CordovaLib sub-project location (relative to the project) in the Xcode File Inspector.
+
+## Upgrading 2.0.0 projects to 2.1.0 ##
+
+With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit → Refactor → Convert to Objective-C ARC...**, **de-select libCordova.a**, then run the wizard to completion.
+
+1. **Download and extract the Cordova 2.1.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.1.0)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+5. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+6. **Copy** the **www/cordova-2.1.0.js** file from the new project into your **www** folder, and delete your **www/cordova-2.0.0.js** file
+7. **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-2.1.0.js** file
+8. Update (or replace, if you never changed the file) your `AppDelegate.m` according to the one from the new project:
+ - Edited -> application:didFinishLaunchingWithOptions:
+ - Added -> application:supportedInterfaceOrientationsForWindow:
+9. Update (or replace, if you never changed the file) your `MainViewController.m` according to the one from the new project:
+ - Added -> viewWillAppear
+10. Copy the **cordova** folder from the new project into your project's root folder **(in 2.1.0, this has the updated scripts to support paths with spaces)**
+11. Remove the **VERSION** file reference from your **project** (_not_ the one in CordovaLib)
+12. Next, update your CordovaLib sub-project reference. Beginning with Cordova 2.1.0, we are not using the CORDOVALIB Xcode variable anymore when referencing where CordovaLib resides, the reference is an absolute file reference now.
+ 1. Launch **Terminal.app**
+ 2. Go to the location where you installed Cordova **(see Step 1)**, in the **bin** sub-folder
+ 3. Run the script below where the first parameter is the path to your project's **.xcodeproj** file:
+
+ `update_cordova_subproject path/to/your/project/xcodeproj`
+
+## Upgrading 1.9.0 projects to 2.0.0 ##
+
+1. **Install** Cordova 2.0.0
+2. **Create a new project**, as described in iOS Command-line Tools. You need the assets from this new project.
+3. **Copy** the **www/cordova-2.0.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.9.0.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-2.0.0.js** file
+5. Copy the **cordova** folder from the new project into your project's root folder (if you want the project command-line tools)
+6. **Add** a new entry under **Plugins** in your `Cordova.plist` file (under the **Supporting Files** group) - the key is **Device** and the value is **CDVDevice**
+7. Remove `Cordova.framework`
+8. Remove `verify.sh` from the **Supporting Files** group
+9. Select the **project icon** in the Project Navigator, select your project **Target**, then select the **Build Settings** tab
+10. Search for **Preprocessor Macros**, then remove all **CORDOVA_FRAMEWORK=1** values
+11. Locate the **CordovaLib** folder that was installed in your hard-drive under your home folder's **Documents** sub-folder.
+12. Locate the `CordovaLib.xcodeproj` file in the **CordovaLib** folder, then **drag and drop** the file into your project - it should appear as a **sub-project**.
+13. **Build** your project, you should get some **errors** relating to **#import** directives
+14. For the **#import errors**, change any **quote-based** imports in this style:
+
+ #import "CDV.h"
+
+ to this **brackets-based** style:
+
+ #import <Cordova/CDV.h>
+
+ and remove any **#ifdef** wrappers around any Cordova imports, they are not needed anymore (the imports are **unified** now)
+15. **Build** your project again, and it should not have any **#import** errors.
+16. Select the **project icon** in the Project Navigator, select your project **Target**, then select the **Build Phases** tab
+17. Expand the **Target Dependencies** phase, then select the **+** button
+18. Select the **CordovaLib** target, then select the **Add** button
+19. Expand the **first** **Link Binary with Libraries** phase (it should already contain a bunch of frameworks), then select the **+** button
+20. Select the `libCordova.a` static library, then select the **Add** button
+21. Delete the **Run Script** phase.
+22. Select the **project icon** in the Project Navigator, select your project **Target**, then select the **Build Settings** tab
+23. Search for **Other Linker Flags**, and add the values **-all_load** and **-Obj-C**
+24. Expand the **CordovaLib** sub-project.
+25. Locate the **VERSION** file, drag it into your main project (we want to create a link to it, not a copy)
+26. Select the **Create groups for any added folders** radiobutton, then select the **Finish** button
+27. Select the **VERSION** file that you just dragged in a previous step
+28. Type the **Option-Command-1** key combination to show the **File Inspector** (or menuitem **View -> Utilities -> Show File Inspector**)
+29. Choose **Relative to CORDOVALIB** in the **File Inspector** for the drop-down menu for **Location**
+30. Set the Xcode preference **Xcode Preferences -> Locations -> Derived Data -> Advanced...** to **Unique** (this is so the unified headers can be found)
+31. Select the **project icon** in the Project Navigator, select your **Target**, then select the **Build Settings** tab
+32. Search for **Header Search Paths**. For that setting, add these three values below (with quotes):
+
+ "$(TARGET_BUILD_DIR)/usr/local/lib/include"
+
+ "$(OBJROOT)/UninstalledProducts/include"
+
+ "$(BUILT_PRODUCTS_DIR)"
+
+33. Search for **Other Linker Flags**. For that setting, add this value below:
+
+ -weak_framework CoreFoundation
+
+34. **Build** your project, it should compile and link with **no issues**.
+35. **Select your project** from the **Scheme** drop-down, and then select **iPhone 5.1 Simulator**
+36. Select the **Run** button
+
+__NOTE:__ If your project is **not working** as expected in the Simulator, please **take a note of any errors** in the **console log in Xcode** for clues.
+
+## Upgrading 1.8.x projects to 1.9.0 ##
+
+1. **Install** Cordova 1.9.0
+2. **Create a new project** - you will have to grab assets from this new project
+3. **Copy** the **www/cordova-1.9.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.8.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.9.0.js** file
+
+__NOTE:__ 1.9.0 supports the new **BackupWebStorage** boolean `Cordova.plist` setting. It's enabled by default, so set it to
+`false` to disable it, especially on iOS 6. See [Release Notes - Safari and UIKit Section](https://developer.apple.com/library/prerelease/ios/#releasenotes/General/RN-iOSSDK-6_0/_index.html)
+
+## Upgrading 1.7.0 projects to 1.8.x ##
+
+1. **Install** Cordova 1.8.0
+2. **Create a new project** - you will have to grab assets from this new project
+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:
+
+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 your Project Navigator in Xcode, type the **Delete** key, then select **Remove Reference** from the resulting dialog.
+3. Drag the new `Capture.bundle` from Step 1 above into your Project Navigator in Xcode, then select the **Create groups for any added folders** radio button
+
+## Upgrading 1.6.x projects to 1.7.0 ##
+
+1. **Install** Cordova 1.7.0
+2. **Create a new project** - you will have to grab assets from this new project
+3. **Copy** the **www/cordova-1.7.0.js** file from the new project into your **www** folder, and delete your **www/cordova-1.6.0.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.7.0.js** file
+
+## Upgrading 1.5.0 projects to 1.6.x ##
+
+1. **Install** Cordova 1.6.1
+2. **Make a backup** of `AppDelegate.m`, `AppDelegate.h`, `MainViewController.m`, `MainViewController.h`, and `Cordova.plist` in your project
+3. **Create a new project** - you will have to grab assets from this new project
+4. **Copy** these files from the **new** project into your 1.5.0-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+
+ AppDelegate.h
+ AppDelegate.m
+ MainViewController.h
+ MainViewController.m
+ Cordova.plist
+5. **Add** all the new **MainViewController** and **AppDelegate** files into your Xcode project
+6. **Copy** the **www/cordova-1.6.1.js** file from the new project into your **www** folder, and delete your **www/cordova-1.5.0.js** file
+7. **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.6.1.js** file
+8. **Add** the new `Cordova.plist` file into your project - this is because the core plugin service names needed to be changed to match the ones from Android and BlackBerry, for a unified Cordova JavaScript file (cordova-js).
+9. **Integrate** any settings, **Plugins** and **ExternalHosts** entries that you had in your **backed-up Cordova.plist** into the new `Cordova.plist`
+10. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files. Any **UIWebViewDelegate** or **CDVCommandDelegate** code in `AppDelegate.m` will need to go into MainViewController.m now (see commented out sections in that file)
+11. **Integrate** any project-specific code that you have in your **backed-up MainViewController.h and MainViewController.m** into the new MainViewController files
+12. Click on the **project icon** in the Project Navigator, select your **Project**, then select the **Build Settings** tab
+13. Enter **Compiler for C/C++/Objective-C** in the search field
+14. Select the **Apple LLVM Compiler 3.1** value
+
+## Upgrading 1.4.x projects to 1.5.0 ##
+
+1. **Install** Cordova 1.5.0
+2. **Create a new project** and run it once - you will have to grab assets from this new project
+3. **Copy** the **www/cordova-1.5.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.4.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 **cordova-1.5.0.js** file
+5. Find `PhoneGap.framework` in your Project Navigator, select it
+6. Type the **Delete** key and delete the `PhoneGap.framework` reference in the Project Navigator
+7. Type the **Option-Command-A** key combination, which should drop down a sheet to add files to your project (the **Add Files...** sheet). Make sure the **Created groups for any added folders** radio button is selected
+8. Type the **Shift-Command-G** key combination, which should drop down another sheet for you to go to a folder (the **Go to the folder:** sheet)
+9. Enter **/Users/Shared/Cordova/Frameworks/Cordova.framework** in the **Go to the folder:** sheet and then press the **Go** button
+10. Press the **Add** button in the **Add Files...** sheet
+11. Select `Cordova.framework` in the Project Navigator
+12. Type the **Option-Command-1** key combination to show the **File Inspector**
+13. Choose **Absolute Path** in the **File Inspector** for the drop-down menu for **Location**
+14. Type the **Option-Command-A** key combination, which should drop down a sheet to add files to your project (the **Add Files...** sheet). Make sure the **Created groups for any added folders** radio button is selected
+15. Type the **Shift-Command-G** key combination, which should drop down another sheet for you to go to a folder (the **Go to the folder:** sheet)
+16. Enter **~/Documents/CordovaLib/Classes/deprecated** in the **Go to the folder:** sheet and then press the **Go** button
+17. Press the **Add** button in the **Add Files...** sheet
+18. In your **AppDelegate.h, AppDelegate.m, and MainViewController.h** files - replace the whole **#ifdef PHONEGAP_FRAMEWORK** block with:
+
+ #import "CDVDeprecated.h"
+19. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **Build Settings** tab
+20. Search for **Framework Search Paths**
+21. Replace the existing value with **/Users/Shared/Cordova/Frameworks**
+22. Search for **Preprocessor Macros**
+23. For the first (combined) value, replace the value with **CORDOVA_FRAMEWORK=YES**
+24. Select the **Build Phases** tab
+25. Expand **Run Script**
+26. Replace any occurrences of **PhoneGap** with **Cordova**
+27. Find your `PhoneGap.plist` file in the Project Navigator, and click on the filename once to enter name edit mode
+28. Rename `PhoneGap.plist` to `Cordova.plist`
+29. Right-click on `Cordova.plist` and choose **Open As --> Source Code**
+30. Press **Option-Command-F**, choose **Replace** from the drop-down on the top left of the Source window
+31. Enter `com.phonegap` for the Find string, and `org.apache.cordova` for the Replace string - then press the **Replace All** button
+32. Enter **PG** for the Find string, and **CDV** for the Replace string - then press the **Replace All** button
+33. Press **Command-B** to build, you will still have deprecations that you can get rid of in the future (see `CDVDeprecated.h` - replace classes in your code that use PG* to CDV*, for example)
+
+## Upgrading 1.4.0 projects to 1.4.1 ##
+
+1. **Install** Cordova 1.4.1
+2. **Make a backup** of `MainViewController.m`
+3. **Create a new project** - you will have to grab assets from this new project
+4. **Copy** the `MainViewController.m` file from the **new** project into your 1.4.0-based project folder on disk, **replacing** the old file (**backup** your files first from step 2 above).
+5. **Add** the `MainViewController.m` file into your Xcode project
+6. **Integrate** any project-specific code that you have in your backed-up `MainViewController.m` into the new file
+7. Updating the `phonegap-1.4.0.js` file is optional, nothing has changed in the JavaScript between 1.4.0 and 1.4.1
+
+## Upgrading 1.3.0 projects to 1.4.0 ##
+
+1. **Install** Cordova 1.4.0
+2. **Make a backup** of `AppDelegate.m` and `AppDelegate.h` in your project
+3. **Create a new project** - you will have to grab assets from this new project
+4. **Copy** these files from the **new** project into your 1.3.0-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+
+ AppDelegate.h
+ AppDelegate.m
+ MainViewController.h
+ MainViewController.m
+ MainViewController.xib
+5. **Add** all the **MainViewController** files into your Xcode project
+6. **Copy** the **www/phonegap-1.4.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.3.0.js** file
+7. **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 **phonegap-1.4.0.js** file
+8. **Add** a new entry under **Plugins** in your `PhoneGap.plist` file - key is `com.phonegap.battery` and the value is **PGBattery**
+9. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files
+
+## Upgrading 1.2.0 projects to 1.3.0 ##
+
+1. **Install** Cordova 1.3.0
+2. **Make a backup** of `AppDelegate.m` and `AppDelegate.h` in your project
+3. **Create a new project** - you will have to grab assets from this new project
+4. **Copy** these files from the **new** project into your 1.2.0-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+
+ AppDelegate.h
+ AppDelegate.m
+ MainViewController.h
+ MainViewController.m
+ MainViewController.xib
+5. **Add** all the **MainViewController** files into your Xcode project
+6. **Copy** the **www/phonegap-1.3.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.2.0.js** file
+7. **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 **phonegap-1.3.0.js** file
+8. **Add** a new entry under **Plugins** in your `PhoneGap.plist` file - key is `com.phonegap.battery` and the value is **PGBattery**
+9. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files
+
+## Upgrading 1.1.0 projects to 1.2.0 ##
+
+1. **Install** Cordova 1.2.0
+2. **Make a backup** of `AppDelegate.m` and `AppDelegate.h` in your project
+3. **Create a new project** - you will have to grab assets from this new project
+4. **Copy** these files from the **new** project into your 1.1.0-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+
+ AppDelegate.h
+ AppDelegate.m
+ MainViewController.h
+ MainViewController.m
+ MainViewController.xib
+5. **Add** all the **MainViewController** files into your Xcode project
+6. **Copy** the **www/phonegap-1.2.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.1.0.js** file
+7. **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 **phonegap-1.2.0.js** file
+8. **Add** a new entry under **Plugins** in your `PhoneGap.plist` file - key is `com.phonegap.battery` and the value is **PGBattery**
+9. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files
+
+## Upgrading 1.0.0 projects to 1.1.0 ##
+
+1. **Install** Cordova 1.1.0
+2. **Make a backup** of `AppDelegate.m` and `AppDelegate.h` in your project
+3. **Create a new project** - you will have to grab assets from this new project
+4. **Copy** these files from the **new** project into your 1.0.0-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+
+ AppDelegate.h
+ AppDelegate.m
+ MainViewController.h
+ MainViewController.m
+ MainViewController.xib
+5. **Add** all the **MainViewController** files into your Xcode project
+6. **Copy** the **www/phonegap-1.1.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-1.0.0.js** file
+7. **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 **phonegap-1.1.0.js** file
+8. **Add** a new entry under **Plugins** in your `PhoneGap.plist` file - key is `com.phonegap.battery` and the value is **PGBattery**
+9. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files
+
+## Upgrading 0.9.6 projects to 1.0.0 ##
+
+1. **Install** Cordova 1.0.0
+2. **Make a backup** of `AppDelegate.m` and `AppDelegate.h` in your project
+3. **Create a new project** - you will have to grab assets from this new project
+4. **Copy** these files from the **new** project into your 0.9.6-based project folder on disk, **replacing** any old files (**backup** your files first from step 2 above):
+
+ AppDelegate.h
+ AppDelegate.m
+ MainViewController.h
+ MainViewController.m
+ MainViewController.xib
+5. **Add** all the **MainViewController** files into your Xcode project
+6. **Copy** the **www/phonegap-1.0.0.js** file from the new project into your **www** folder, and delete your **www/phonegap-0.9.6.js** file
+7. **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 **phonegap-1.0.0.js** file
+8. **Add** a new entry under **Plugins** in your `PhoneGap.plist` file - key is `com.phonegap.battery` and the value is **PGBattery**
+9. **Integrate** any project-specific code that you have in your **backed-up AppDelegate.h and AppDelegate.m** into the new AppDelegate files
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/ios/webview.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/ios/webview.md b/docs/en/3.0.0rc1/guide/platforms/ios/webview.md
new file mode 100644
index 0000000..18caa27
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/ios/webview.md
@@ -0,0 +1,131 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# iOS WebViews
+
+Beginning with Cordova 1.4, you can use Cordova as a component in your
+iOS applications. This component is code-named 'Cleaver'.
+
+New Cordova-based applications created using the Xcode template
+provided in Cordova 1.4 or greater use Cleaver. (The template is
+Cleaver's reference implementation.)
+
+Cordova 2.0.0 and subsequent versions only support the sub-project
+based Cleaver implementation.
+
+## Prerequisites
+
+1. **Cordova 2.3.0** or greater
+2. **Xcode 4.5** or greater
+3. `config.xml` file (from a newly created iOS project)
+
+## Adding Cleaver to your Xcode project (CordovaLib sub-project)
+
+1. **Download and extract the Cordova source** to a **permanent folder location** on your hard drive (say to `~/Documents/Cordova`)
+2. **Quit Xcode** if it is running.
+3. **Navigate** to the directory where you put the downloaded source above, using **Terminal.app**.
+4. **Copy** the `config.xml` file into your project folder on disk (see **Prerequisites** above)
+5. **Drag and drop** the `config.xml` file into the Project Navigator of Xcode
+6. **Choose** the **Create groups for any added folders** radio button and press **Finish**
+7. **Drag and drop** the `CordovaLib.xcodeproj` file into the Project Navigator of Xcode (from the permanent folder location above, and it should be in the CordovaLib sub-folder)
+8. Select `CordovaLib.xcodeproj` in the Project Navigator
+9. Type the **Option-Command-1** key combination to show the **File Inspector**
+10. Choose **Relative to Group** in the **File Inspector** for the drop-down menu for **Location**
+11. Select the **project icon** in the Project Navigator, select your **Target**, then select the **Build Settings** tab
+12. Add `-all_load` and `-Obj-C` for the **Other Linker Flags** value
+13. Click on the **project icon** in the Project Navigator, select your **Target**, then select the **Build Phases** tab
+14. Expand **Link Binaries with Libraries**
+15. Select the **+** button, and add these **frameworks** (and optionally in the Project Navigator, **move** them under the Frameworks group):
+
+ AddressBook.framework
+ AddressBookUI.framework
+ AudioToolbox.framework
+ AVFoundation.framework
+ CoreLocation.framework
+ MediaPlayer.framework
+ QuartzCore.framework
+ SystemConfiguration.framework
+ MobileCoreServices.framework
+ CoreMedia.framework
+
+16. Expand **Target Dependencies** - the top box labeled like this if you have multiple boxes!
+17. Select the **+** button, and add the `CordovaLib` build product
+18. Expand **Link Binaries with Libraries** - the top box labeled like
+ this if you have multiple boxes!
+19. Select the **+** button, and add `libCordova.a`
+20. Set the Xcode preference **Xcode Preferences → Locations → Derived Data → Advanced...** to **Unique**
+21. Select the **project icon** in the Project Navigator, select your **Target**, then select the **Build Settings** tab
+22. Search for **Header Search Paths**. For that setting, add these three values below (with quotes):
+
+ "$(TARGET_BUILD_DIR)/usr/local/lib/include"
+ "$(OBJROOT)/UninstalledProducts/include"
+ "$(BUILT_PRODUCTS_DIR)"
+
+ With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit → Refactor → Convert to Objective-C ARC...**, **de-select libCordova.a**, then run the wizard to completion.
+
+## Using CDVViewController in your code
+
+1. Add this **header**:
+
+ #import <Cordova/CDVViewController.h>
+
+2. Instantiate a **new** `CDVViewController`, and **retain it somewhere** (e.g. to a property in your class):
+
+ CDVViewController* viewController = [CDVViewController new];
+
+3. (_OPTIONAL_) Set the `wwwFolderName` property (defaults to `www`):
+
+ viewController.wwwFolderName = @"myfolder";
+
+4. (_OPTIONAL_) Set the start page in your config.xml, the `<content>` tag.
+
+ <content src="index.html" />
+
+ OR
+
+ <content src="http://apache.org" />
+
+5. (_OPTIONAL_) Set the `useSplashScreen` property (defaults to `NO`):
+
+ viewController.useSplashScreen = YES;
+
+6. Set the **view frame** (always set this as the last property):
+
+ viewController.view.frame = CGRectMake(0, 0, 320, 480);
+
+7. **Add** Cleaver to your view:
+
+ [myView addSubview:viewController.view];
+
+## Adding your HTML, CSS and JavaScript assets
+
+1. Create a **new folder** in your project **on disk**, `www` for example.
+2. Put your **HTML, CSS and JavaScript** assets into this folder.
+3. **Drag and drop** the folder into the Project Navigator of Xcode.
+4. **Choose** the **Create folder references for any added folders** radio button.
+5. **Set the appropriate `wwwFolderName` and `startPage` properties** for the folder you created in **(1)** or use the defaults (see previous section) when you instantiate the `CDVViewController`.
+
+ /*
+ if you created a folder called 'myfolder' and
+ you want the file 'mypage.html' in it to be
+ the startPage
+ */
+ viewController.wwwFolderName = @"myfolder";
+ viewController.startPage = @"mypage.html"
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/platforms/tizen/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/guide/platforms/tizen/index.md b/docs/en/3.0.0rc1/guide/platforms/tizen/index.md
new file mode 100644
index 0000000..47130f0
--- /dev/null
+++ b/docs/en/3.0.0rc1/guide/platforms/tizen/index.md
@@ -0,0 +1,112 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Tizen Platform Guide
+
+This guide describes how to set up your SDK development environment to
+deploy Cordova apps for devices running the Tizen operating system.
+
+## Requirements and Support
+
+The Tizen SDK requires Linux Ubuntu 10.04/10.10/11.04/11.10 (32-bit),
+or Windows XP SP3/7 (32-bit).
+
+Developers should use the `cordova` utility in conjunction with
+the Tizen SDK. See The Command-line Interface for information
+how to install it, add projects, then build and deploy a project.
+
+## Install the SDK
+
+Download the Tizen SDK from
+[tizen.org](https://developer.tizen.org/sdk).
+
+<!--
+
+- (optional) Install Tizen Cordova template projects: copy the
+ `/templates` directory content into the Tizen Eclipse IDE web
+ templates directory (e.g:
+ `/home/my_username/tizen-sdk/IDE/Templates/web`).
+
+- __Method #2: Use Tizen Eclipse IDE Cordova Tizen project templates__
+ - Launch Tizen Eclipse IDE
+ - Select __File → New → Tizen Web Project__
+ - Select __User Template__ and __User defined__ items
+ - Select one of the Tizen Cordova template (e.g: __CordovaBasicTemplate__)
+ - Fill the __Project name__ and its target __Location__
+
+ 
+
+ - Click __Finish__
+
+ 
+
+ - Your project should now appear in the __Project Explorer__ view
+
+-->
+
+## Open a Project in the SDK
+
+1. Launch the Tizen Eclipse IDE.
+2. Select __File → Import → Tizen Web Project__:
+
+ 
+
+3. Press __Next__.
+4. Make sure __Select root directory__ is checked.
+5. Make sure __Copy projects into workspace__ is checked.
+6. Press __Browse__ and select the Cordova Tizen `samples` project directory (such as `/cordova-basic`):
+
+ 
+
+7. Press __Finish__. Your project should now be imported and appear in
+ the __Project Explorer__ view:
+
+ 
+
+To rebuild the project, right-click in the __Project Explorer__ view
+and Select __Build Project__:
+
+
+
+A widget package file such as _hello.wgt_ should generate in the
+project's root directory.
+
+## Deploy to Emulator
+
+Right-click the project in the __Project Explorer__ view and select
+__Run As → Tizen Web Simulator Application__:
+
+
+
+## Deploy to Device
+
+* Make sure that the target device is properly launched, connected and
+ configured. Its __Date and Time__ settings must be set correctly.
+
+* Use the __Connection Explorer__ view to select the application
+ deployment target: __Window → Show View → Connection
+ Explorer__.
+
+ 
+
+* Right-click the project in the __Project Explorer__ view, then
+ select __Run As & rarr; Tizen Web Application__:
+
+ 
+
[12/12] docs commit: Version 3.0.0rc1
Posted by mw...@apache.org.
Version 3.0.0rc1
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/17ffa3e5
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/17ffa3e5
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/17ffa3e5
Branch: refs/heads/master
Commit: 17ffa3e527678e1ee21860d72352d815acef0fa9
Parents: 8f78f9c
Author: Michael Brooks <mi...@michaelbrooks.ca>
Authored: Thu Jul 18 12:26:52 2013 -0700
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Thu Jul 18 12:26:52 2013 -0700
----------------------------------------------------------------------
VERSION | 2 +-
docs/en/3.0.0rc1/config.json | 200 ++++++++
.../accelerometer/acceleration/acceleration.md | 109 ++++
.../accelerometer/accelerometer.clearWatch.md | 114 +++++
.../accelerometer.getCurrentAcceleration.md | 112 +++++
.../cordova/accelerometer/accelerometer.md | 82 +++
.../accelerometer.watchAcceleration.md | 147 ++++++
.../parameters/accelerometerError.md | 27 +
.../parameters/accelerometerOptions.md | 28 ++
.../parameters/accelerometerSuccess.md | 42 ++
.../3.0.0rc1/cordova/camera/camera.cleanup.md | 52 ++
.../cordova/camera/camera.getPicture.md | 246 +++++++++
docs/en/3.0.0rc1/cordova/camera/camera.md | 84 ++++
.../camera/parameter/CameraPopoverHandle.md | 68 +++
.../camera/parameter/CameraPopoverOptions.md | 80 +++
.../cordova/camera/parameter/cameraError.md | 32 ++
.../cordova/camera/parameter/cameraOptions.md | 120 +++++
.../cordova/camera/parameter/cameraSuccess.md | 42 ++
.../cordova/compass/compass.clearWatch.md | 110 ++++
.../cordova/compass/compass.clearWatchFilter.md | 23 +
.../compass/compass.getCurrentHeading.md | 99 ++++
docs/en/3.0.0rc1/cordova/compass/compass.md | 73 +++
.../cordova/compass/compass.watchHeading.md | 152 ++++++
.../compass/compass.watchHeadingFilter.md | 23 +
.../compass/compassError/compassError.md | 39 ++
.../cordova/compass/parameters/compassError.md | 30 ++
.../compass/parameters/compassHeading.md | 47 ++
.../compass/parameters/compassOptions.md | 41 ++
.../compass/parameters/compassSuccess.md | 39 ++
.../3.0.0rc1/cordova/connection/connection.md | 85 ++++
.../cordova/connection/connection.type.md | 132 +++++
.../cordova/contacts/Contact/contact.md | 232 +++++++++
.../contacts/ContactAddress/contactaddress.md | 160 ++++++
.../contacts/ContactError/contactError.md | 46 ++
.../contacts/ContactField/contactfield.md | 159 ++++++
.../ContactFindOptions/contactfindoptions.md | 113 +++++
.../cordova/contacts/ContactName/contactname.md | 142 ++++++
.../ContactOrganization/contactorganization.md | 147 ++++++
.../cordova/contacts/contacts.create.md | 78 +++
.../3.0.0rc1/cordova/contacts/contacts.find.md | 127 +++++
docs/en/3.0.0rc1/cordova/contacts/contacts.md | 94 ++++
.../cordova/contacts/parameters/contactError.md | 27 +
.../contacts/parameters/contactFields.md | 25 +
.../contacts/parameters/contactFindOptions.md | 35 ++
.../contacts/parameters/contactSuccess.md | 41 ++
.../3.0.0rc1/cordova/device/device.cordova.md | 79 +++
docs/en/3.0.0rc1/cordova/device/device.md | 92 ++++
docs/en/3.0.0rc1/cordova/device/device.model.md | 100 ++++
docs/en/3.0.0rc1/cordova/device/device.name.md | 103 ++++
.../3.0.0rc1/cordova/device/device.platform.md | 96 ++++
docs/en/3.0.0rc1/cordova/device/device.uuid.md | 110 ++++
.../3.0.0rc1/cordova/device/device.version.md | 83 +++
.../cordova/events/events.backbutton.md | 86 ++++
.../cordova/events/events.batterycritical.md | 94 ++++
.../cordova/events/events.batterylow.md | 93 ++++
.../cordova/events/events.batterystatus.md | 101 ++++
.../cordova/events/events.deviceready.md | 94 ++++
.../cordova/events/events.endcallbutton.md | 83 +++
docs/en/3.0.0rc1/cordova/events/events.md | 85 ++++
.../cordova/events/events.menubutton.md | 84 ++++
.../3.0.0rc1/cordova/events/events.offline.md | 103 ++++
.../en/3.0.0rc1/cordova/events/events.online.md | 105 ++++
docs/en/3.0.0rc1/cordova/events/events.pause.md | 107 ++++
.../en/3.0.0rc1/cordova/events/events.resume.md | 119 +++++
.../cordova/events/events.searchbutton.md | 84 ++++
.../cordova/events/events.startcallbutton.md | 84 ++++
.../cordova/events/events.volumedownbutton.md | 84 ++++
.../cordova/events/events.volumeupbutton.md | 84 ++++
.../file/directoryentry/directoryentry.md | 390 ++++++++++++++
.../file/directoryreader/directoryreader.md | 69 +++
docs/en/3.0.0rc1/cordova/file/file.md | 83 +++
.../cordova/file/fileentry/fileentry.md | 323 ++++++++++++
.../cordova/file/fileerror/fileerror.md | 51 ++
.../en/3.0.0rc1/cordova/file/fileobj/fileobj.md | 83 +++
.../cordova/file/filereader/filereader.md | 259 ++++++++++
.../cordova/file/filesystem/filesystem.md | 95 ++++
.../cordova/file/filetransfer/filetransfer.md | 303 +++++++++++
.../file/filetransfererror/filetransfererror.md | 45 ++
.../file/fileuploadoptions/fileuploadoptions.md | 47 ++
.../file/fileuploadresult/fileuploadresult.md | 42 ++
.../cordova/file/filewriter/filewriter.md | 233 +++++++++
docs/en/3.0.0rc1/cordova/file/flags/flags.md | 49 ++
.../file/localfilesystem/localfilesystem.md | 110 ++++
.../3.0.0rc1/cordova/file/metadata/metadata.md | 54 ++
.../geolocation/Coordinates/coordinates.md | 126 +++++
.../cordova/geolocation/Position/position.md | 118 +++++
.../geolocation/PositionError/positionError.md | 60 +++
.../geolocation/geolocation.clearWatch.md | 119 +++++
.../geolocation.getCurrentPosition.md | 129 +++++
.../3.0.0rc1/cordova/geolocation/geolocation.md | 104 ++++
.../geolocation/geolocation.watchPosition.md | 132 +++++
.../parameters/geolocation.options.md | 39 ++
.../geolocation/parameters/geolocationError.md | 33 ++
.../parameters/geolocationSuccess.md | 49 ++
.../GlobalizationError/globalizationerror.md | 94 ++++
.../globalization/globalization.dateToString.md | 97 ++++
.../globalization.getCurrencyPattern.md | 112 +++++
.../globalization/globalization.getDateNames.md | 102 ++++
.../globalization.getDatePattern.md | 105 ++++
.../globalization.getFirstDayOfWeek.md | 82 +++
.../globalization.getLocaleName.md | 83 +++
.../globalization.getNumberPattern.md | 125 +++++
.../globalization.getPreferredLanguage.md | 83 +++
.../globalization.isDayLightSavingsTime.md | 87 ++++
.../cordova/globalization/globalization.md | 63 +++
.../globalization.numberToString.md | 90 ++++
.../globalization/globalization.stringToDate.md | 114 +++++
.../globalization.stringToNumber.md | 93 ++++
.../cordova/inappbrowser/inappbrowser.md | 486 ++++++++++++++++++
.../cordova/inappbrowser/window.open.md | 102 ++++
.../cordova/media/MediaError/mediaError.md | 45 ++
.../cordova/media/Parameters/mediaError.md | 33 ++
.../3.0.0rc1/cordova/media/capture/CaptureCB.md | 47 ++
.../cordova/media/capture/CaptureError.md | 37 ++
.../cordova/media/capture/CaptureErrorCB.md | 44 ++
.../cordova/media/capture/ConfigurationData.md | 63 +++
.../media/capture/MediaFile.getFormatData.md | 64 +++
.../3.0.0rc1/cordova/media/capture/MediaFile.md | 37 ++
.../cordova/media/capture/MediaFileData.md | 65 +++
.../3.0.0rc1/cordova/media/capture/capture.md | 121 +++++
.../cordova/media/capture/captureAudio.md | 152 ++++++
.../media/capture/captureAudioOptions.md | 52 ++
.../cordova/media/capture/captureImage.md | 143 ++++++
.../media/capture/captureImageOptions.md | 41 ++
.../cordova/media/capture/captureVideo.md | 143 ++++++
.../media/capture/captureVideoOptions.md | 48 ++
.../cordova/media/media.getCurrentPosition.md | 176 +++++++
.../3.0.0rc1/cordova/media/media.getDuration.md | 167 ++++++
docs/en/3.0.0rc1/cordova/media/media.md | 133 +++++
docs/en/3.0.0rc1/cordova/media/media.pause.md | 167 ++++++
docs/en/3.0.0rc1/cordova/media/media.play.md | 200 ++++++++
docs/en/3.0.0rc1/cordova/media/media.release.md | 159 ++++++
docs/en/3.0.0rc1/cordova/media/media.seekTo.md | 161 ++++++
.../3.0.0rc1/cordova/media/media.setVolume.md | 178 +++++++
.../3.0.0rc1/cordova/media/media.startRecord.md | 155 ++++++
docs/en/3.0.0rc1/cordova/media/media.stop.md | 172 +++++++
.../3.0.0rc1/cordova/media/media.stopRecord.md | 142 ++++++
.../cordova/notification/notification.alert.md | 117 +++++
.../cordova/notification/notification.beep.md | 111 ++++
.../notification/notification.confirm.md | 129 +++++
.../cordova/notification/notification.md | 69 +++
.../cordova/notification/notification.prompt.md | 124 +++++
.../notification/notification.vibrate.md | 102 ++++
.../cordova/splashscreen/splashscreen.hide.md | 80 +++
.../cordova/splashscreen/splashscreen.md | 81 +++
.../cordova/splashscreen/splashscreen.show.md | 69 +++
.../cordova/storage/database/database.md | 119 +++++
.../storage/localstorage/localstorage.md | 122 +++++
.../cordova/storage/parameters/display_name.md | 23 +
.../3.0.0rc1/cordova/storage/parameters/name.md | 23 +
.../3.0.0rc1/cordova/storage/parameters/size.md | 23 +
.../cordova/storage/parameters/version.md | 23 +
.../cordova/storage/sqlerror/sqlerror.md | 46 ++
.../storage/sqlresultset/sqlresultset.md | 153 ++++++
.../sqlresultsetrowlist/sqlresultsetrowlist.md | 142 ++++++
.../storage/sqltransaction/sqltransaction.md | 114 +++++
docs/en/3.0.0rc1/cordova/storage/storage.md | 80 +++
.../cordova/storage/storage.opendatabase.md | 73 +++
docs/en/3.0.0rc1/guide/cli/index.md | 288 +++++++++++
docs/en/3.0.0rc1/guide/overview/index.md | 383 ++++++++++++++
.../3.0.0rc1/guide/platforms/android/config.md | 40 ++
.../3.0.0rc1/guide/platforms/android/index.md | 200 ++++++++
.../3.0.0rc1/guide/platforms/android/plugin.md | 192 +++++++
.../3.0.0rc1/guide/platforms/android/tools.md | 80 +++
.../guide/platforms/android/upgrading.md | 244 +++++++++
.../3.0.0rc1/guide/platforms/android/webview.md | 119 +++++
.../guide/platforms/blackberry/config.md | 26 +
.../guide/platforms/blackberry/index.md | 212 ++++++++
.../guide/platforms/blackberry/plugin.md | 146 ++++++
.../guide/platforms/blackberry/tools.md | 84 ++++
.../guide/platforms/blackberry/upgrading.md | 310 ++++++++++++
.../guide/platforms/blackberry10/index.md | 165 ++++++
.../guide/platforms/blackberry10/plugin.md | 190 +++++++
.../guide/platforms/blackberry10/tools.md | 162 ++++++
.../guide/platforms/firefoxos/config.md | 23 +
docs/en/3.0.0rc1/guide/platforms/index.md | 92 ++++
docs/en/3.0.0rc1/guide/platforms/ios/config.md | 57 +++
docs/en/3.0.0rc1/guide/platforms/ios/index.md | 231 +++++++++
docs/en/3.0.0rc1/guide/platforms/ios/plugin.md | 201 ++++++++
docs/en/3.0.0rc1/guide/platforms/ios/tools.md | 59 +++
.../3.0.0rc1/guide/platforms/ios/upgrading.md | 473 +++++++++++++++++
docs/en/3.0.0rc1/guide/platforms/ios/webview.md | 131 +++++
docs/en/3.0.0rc1/guide/platforms/tizen/index.md | 112 +++++
docs/en/3.0.0rc1/guide/platforms/win8/index.md | 111 ++++
docs/en/3.0.0rc1/guide/platforms/win8/tools.md | 44 ++
.../3.0.0rc1/guide/platforms/win8/upgrading.md | 42 ++
docs/en/3.0.0rc1/guide/platforms/wp7/index.md | 99 ++++
docs/en/3.0.0rc1/guide/platforms/wp8/index.md | 128 +++++
docs/en/3.0.0rc1/guide/platforms/wp8/plugin.md | 187 +++++++
docs/en/3.0.0rc1/guide/platforms/wp8/tools.md | 101 ++++
.../3.0.0rc1/guide/platforms/wp8/upgrading.md | 274 ++++++++++
.../3.0.0rc1/guide/plugins/corePluginInstall.md | 110 ++++
docs/en/3.0.0rc1/guide/plugins/index.md | 120 +++++
docs/en/3.0.0rc1/guide/plugins/plugin_spec.md | 502 +++++++++++++++++++
docs/en/3.0.0rc1/guide/privacy/index.md | 110 ++++
.../en/3.0.0rc1/guide/project-settings/index.md | 78 +++
docs/en/3.0.0rc1/guide/upgrading/index.md | 29 ++
docs/en/3.0.0rc1/guide/webviews/index.md | 26 +
docs/en/3.0.0rc1/guide/whitelist/index.md | 164 ++++++
docs/en/3.0.0rc1/index.md | 134 +++++
200 files changed, 22368 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/VERSION
----------------------------------------------------------------------
diff --git a/VERSION b/VERSION
index f3ac133..f799780 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.9.0
\ No newline at end of file
+3.0.0rc1
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/config.json
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/config.json b/docs/en/3.0.0rc1/config.json
new file mode 100644
index 0000000..6a62799
--- /dev/null
+++ b/docs/en/3.0.0rc1/config.json
@@ -0,0 +1,200 @@
+{
+ "language": "English",
+ "merge": {
+ "accelerometer.md": [
+ "cordova/accelerometer/accelerometer.md",
+ "cordova/accelerometer/accelerometer.getCurrentAcceleration.md",
+ "cordova/accelerometer/accelerometer.watchAcceleration.md",
+ "cordova/accelerometer/accelerometer.clearWatch.md",
+ "cordova/accelerometer/acceleration/acceleration.md",
+ "cordova/accelerometer/parameters/accelerometerSuccess.md",
+ "cordova/accelerometer/parameters/accelerometerError.md",
+ "cordova/accelerometer/parameters/accelerometerOptions.md"
+ ],
+ "camera.md": [
+ "cordova/camera/camera.md",
+ "cordova/camera/camera.getPicture.md",
+ "cordova/camera/parameter/cameraSuccess.md",
+ "cordova/camera/parameter/cameraError.md",
+ "cordova/camera/parameter/cameraOptions.md",
+ "cordova/camera/parameter/CameraPopoverOptions.md",
+ "cordova/camera/parameter/CameraPopoverHandle.md"
+ ],
+ "capture.md": [
+ "cordova/media/capture/capture.md",
+ "cordova/media/capture/captureAudio.md",
+ "cordova/media/capture/captureAudioOptions.md",
+ "cordova/media/capture/captureImage.md",
+ "cordova/media/capture/captureImageOptions.md",
+ "cordova/media/capture/captureVideo.md",
+ "cordova/media/capture/captureVideoOptions.md",
+ "cordova/media/capture/CaptureError.md",
+ "cordova/media/capture/CaptureCB.md",
+ "cordova/media/capture/CaptureErrorCB.md",
+ "cordova/media/capture/ConfigurationData.md",
+ "cordova/media/capture/MediaFile.md",
+ "cordova/media/capture/MediaFile.getFormatData.md",
+ "cordova/media/capture/MediaFileData.md"
+ ],
+ "compass.md": [
+ "cordova/compass/compass.md",
+ "cordova/compass/compass.getCurrentHeading.md",
+ "cordova/compass/compass.watchHeading.md",
+ "cordova/compass/compass.clearWatch.md",
+ "cordova/compass/compass.watchHeadingFilter.md",
+ "cordova/compass/compass.clearWatchFilter.md",
+ "cordova/compass/parameters/compassSuccess.md",
+ "cordova/compass/parameters/compassError.md",
+ "cordova/compass/parameters/compassOptions.md",
+ "cordova/compass/parameters/compassHeading.md",
+ "cordova/compass/compassError/compassError.md"
+ ],
+ "contacts.md": [
+ "cordova/contacts/contacts.md",
+ "cordova/contacts/contacts.create.md",
+ "cordova/contacts/contacts.find.md",
+ "cordova/contacts/Contact/contact.md",
+ "cordova/contacts/ContactAddress/contactaddress.md",
+ "cordova/contacts/ContactField/contactfield.md",
+ "cordova/contacts/ContactFindOptions/contactfindoptions.md",
+ "cordova/contacts/ContactName/contactname.md",
+ "cordova/contacts/ContactOrganization/contactorganization.md",
+ "cordova/contacts/ContactError/contactError.md",
+ "cordova/contacts/parameters/contactSuccess.md",
+ "cordova/contacts/parameters/contactError.md",
+ "cordova/contacts/parameters/contactFields.md",
+ "cordova/contacts/parameters/contactFindOptions.md"
+ ],
+ "device.md": [
+ "cordova/device/device.md",
+ "cordova/device/device.name.md",
+ "cordova/device/device.cordova.md",
+ "cordova/device/device.platform.md",
+ "cordova/device/device.uuid.md",
+ "cordova/device/device.version.md"
+ ],
+ "events.md": [
+ "cordova/events/events.md",
+ "cordova/events/events.deviceready.md",
+ "cordova/events/events.pause.md",
+ "cordova/events/events.resume.md",
+ "cordova/events/events.online.md",
+ "cordova/events/events.offline.md",
+ "cordova/events/events.backbutton.md",
+ "cordova/events/events.batterycritical.md",
+ "cordova/events/events.batterylow.md",
+ "cordova/events/events.batterystatus.md",
+ "cordova/events/events.menubutton.md",
+ "cordova/events/events.searchbutton.md",
+ "cordova/events/events.startcallbutton.md",
+ "cordova/events/events.endcallbutton.md",
+ "cordova/events/events.volumedownbutton.md",
+ "cordova/events/events.volumeupbutton.md"
+ ],
+ "file.md": [
+ "cordova/file/file.md",
+ "cordova/file/fileobj/fileobj.md",
+ "cordova/file/filereader/filereader.md",
+ "cordova/file/filewriter/filewriter.md",
+ "cordova/file/filesystem/filesystem.md",
+ "cordova/file/fileentry/fileentry.md",
+ "cordova/file/directoryentry/directoryentry.md",
+ "cordova/file/directoryreader/directoryreader.md",
+ "cordova/file/filetransfer/filetransfer.md",
+ "cordova/file/fileuploadoptions/fileuploadoptions.md",
+ "cordova/file/fileuploadresult/fileuploadresult.md",
+ "cordova/file/flags/flags.md",
+ "cordova/file/localfilesystem/localfilesystem.md",
+ "cordova/file/metadata/metadata.md",
+ "cordova/file/fileerror/fileerror.md",
+ "cordova/file/filetransfererror/filetransfererror.md"
+ ],
+ "geolocation.md": [
+ "cordova/geolocation/geolocation.md",
+ "cordova/geolocation/geolocation.getCurrentPosition.md",
+ "cordova/geolocation/geolocation.watchPosition.md",
+ "cordova/geolocation/geolocation.clearWatch.md",
+ "cordova/geolocation/Coordinates/coordinates.md",
+ "cordova/geolocation/Position/position.md",
+ "cordova/geolocation/PositionError/positionError.md",
+ "cordova/geolocation/parameters/geolocationSuccess.md",
+ "cordova/geolocation/parameters/geolocationError.md",
+ "cordova/geolocation/parameters/geolocation.options.md"
+ ],
+ "globalization.md": [
+ "cordova/globalization/globalization.md",
+ "cordova/globalization/globalization.getPreferredLanguage.md",
+ "cordova/globalization/globalization.getLocaleName.md",
+ "cordova/globalization/globalization.dateToString.md",
+ "cordova/globalization/globalization.stringToDate.md",
+ "cordova/globalization/globalization.getDatePattern.md",
+ "cordova/globalization/globalization.getDateNames.md",
+ "cordova/globalization/globalization.isDayLightSavingsTime.md",
+ "cordova/globalization/globalization.getFirstDayOfWeek.md",
+ "cordova/globalization/globalization.numberToString.md",
+ "cordova/globalization/globalization.stringToNumber.md",
+ "cordova/globalization/globalization.getNumberPattern.md",
+ "cordova/globalization/globalization.getCurrencyPattern.md",
+ "cordova/globalization/GlobalizationError/globalizationerror.md"
+ ],
+ "media.md": [
+ "cordova/media/media.md",
+ "cordova/media/media.getCurrentPosition.md",
+ "cordova/media/media.getDuration.md",
+ "cordova/media/media.pause.md",
+ "cordova/media/media.play.md",
+ "cordova/media/media.release.md",
+ "cordova/media/media.seekTo.md",
+ "cordova/media/media.setVolume.md",
+ "cordova/media/media.startRecord.md",
+ "cordova/media/media.stop.md",
+ "cordova/media/media.stopRecord.md",
+ "cordova/media/MediaError/mediaError.md",
+ "cordova/media/Parameters/mediaError.md"
+ ],
+ "network.md": [
+ "cordova/network/network.md",
+ "cordova/network/network.isReachable.md",
+ "cordova/network/NetworkStatus/NetworkStatus.md",
+ "cordova/network/parameters/reachableCallback.md",
+ "cordova/network/parameters/reachableHostname.md",
+ "cordova/network/parameters/reachableOptions.md"
+ ],
+ "connection.md": [
+ "cordova/connection/connection.md",
+ "cordova/connection/connection.type.md"
+ ],
+ "notification.md": [
+ "cordova/notification/notification.md",
+ "cordova/notification/notification.alert.md",
+ "cordova/notification/notification.confirm.md",
+ "cordova/notification/notification.prompt.md",
+ "cordova/notification/notification.beep.md",
+ "cordova/notification/notification.vibrate.md"
+ ],
+ "splashscreen.md": [
+ "cordova/splashscreen/splashscreen.md",
+ "cordova/splashscreen/splashscreen.show.md",
+ "cordova/splashscreen/splashscreen.hide.md"
+ ],
+ "storage.md": [
+ "cordova/storage/storage.md",
+ "cordova/storage/storage.opendatabase.md",
+ "cordova/storage/parameters/name.md",
+ "cordova/storage/parameters/version.md",
+ "cordova/storage/parameters/display_name.md",
+ "cordova/storage/parameters/size.md",
+ "cordova/storage/database/database.md",
+ "cordova/storage/sqltransaction/sqltransaction.md",
+ "cordova/storage/sqlresultset/sqlresultset.md",
+ "cordova/storage/sqlresultsetrowlist/sqlresultsetrowlist.md",
+ "cordova/storage/sqlerror/sqlerror.md",
+ "cordova/storage/localstorage/localstorage.md"
+ ],
+ "inappbrowser.md": [
+ "cordova/inappbrowser/inappbrowser.md",
+ "cordova/inappbrowser/window.open.md"
+ ]
+
+ }
+}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/accelerometer/acceleration/acceleration.md b/docs/en/3.0.0rc1/cordova/accelerometer/acceleration/acceleration.md
new file mode 100644
index 0000000..bcb2033
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/accelerometer/acceleration/acceleration.md
@@ -0,0 +1,109 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Acceleration
+============
+
+Contains `Accelerometer` data captured at a specific point in time.
+
+Properties
+----------
+
+- __x__: Amount of acceleration on the x-axis. (in m/s^2) _(Number)_
+- __y__: Amount of acceleration on the y-axis. (in m/s^2) _(Number)_
+- __z__: Amount of acceleration on the z-axis. (in m/s^2) _(Number)_
+- __timestamp__: Creation timestamp in milliseconds. _(DOMTimeStamp)_
+
+Description
+-----------
+
+An `Acceleration` object is populated and returned by any of the API's
+`Accelerometer` methods. Acceleration values include the effect of
+gravity (9.81 m/s^2), so that when a device lies flat and facing up,
+_x_, _y_, and _z_ values returned should be `0`, `0`, and `9.81`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ function onSuccess(acceleration) {
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ };
+
+ function onError() {
+ alert('onError!');
+ };
+
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Acceleration Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ navigator.accelerometer.getCurrentAcceleration(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' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ }
+
+ // onError: Failed to get the acceleration
+ //
+ function onError() {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>getCurrentAcceleration</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.clearWatch.md b/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.clearWatch.md
new file mode 100644
index 0000000..2c9a859
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.clearWatch.md
@@ -0,0 +1,114 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+accelerometer.clearWatch
+========================
+
+Stop watching the `Acceleration` referenced by the `watchID` parameter.
+
+ navigator.accelerometer.clearWatch(watchID);
+
+- __watchID__: The ID returned by `accelerometer.watchAcceleration`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+
+ // ... later on ...
+
+ navigator.accelerometer.clearWatch(watchID);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Acceleration Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // The watch id references the current `watchAcceleration`
+ var watchID = null;
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ startWatch();
+ }
+
+ // Start watching the acceleration
+ //
+ function startWatch() {
+
+ // Update acceleration every 3 seconds
+ var options = { frequency: 3000 };
+
+ watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ }
+
+ // Stop watching the acceleration
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.accelerometer.clearWatch(watchID);
+ watchID = null;
+ }
+ }
+
+ // onSuccess: Get a snapshot of the current acceleration
+ //
+ 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 />' +
+ 'Timestamp: ' + acceleration.timestamp + '<br />';
+ }
+
+ // onError: Failed to get the acceleration
+ //
+ function onError() {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <div id="accelerometer">Waiting for accelerometer...</div>
+ <button onclick="stopWatch();">Stop Watching</button>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
new file mode 100644
index 0000000..7e528d1
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
@@ -0,0 +1,112 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+accelerometer.getCurrentAcceleration
+====================================
+
+Get the current acceleration along the _x_, _y_, and _z_ axes.
+
+ navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
+
+Description
+-----------
+
+The accelerometer is a motion sensor that detects the change (_delta_)
+in movement relative to the current device orientation, in three
+dimensions along the _x_, _y_, and _z_ axis.
+
+These acceleration values are returned to the `accelerometerSuccess`
+callback function.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ function onSuccess(acceleration) {
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ };
+
+ function onError() {
+ alert('onError!');
+ };
+
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Acceleration Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ navigator.accelerometer.getCurrentAcceleration(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' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ }
+
+ // onError: Failed to get the acceleration
+ //
+ function onError() {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>getCurrentAcceleration</p>
+ </body>
+ </html>
+
+iOS Quirks
+-------------
+
+- iOS doesn't recognize 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 yields the last value reported from a `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.md b/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.md
new file mode 100644
index 0000000..31d6012
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.md
@@ -0,0 +1,82 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Accelerometer
+=============
+
+> Captures device motion in the _x_, _y_, and _z_ direction.
+
+Methods
+-------
+
+- accelerometer.getCurrentAcceleration
+- accelerometer.watchAcceleration
+- accelerometer.clearWatch
+
+Arguments
+---------
+
+- accelerometerSuccess
+- accelerometerError
+- accelerometerOptions
+
+Objects (Read-Only)
+-------------------
+
+- Acceleration
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Accelerometer" value="org.apache.cordova.AccelListener" />
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Accelerometer" value="org.apache.cordova.accelerometer.Accelerometer" />
+
+#### www/config.xml
+
+ <feature id="blackberry.system" required="true" version="1.0.0.0" />
+ <feature id="org.apache.cordova" required="true" version="1.0.0" />
+
+### iOS
+
+#### config.xml
+
+ <plugin name="Accelerometer" value="CDVAccelerometer" />
+
+### Windows Phone
+
+#### Properties/WPAppManifest.xml
+
+ <Capabilities>
+ <Capability Name="ID_CAP_SENSORS" />
+ </Capabilities>
+
+Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+
+### Tizen
+
+ No permissions are required.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.watchAcceleration.md b/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.watchAcceleration.md
new file mode 100644
index 0000000..4abdfcb
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/accelerometer/accelerometer.watchAcceleration.md
@@ -0,0 +1,147 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+accelerometer.watchAcceleration
+===============================
+
+At a regular interval, get the acceleration along the _x_, _y_, and _z_ axis.
+
+ var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
+ accelerometerError,
+ [accelerometerOptions]);
+
+Description
+-----------
+
+The accelerometer is a motion sensor that detects the change (delta)
+in movement relative to the current position. The accelerometer can
+detect 3D movement along the _x_, _y_, and _z_ axis.
+
+The `accelerometer.watchAcceleration` method retrieves the device's
+current `Acceleration` at a regular interval, executing the
+`accelerometerSuccess` callback function each time. Specify the
+interval in milliseconds via the `acceleratorOptions` object's
+`frequency` parameter.
+
+The returned watch ID references the accelerometer's watch interval,
+and can be used with `accelerometer.clearWatch` to stop watching the
+accelerometer.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Quick Example
+-------------
+
+ function onSuccess(acceleration) {
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ };
+
+ function onError() {
+ alert('onError!');
+ };
+
+ var options = { frequency: 3000 }; // Update every 3 seconds
+
+ var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Acceleration Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // The watch id references the current `watchAcceleration`
+ var watchID = null;
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ startWatch();
+ }
+
+ // Start watching the acceleration
+ //
+ function startWatch() {
+
+ // Update acceleration every 3 seconds
+ var options = { frequency: 3000 };
+
+ watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ }
+
+ // Stop watching the acceleration
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.accelerometer.clearWatch(watchID);
+ watchID = null;
+ }
+ }
+
+ // onSuccess: Get a snapshot of the current acceleration
+ //
+ 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 />' +
+ 'Timestamp: ' + acceleration.timestamp + '<br />';
+ }
+
+ // onError: Failed to get the acceleration
+ //
+ function onError() {
+ alert('onError!');
+ }
+
+ </script>
+ </head>
+ <body>
+ <div id="accelerometer">Waiting for accelerometer...</div>
+ </body>
+ </html>
+
+iOS Quirks
+-------------
+
+The API calls the success callback function at the interval requested,
+but restricts the range of requests to the device between 40ms and
+1000ms. For example, if you request an interval of 3 seconds,
+(3000ms), the API requests data from the device every 1 second, but
+only executes the success callback every 3 seconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerError.md b/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerError.md
new file mode 100644
index 0000000..5faf51e
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerError.md
@@ -0,0 +1,27 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+accelerometerError
+==================
+
+onError callback function for acceleration functions.
+
+ function() {
+ // Handle the error
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerOptions.md b/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerOptions.md
new file mode 100644
index 0000000..350fa1e
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerOptions.md
@@ -0,0 +1,28 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+accelerometerOptions
+====================
+
+An optional parameter to customize the retrieval of accelerometer values.
+
+Options
+-------
+
+- __frequency__: How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerSuccess.md b/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerSuccess.md
new file mode 100644
index 0000000..d3542e9
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/accelerometer/parameters/accelerometerSuccess.md
@@ -0,0 +1,42 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+accelerometerSuccess
+====================
+
+onSuccess callback function that provides the `Acceleration` information.
+
+ function(acceleration) {
+ // Do something
+ }
+
+Parameters
+----------
+
+- __acceleration__: The acceleration at a single moment in time. (Acceleration)
+
+Example
+-------
+
+ function onSuccess(acceleration) {
+ alert('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp + '\n');
+ };
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/camera/camera.cleanup.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/camera/camera.cleanup.md b/docs/en/3.0.0rc1/cordova/camera/camera.cleanup.md
new file mode 100644
index 0000000..00c299f
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/camera/camera.cleanup.md
@@ -0,0 +1,52 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+camera.cleanup
+=================
+
+Removes intermediate photos taken by the camera from temporary
+storage.
+
+ navigator.camera.cleanup( cameraSuccess, cameraError );
+
+Description
+-----------
+
+Removes intermediate image files that are kept in temporary storage
+after calling `camera.getPicture`. Applies only when the value of
+`Camera.sourceType` equals `Camera.PictureSourceType.CAMERA` and the
+`Camera.destinationType` equals `Camera.DestinationType.FILE_URI`.
+
+Supported Platforms
+-------------------
+
+- iOS
+
+Example
+-------------
+
+ navigator.camera.cleanup(onSuccess, onFail);
+
+ function onSuccess() {
+ console.log("Camera cleanup success.")
+ }
+
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/camera/camera.getPicture.md b/docs/en/3.0.0rc1/cordova/camera/camera.getPicture.md
new file mode 100644
index 0000000..b613d9c
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/camera/camera.getPicture.md
@@ -0,0 +1,246 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+camera.getPicture
+=================
+
+Takes a photo using the camera, or retrieves a photo from the device's
+image gallery. The image is passed to the success callback as a
+base64-encoded `String`, or as the URI for the image file. The method
+itself returns a `CameraPopoverHandle` object that can be used to
+reposition the file selection popover.
+
+ navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] );
+
+Description
+-----------
+
+The `camera.getPicture` function opens the device's default camera
+application that allows users to snap pictures. This behavior occurs
+by default, when `Camera.sourceType` equals
+`Camera.PictureSourceType.CAMERA`. Once the user snaps the photo, the
+camera application closes and the application is restored.
+
+If `Camera.sourceType` is `Camera.PictureSourceType.PHOTOLIBRARY` or
+`Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a dialog displays
+that allows users to select an existing image. The
+`camera.getPicture` function returns a `CameraPopoverHandle` object,
+which can be used to reposition the image selection dialog, for
+example, when the device orientation changes.
+
+The return value is sent to the `cameraSuccess` callback function, in
+one of the following formats, depending on the specified
+`cameraOptions`:
+
+- A `String` containing the base64-encoded photo image.
+- A `String` representing the image file location on local storage (default).
+
+You can do whatever you want with the encoded image or URI, for
+example:
+
+- Render the image in an `<img>` tag, as in the example below
+- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc.)
+- Post the data to a remote server
+
+__NOTE:__ 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 `quality` parameter is specified. To avoid common
+memory problems, set `Camera.destinationType` to `FILE_URI` rather
+than `DATA_URL`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Tizen
+- Windows Phone 7 and 8
+- Windows 8
+
+Android Quirks
+-----------------
+Android 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.
+
+iOS Quirks
+----------
+
+Including a JavaScript `alert()` in either of the callback functions
+can cause problems. Wrap the alert within a `setTimeout()` to allow
+the iOS image picker or popover to fully close before the alert
+displays:
+
+ setTimeout(function() {
+ // do your thing here!
+ }, 0);
+
+Windows Phone 7 Quirks
+----------------------
+
+Invoking the native camera application while your device is connected
+via Zune does not work, and triggers an error callback.
+
+Tizen Quirks
+----------------------
+
+Tizen only supports a `destinationType` of
+`Camera.DestinationType.FILE_URI` and a `sourceType` of
+`Camera.PictureSourceType.PHOTOLIBRARY`.
+
+Quick Example
+-------------
+
+Take a photo and retrieve it as a base64-encoded image:
+
+ navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
+ destinationType: Camera.DestinationType.DATA_URL
+ });
+
+ function onSuccess(imageData) {
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+ }
+
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
+
+Take a photo and retrieve the image's file location:
+
+ navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
+ destinationType: Camera.DestinationType.FILE_URI });
+
+ function onSuccess(imageURI) {
+ var image = document.getElementById('myImage');
+ image.src = imageURI;
+ }
+
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Capture Photo</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ var pictureSource; // picture source
+ var destinationType; // sets the format of returned value
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready",onDeviceReady,false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ pictureSource=navigator.camera.PictureSourceType;
+ destinationType=navigator.camera.DestinationType;
+ }
+
+ // Called when a photo is successfully retrieved
+ //
+ function onPhotoDataSuccess(imageData) {
+ // Uncomment to view the base64-encoded image data
+ // console.log(imageData);
+
+ // Get image handle
+ //
+ var smallImage = document.getElementById('smallImage');
+
+ // Unhide image elements
+ //
+ smallImage.style.display = 'block';
+
+ // Show the captured photo
+ // The inline CSS rules are used to resize the image
+ //
+ smallImage.src = "data:image/jpeg;base64," + imageData;
+ }
+
+ // Called when a photo is successfully retrieved
+ //
+ function onPhotoURISuccess(imageURI) {
+ // Uncomment to view the image file URI
+ // console.log(imageURI);
+
+ // Get image handle
+ //
+ var largeImage = document.getElementById('largeImage');
+
+ // Unhide image elements
+ //
+ largeImage.style.display = 'block';
+
+ // Show the captured photo
+ // The inline CSS rules are used to resize the image
+ //
+ largeImage.src = imageURI;
+ }
+
+ // A button will call this function
+ //
+ function capturePhoto() {
+ // Take picture using device camera and retrieve image as base64-encoded string
+ navigator.camera.getPicture(onPhotoDataSuccess, onFail, { quality: 50,
+ destinationType: destinationType.DATA_URL });
+ }
+
+ // A button will call this function
+ //
+ function capturePhotoEdit() {
+ // Take picture using device camera, allow edit, and retrieve image as base64-encoded string
+ navigator.camera.getPicture(onPhotoDataSuccess, onFail, { quality: 20, allowEdit: true,
+ destinationType: destinationType.DATA_URL });
+ }
+
+ // A button will call this function
+ //
+ function getPhoto(source) {
+ // Retrieve image file location from specified source
+ navigator.camera.getPicture(onPhotoURISuccess, onFail, { quality: 50,
+ destinationType: destinationType.FILE_URI,
+ sourceType: source });
+ }
+
+ // Called if something bad happens.
+ //
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="capturePhoto();">Capture Photo</button> <br>
+ <button onclick="capturePhotoEdit();">Capture Editable Photo</button> <br>
+ <button onclick="getPhoto(pictureSource.PHOTOLIBRARY);">From Photo Library</button><br>
+ <button onclick="getPhoto(pictureSource.SAVEDPHOTOALBUM);">From Photo Album</button><br>
+ <img style="display:none;width:60px;height:60px;" id="smallImage" src="" />
+ <img style="display:none;" id="largeImage" src="" />
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/camera/camera.md b/docs/en/3.0.0rc1/cordova/camera/camera.md
new file mode 100644
index 0000000..9b100e4
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/camera/camera.md
@@ -0,0 +1,84 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+Camera
+======
+
+> The `camera` object provides access to the device's default camera application.
+
+**Important privacy note:** Collection and use of images from a device's camera raises important privacy issues. Your app's privacy policy should discuss how the app uses the camera and whether the images recorded are shared with any other parties. In addition, if the app's use of the camera is not apparent in the user interface, you should provide a just-in-time notice prior to your app accessing the camera (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for "OK" and "No Thanks"). For more information, please see the Privacy Guide.
+
+Methods
+-------
+
+- camera.getPicture
+- camera.cleanup
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Camera" value="org.apache.cordova.CameraLauncher" />
+
+#### app/AndroidManifest
+
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Camera" value="org.apache.cordova.camera.Camera" />
+
+#### www/config.xml
+
+ <feature id="blackberry.media.camera" />
+
+ <rim:permissions>
+ <rim:permit>use_camera</rim:permit>
+ </rim:permissions>
+
+### iOS
+
+#### config.xml
+
+ <plugin name="Camera" value="CDVCamera" />
+
+### Windows Phone
+
+#### Properties/WPAppManifest.xml
+
+ <Capabilities>
+ <Capability Name="ID_CAP_ISV_CAMERA" />
+ <Capability Name="ID_HW_FRONTCAMERA" />
+ </Capabilities>
+
+Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+
+### Tizen
+
+#### config.xml
+
+ <feature name="http://tizen.org/api/application" required="true"/>
+ <feature name="http://tizen.org/api/application.launch" required="true"/>
+
+Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/camera/parameter/CameraPopoverHandle.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/camera/parameter/CameraPopoverHandle.md b/docs/en/3.0.0rc1/cordova/camera/parameter/CameraPopoverHandle.md
new file mode 100644
index 0000000..ff5a9dd
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/camera/parameter/CameraPopoverHandle.md
@@ -0,0 +1,68 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+CameraPopoverHandle
+===================
+
+A handle to the popover dialog created by `camera.getPicture`.
+
+Methods
+-------
+
+- __setPosition__: Set the position of the popover.
+
+Supported Platforms
+-------------------
+
+- iOS
+
+setPosition
+-----------
+
+Set the position of the popover.
+
+__Parameters:__
+- `cameraPopoverOptions`: the `CameraPopoverOptions` that specify the new position
+
+Quick Example
+-------------
+
+ var cameraPopoverOptions = new CameraPopoverOptions(300, 300, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY);
+ cameraPopoverHandle.setPosition(cameraPopoverOptions);
+
+Full Example
+------------
+
+ function onSuccess(imageData) {
+ // Do stuff with the image!
+ }
+
+ function onFail(message) {
+ alert('Failed to get the picture: ' + message);
+ }
+
+ var cameraPopoverHandle = navigator.camera.getPicture(onSuccess, onFail,
+ { destinationType: Camera.DestinationType.FILE_URI,
+ sourceType: Camera.PictureSourceType.PHOTOLIBRARY });
+
+ // Reposition the popover if the orientation changes.
+ window.onorientationchange = function() {
+ var cameraPopoverOptions = new CameraPopoverOptions(0, 0, 100, 100, 0);
+ cameraPopoverHandle.setPosition(cameraPopoverOptions);
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/camera/parameter/CameraPopoverOptions.md b/docs/en/3.0.0rc1/cordova/camera/parameter/CameraPopoverOptions.md
new file mode 100644
index 0000000..1f7893f
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/camera/parameter/CameraPopoverOptions.md
@@ -0,0 +1,80 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+CameraPopoverOptions
+====================
+
+iOS-only parameters that specify the anchor element location and arrow
+direction of the popover when selecting images from an iPad's library
+or album.
+
+ { x : 0,
+ y : 32,
+ width : 320,
+ height : 480,
+ arrowDir : Camera.PopoverArrowDirection.ARROW_ANY
+ };
+
+CameraPopoverOptions
+--------------------
+
+- __x__: x pixel coordinate of screen element onto which to anchor the popover. _(Number)_
+
+- __y__: y pixel coordinate of screen element onto which to anchor the popover. _(Number)_
+
+- __width__: width, in pixels, of the screen element onto which to anchor the popover. _(Number)_
+
+- __height__: height, in pixels, of the screen element onto which to anchor the popover. _(Number)_
+
+- __arrowDir__: Direction the arrow on the popover should point. Defined in `Camera.PopoverArrowDirection` _(Number)_
+
+ Camera.PopoverArrowDirection = {
+ ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants
+ ARROW_DOWN : 2,
+ ARROW_LEFT : 4,
+ ARROW_RIGHT : 8,
+ ARROW_ANY : 15
+ };
+
+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
+-------------
+
+ 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
+ };
+
+ navigator.camera.getPicture(onSuccess, onFail, options);
+
+ function onSuccess(imageData) {
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+ }
+
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/camera/parameter/cameraError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/camera/parameter/cameraError.md b/docs/en/3.0.0rc1/cordova/camera/parameter/cameraError.md
new file mode 100644
index 0000000..ddb5e01
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/camera/parameter/cameraError.md
@@ -0,0 +1,32 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+cameraError
+===========
+
+onError callback function that provides an error message.
+
+ function(message) {
+ // Show a helpful message
+ }
+
+Parameters
+----------
+
+- __message__: The message is provided by the device's native code. _(String)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/camera/parameter/cameraOptions.md b/docs/en/3.0.0rc1/cordova/camera/parameter/cameraOptions.md
new file mode 100644
index 0000000..a3a7542
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/camera/parameter/cameraOptions.md
@@ -0,0 +1,120 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+cameraOptions
+=============
+
+Optional parameters to customize the camera settings.
+
+ { quality : 75,
+ destinationType : Camera.DestinationType.DATA_URL,
+ sourceType : Camera.PictureSourceType.CAMERA,
+ allowEdit : true,
+ encodingType: Camera.EncodingType.JPEG,
+ targetWidth: 100,
+ targetHeight: 100,
+ popoverOptions: CameraPopoverOptions,
+ saveToPhotoAlbum: false };
+
+Options
+-------
+
+- __quality__: Quality of the saved image, expressed as a range of 0-100, where 100 is typically full resolution with no loss from file compression. _(Number)_ (Note that information about the camera's resolution is unavailable.)
+
+- __destinationType__: Choose the format of the return value. Defined in `navigator.camera.DestinationType` _(Number)_
+
+ Camera.DestinationType = {
+ DATA_URL : 0, // Return image as base64-encoded string
+ FILE_URI : 1, // Return image file URI
+ NATIVE_URI : 2 // Return image native URI (e.g. assets-library:// on iOS or content:// on Android)
+ };
+
+- __sourceType__: Set the source of the picture. Defined in `navigator.camera.PictureSourceType` _(Number)_
+
+ Camera.PictureSourceType = {
+ PHOTOLIBRARY : 0,
+ CAMERA : 1,
+ SAVEDPHOTOALBUM : 2
+ };
+
+- __allowEdit__: Allow simple editing of image before selection. _(Boolean)_
+
+- __encodingType__: Choose the returned image file's encoding. Defined in `navigator.camera.EncodingType` _(Number)_
+
+ Camera.EncodingType = {
+ JPEG : 0, // Return JPEG encoded image
+ PNG : 1 // Return PNG encoded image
+ };
+
+- __targetWidth__: Width in pixels to scale image. Must be used with __targetHeight__. Aspect ratio remains constant. _(Number)_
+- __targetHeight__: Height in pixels to scale image. Must be used with __targetWidth__. Aspect ratio remains constant. _(Number)_
+
+- __mediaType__: Set the type of media to select from. Only works when `PictureSourceType` is `PHOTOLIBRARY` or `SAVEDPHOTOALBUM`. Defined in `nagivator.camera.MediaType` _(Number)_
+
+ Camera.MediaType = {
+ PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
+ VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
+ ALLMEDIA : 2 // allow selection from all media types
+};
+
+- __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 that specify popover location in iPad. Defined in `CameraPopoverOptions`.
+- __cameraDirection__: Choose the camera to use (front- or back-facing). Defined in `navigator.camera.Direction` _(Number)_
+
+ Camera.Direction = {
+ BACK : 0, // Use the back-facing camera
+ FRONT : 1 // Use the front-facing camera
+ };
+
+Android Quirks
+--------------
+
+- Ignores the `allowEdit` parameter.
+- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
+
+BlackBerry Quirks
+-----------------
+
+- Ignores the `quality` parameter.
+- Ignores the `sourceType` parameter.
+- Ignores the `allowEdit` parameter.
+- Application must have key injection permissions to close the native Camera application after the user snaps the photo.
+- Using large image sizes may result in the inability to encode images on later-model devices (e.g. Torch 9800) that feature high-resolution cameras.
+- `Camera.MediaType` is not supported.
+- Ignores the `correctOrientation` parameter.
+- Ignores the `cameraDirection` parameter.
+
+iOS Quirks
+--------------
+
+- Set `quality` below 50 to avoid memory errors on some devices.
+- When using `destinationType.FILE_URI`, photos are saved in the application's temporary directory. You may delete the contents of this directory using the `navigator.fileMgr` APIs if storage space is a concern.
+
+Tizen Quirks
+--------------
+- options not supported
+- always returns a FILE URI
+
+Windows Phone 7 and 8 Quirks
+--------------
+
+- Ignores the `allowEdit` parameter.
+- Ignores the `correctOrientation` parameter.
+- Ignores the `cameraDirection` parameter.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/camera/parameter/cameraSuccess.md b/docs/en/3.0.0rc1/cordova/camera/parameter/cameraSuccess.md
new file mode 100644
index 0000000..995c019
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/camera/parameter/cameraSuccess.md
@@ -0,0 +1,42 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+cameraSuccess
+=============
+
+onSuccess callback function that provides the image data.
+
+ function(imageData) {
+ // Do something with the image
+ }
+
+Parameters
+----------
+
+- __imageData__: Base64 encoding of the image data, _or_ the image file URI, depending on `cameraOptions` in effect. _(String)_
+
+Example
+-------
+
+ // Show image
+ //
+ function cameraCallback(imageData) {
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/compass/compass.clearWatch.md b/docs/en/3.0.0rc1/cordova/compass/compass.clearWatch.md
new file mode 100755
index 0000000..c6353f4
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/compass/compass.clearWatch.md
@@ -0,0 +1,110 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+compass.clearWatch
+========================
+
+Stop watching the compass referenced by the watch ID parameter.
+
+ navigator.compass.clearWatch(watchID);
+
+- __watchID__: The ID returned by `compass.watchHeading`.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+- Tizen
+- Windows Phone 7 and 8 ( if available in hardware )
+- Windows 8
+
+Quick Example
+-------------
+
+ var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+
+ // ... later on ...
+
+ navigator.compass.clearWatch(watchID);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Compass Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // The watch id references the current `watchHeading`
+ var watchID = null;
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ startWatch();
+ }
+
+ // Start watching the compass
+ //
+ function startWatch() {
+
+ // Update compass every 3 seconds
+ var options = { frequency: 3000 };
+
+ watchID = navigator.compass.watchHeading(onSuccess, onError, options);
+ }
+
+ // Stop watching the compass
+ //
+ function stopWatch() {
+ if (watchID) {
+ navigator.compass.clearWatch(watchID);
+ watchID = null;
+ }
+ }
+
+ // onSuccess: Get the current heading
+ //
+ function onSuccess(heading) {
+ var element = document.getElementById('heading');
+ element.innerHTML = 'Heading: ' + heading.magneticHeading;
+ }
+
+ // onError: Failed to get the heading
+ //
+ function onError(compassError) {
+ alert('Compass error: ' + compassError.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <div id="heading">Waiting for heading...</div>
+ <button onclick="startWatch();">Start Watching</button>
+ <button onclick="stopWatch();">Stop Watching</button>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/compass/compass.clearWatchFilter.md b/docs/en/3.0.0rc1/cordova/compass/compass.clearWatchFilter.md
new file mode 100644
index 0000000..92b7c9c
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/compass/compass.clearWatchFilter.md
@@ -0,0 +1,23 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+compass.clearWatchFilter
+========================
+
+No longer supported as of 1.6. See `compass.clearWatch`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0rc1/cordova/compass/compass.getCurrentHeading.md b/docs/en/3.0.0rc1/cordova/compass/compass.getCurrentHeading.md
new file mode 100755
index 0000000..667e300
--- /dev/null
+++ b/docs/en/3.0.0rc1/cordova/compass/compass.getCurrentHeading.md
@@ -0,0 +1,99 @@
+---
+ license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+compass.getCurrentHeading
+=========================
+
+Get the current compass heading.
+
+ navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
+
+Description
+-----------
+
+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
+the heading in degrees from 0 to 359.99, where 0 is north.
+
+The compass heading information is returned via a `CompassHeading`
+object using the `compassSuccess` callback function.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+- Tizen
+- Windows Phone 7 and 8 ( if available in hardware )
+- Windows 8
+
+Quick Example
+-------------
+
+ function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+ };
+
+ function onError(error) {
+ alert('CompassError: ' + error.code);
+ };
+
+ navigator.compass.getCurrentHeading(onSuccess, onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Compass Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-3.0.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for device API libraries to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // device APIs are available
+ //
+ function onDeviceReady() {
+ navigator.compass.getCurrentHeading(onSuccess, onError);
+ }
+
+ // onSuccess: Get the current heading
+ //
+ function onSuccess(heading) {
+ alert('Heading: ' + heading.magneticHeading);
+ }
+
+ // onError: Failed to get the heading
+ //
+ function onError(compassError) {
+ alert('Compass Error: ' + compassError.code);
+ }
+
+ </script>
+ </head>
+ <body>
+ <h1>Example</h1>
+ <p>getCurrentHeading</p>
+ </body>
+ </html>
+