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/06/27 00:15:38 UTC
[04/12] Version 2.9.0
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d0153c45/docs/en/2.9.0/guide/getting-started/blackberry10/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.9.0/guide/getting-started/blackberry10/index.md b/docs/en/2.9.0/guide/getting-started/blackberry10/index.md
new file mode 100644
index 0000000..3efd31a
--- /dev/null
+++ b/docs/en/2.9.0/guide/getting-started/blackberry10/index.md
@@ -0,0 +1,185 @@
+---
+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
+==================================
+
+Apache Cordova is an application development platform that allows you to use common web technologies, primarily HTML5, JavaScript, and CSS, to create applications for mobile devices. Cordova uses a standard set of APIs to access common device features. Additional plugins allow you to access BlackBerry specific APIs, so that you can extend your application to tightly integrate with the BlackBerry 10 OS.
+
+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 simulator 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 <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.
+- `-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 simulator. This is required only if the device or simulator 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 simulator 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 a simulator. Before deploying your app, you must first create a target for the device or simulator 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 a simulator, even if that app is unsigned.
+
+To deploy your app to a device or simulator, 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/d0153c45/docs/en/2.9.0/guide/getting-started/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.9.0/guide/getting-started/index.md b/docs/en/2.9.0/guide/getting-started/index.md
new file mode 100644
index 0000000..6baa27d
--- /dev/null
+++ b/docs/en/2.9.0/guide/getting-started/index.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.
+---
+
+Platform Guides
+======================
+
+Before developing for any of the platforms listed below, install
+cordova's command-line interface (CLI).
+(For details, see The Cordova 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.
+
+This section tells you all you need to know to set up your development
+environment to support each platform: where to obtain the SDK, how to
+set up device emulators, how to connect devices for direct testing,
+and managing signing key requirements.
+
+- Android Platform Guide (Windows, Mac, Linux)
+- BlackBerry Platform Guide (Windows, Mac)
+- BlackBerry Platform Guide 10 (Windows, Mac)
+- iOS Platform Guide (Mac)
+- Windows Phone 7 Platform Guide (Windows 7 or 8)
+- Windows Phone 8 Platform Guide (Windows 8)
+- Windows 8 Platform Guide (Windows 8)
+- Tizen Platform Guide
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d0153c45/docs/en/2.9.0/guide/getting-started/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.9.0/guide/getting-started/ios/index.md b/docs/en/2.9.0/guide/getting-started/ios/index.md
new file mode 100644
index 0000000..0ad73b2
--- /dev/null
+++ b/docs/en/2.9.0/guide/getting-started/ios/index.md
@@ -0,0 +1,332 @@
+---
+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
+========================
+
+## Introduction ##
+
+Apache Cordova is a library used to create native mobile applications using Web technologies. The application is created using HTML, CSS and JavaScript and compiled for each specific platform using the platform native tools. Cordova provides a standard set of JavaScript APIs to access device features on all supported platforms. This document describes how to get started using Apache Cordova for the iOS platform.
+
+### Requirements ###
+
+- **Intel-based Computer with Mac® OS X® Lion or greater (10.7.4+)**
+ The Apple® tools required for building iOS applications run only on the OS X operating system. The version of the development environment required, Xcode® 4.5, runs only on Mac OS X version 10.7 (Lion) or greater.
+- **Xcode 4.5 and iOS 6 SDK**
+ To submit apps to the Apple App Store℠, you must use the latest versions of the Apple tools. Currently the latest versions are Xcode 4.5.2 and the iOS 6 SDK (Software Development Kit). The download of Xcode 4.5.2 includes the iOS 6 SDK.
+ - Download from the [App Store](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) (https://itunes.apple.com/us/app/xcode/id497799835?mt=12).
+ - Download from [Apple Developer Downloads](https://developer.apple.com/downloads/index.action) (https://developer.apple.com/downloads/index.action). __NOTE:__ This link requires Apple Developer registration.
+
+- **Xcode Command Line Tools**
+
+ Cordova uses the command line to create a new application project. To access the Xcode tools from the command line an additional download is required. The tools are downloaded from within Xcode.
+ 1. Open Xcode
+ 2. Select the following via the Xcode Menus: **Xcode Preferences> Downloads>Command Line Tools**. This downloads and installs copies of the core command-line tools and system headers into your computer's system folders.
+
+- **iOS Device**
+
+ You can test many of the Cordova features using the iOS simulator installed with the iOS SDK and Xcode, but you need an actual device to fully test all of the device features your applications use 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. Devices that support at least iOS 5 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/). The program costs $99 per year. This platform guide shows how to deploy the application to the iOS simulator, in which case developer program registration is not required.
+
+## Install Cordova
+
+### Download Cordova
+
+Download the latest version of [Apache Cordova](http://www.apache.org/dist/cordova/) from http://www.apache.org/dist/cordova/. Click on the Download icon and select cordova-x.x.x-src.zip to download to your machine. The download includes the code for all of the Apache Cordova supported platforms.
+### Extract Cordova
+
+To access the code, it needs to be extracted from the archive (.zip) file:
+
+1. Navigate to the folder where you downloaded the code. Find the version-specific cordova-x.x.x-src.zip file.
+
+2. Using the Finder® app, double-click the file to extract. This creates a directory named `cordova-x.x.x`.
+
+3. Expand this folder and locate the cordova-ios.zip file and double-click to extract it.
+
+4. The code for iOS is within the cordova-ios directory structure.
+
+## Project Creation
+
+Xcode projects for Cordova are created by invoking a script file via the command line. The following steps explain how to create the necessary directory structure, open and use the Terminal application to create a new project, and execute the create script.
+### Determine Project Location
+
+Determine where on your system to place your application's Xcode
+project files. This tutorial uses `~/Documents/CordovaXY`, where the
+'X' and 'Y' refer the to Cordova version number.
+
+1. In the Finder, navigate to the `Documents` directory.
+
+2. Create a subdirectory within `Documents` called `CordovaXY`, where the 'X' and 'Y' represent the Cordova version number (23, for example). You can use a different directory name or location if you wish, but you need to remember it for subsequent steps.
+
+### Open Terminal
+
+1. Open the Terminal application, located by default in the `Applications/Utilities` folder.
+
+3. Use the Finder to navigate to the `cordova-ios` directory from the downloaded and extracted Cordova code. Highlight the `bin` subdirectory as shown:
+
+ 
+
+ __NOTE:__ Your listing varies depending on Cordova's version number.
+
+4. Drag this directory to the open the Terminal icon in the dock. This opens up a default terminal window with the path set to the `bin` directory.
+
+### Create New Project
+
+#### Command Line Syntax
+
+ 1. Determine Required Parameters
+
+ Three parameters are required to creating a Cordova project from the command line, in this order:
+
+ 1. **project location**
+
+ This directory is where the Xcode project and application files are to be located. This tutorial uses `~/Documents/CordovaXY` as the base location (with 'X' and 'Y' representing the Cordova version number) and the `HelloWorld` application name as the project directory. Since the command creates the final `HelloWorld` directory, it must not already exist.
+
+ 2. **package name**
+
+ When submitting apps to the App Store, this must be the reverse domain name App ID that is created via the Apple Provisioning Portal (described in the Deploy to Device section). The Provisioning Portal is accessible once you have paid for and signed into your iOS Developer Account. Since you don't need to submit this sample app, this tutorial uses `org.apache.Cordova` plus the `HelloWorld` app name: `org.apache.cordova.HelloWorld`
+ 3. **project name**
+
+ This is the name of the actual project. Most developers match the project name with the application name, so in this example it's `HelloWorld`.
+ 2. Execute the Command
+
+ In the terminal app with bin as the current directory, enter the 3 pieces of information via the following command:
+ `./create ~/Documents/CordovaXY/HelloWorld org.apache.cordova.HelloWorld HelloWorld`
+
+ 
+
+ 3. Fix Common Problems
+
+ **No Developer Directory Found**
+
+ The “Error: No developer directory found at /Developer” message is displayed if the create script can not find the location of the command-line tools within Xcode. This can occur if more than one version of Xcode is installed on the system or when upgrading from older versions of Xcode. The solution is to run the xcode-select command to set the location. If you have installed Xcode in the default location the command to execute is:
+
+ sudo /usr/bin/xcode-select -switch /Applications/Xcode.app/Contents/Developer
+
+ See [http://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/xcode-select.1.html](http://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/xcode-select.1.html) for more information on the xcode-select command if you have installed Xcode in a different location.
+
+#### Optional Features
+
+ - **Additional Parameters**
+
+ The default create script copies the necessary common library files from the Cordova distribution directory into your Xcode project directory. These files appear within the project's `CordovaLib` directory. Some development organizations prefer that developers reference the common Cordova library files from a fixed location, which helps ensure that all developers use the exact same copy of the CordovaLib code. To do this, add the `--shared` parameter to the `create` command. The following command creates a project that references the CordovaLib directory from the iOS directory location in which you run the `create` script:
+
+ ./create --shared ~/Documents/CordovaXY/HelloWorld org.apache.cordova.HelloWorld HelloWorld
+ The Xcode project files are still in the `~/Documents/CordovaXY/HelloWorld` directory, but the CordovaLib files are referenced from the Cordova distribution directory.
+ - **Additional Scripts**
+
+ Within the cordova-ios/bin directory there is an additional script that changes the location of the CordovaLib directory to refer to a shared location after the project has been created,
+
+ ./update_cordova_subproject path/to/your/project
+
+ Most users are satisfied with the default project creation procedure and do not need this additional script. This script uses the location of CordovaLib directory at the same directory level as the bin directory from which it is run as the shared location for CordovaLib. To modify the newly created HelloWorld project to use a shared location for CordovaLib, execute the following command from the `bin` directory:
+
+ ./update_cordova_subproject ~/Documents/CordovaXY/HelloWorld
+
+## Running the Application
+
+### Open the Project
+
+ Using the Finder app, navigate to the location where you created the project. This guide uses `~/Documents/CordovaXY/HelloWorld`. Double-click the `HelloWorld.xcodeproj` file to open the project in Xcode.
+
+ Your screen should look similar to:
+
+
+ __NOTE:__ this screen capture shows a project that was created with the name as HelloWorld23.
+### Deploy to the Simulator
+
+ 1. In the upper-left corner of Xcode, click on the Scheme drop-down list and select the project name, HelloWorld, as the target.
+ 2. Click the device section and select an iOS Simulator such as iPhone 6.0 Simulator as shown:
+
+
+ 3. Click the **Run** button in your project window's toolbar to build, deploy and run the application in the simulator.
+
+### Deploy to the Device
+
+#### Requirements
+
+ There are several requirements to deploy to a device. Since this information is not related directly to Cordova, please 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).
+
+ - Join the Apple iOS Developer Program
+
+ - Create a Provisioning Profile within the [iOS Provisioning Portal](https://developer.apple.com/ios/manage/overview/index.action). You can use the Development Provisioning Assistant within the Provisioning Portal to create and install the profile and certificate for use within Xcode.
+
+ - Verify that the Code Signing Identity in the Code Signing sections of the Hello World Xcode project settings has been set with your provisioning profile name.
+
+#### Deployment Steps
+
+ 1. Plug your device into your Mac via the USB Cable.
+ 2. Select the Target and device
+
+ 1. In the upper-left corner of the Xcode window, click the Scheme drop-down list and select the project name, HelloWorld, as the target.
+ 2. Click the device section and select your device from the list. If your device is plugged in via the USB but not visible in the device list, click the **Organizer** button to determine any errors.
+
+ 3. Click the **run** button to build, deploy and run the application on your device.
+
+## Results
+
+ The running HelloWorld app is shown below. The Device is Ready line should be slowly pulsating.
+
+ 
+
+## 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. The Xcode
+warning about the ‘invokeString’ method concerns functionality that
+launches the app from a custom URL. While the mechanism to load from a
+custom URL has changed, this code is included 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.
+
+If you wish to remove the warnings you can remove the code that
+references the deprecated invokeString API:
+
+ 1. Edit the `Classes/MainViewController.m` file.
+ 2. Find and comment out the following code by surrounding it with the begin, /*, and end, */, comment characters as highlighted in the code snippet below.
+
+ (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];
+ }
+
+ 3. Press Command s to save the file.
+ 4. Navigate to the AppViewDelegate.m file in the Classes Folder.
+
+ 5. Comment out the following line by placing a double slash at the beginning of line 73 as shown below:
+
+ //self.viewController.invokeString = invokeString;
+
+ 6. Press Command-s to save the file.
+
+ 7. Press Command-b to rebuild the project and eliminate the warnings.
+
+### Missing Headers
+
+ Some users have encountered compilation errors relating to missing headers. This refers to a problem in the build location and is fixed via Xcode preferences.
+
+ 1. Within the Xcode menus select **Xcode → Preferences → Locations**.
+ 2. In the __Derived Data__ section click the __Advanced__ button and select __Unique__ as the __Build Location_ as shown:
+
+
+ This is the default setting for a new Xcode install, but it may be set differently if you upgraded from an older version of Xcode.
+
+## Next Steps
+
+### Building Your Own Applications
+
+ **Include Cordova**
+
+ All of the code for the sample application is contained within the
+ Xcode project's `www` directory, where the starting page is named
+ `index.html`. Any page that invokes Cordova APIs must reference the
+ version-specific `cordova-x.x.x.js` file, as shown in the sample
+ `HelloWorld` application's `index.html`:
+
+ <script type="text/javascript" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" src="js/index.js"></script>
+ <script type="text/javascript">
+ app.initialize();
+ </script>
+
+ **Wait for deviceReady Event**
+
+ When loading a page, Cordova’s `deviceReady` event must fire before you can access any of the platform features via the Cordova JavaScript APIs. Within the sample application this is set up within the app object found within the js/index.js file. The app.initialze() call at the bottom of the `index.html` file (visible in the previous code example) sets in motion the binding of events to receive and respond to the `deviceReady` event.
+
+ Another common way to initialize a page is to add a `deviceReady` event listener from the body's `onload` event handler as shown below:
+
+ <head>
+ <script type="text/javascript" src="cordova-x.x.x.js"></script>
+ <script>
+ function onLoad() {
+ document.addEventListener(
+ ‘deviceready’, onDeviceReady, false);
+ }
+ function onDeviceReady() {
+ // do Something!
+ // example: display a Cordova Alert
+ // see docs.cordova.io for full details
+ navigator.notification.alert(
+ 'Cordova is ready!', // message
+ function() {//do something}, // callback
+ 'Congratulations', // title
+ 'Done' // buttonName
+ );
+ }
+ </script>
+ </head>
+ <body onload=”onLoad();”>
+ .....
+
+###Code Your Application
+
+ Replace the sample code in the `www` directory of a new project with the HTML, JavaScript and CSS code for your application. The name of the initial file to load when the app is launched should be `index.html` (advanced users can change this if necessary). As demonstrated in the HelloWorld sample application, subdirectories within the `www` directory are permitted. Note that the `www` directory is readonly, you can not write information to this directory during app execution. If you need to store information use the Cordova File or Storage APIs.
+
+ You can use many mobile JavaScript frameworks with Cordova to create the UI and page navigation of your application. Popular ones include:
+
+ - JQuery Mobile
+ - Dojo Mobile
+ - Sencha Touch
+
+### Modify Project Settings
+
+ There are many additional considerations to make your application unique. The sample HelloWorld application is set up to run in all iOS environments, iPhone, iPod, and iPad. You can design an app for a single device type by modifying the build settings within Xcode.
+
+ You should customize the application with your own icons and splash screens. The sample application includes Cordova specific images in the Apple required sizes and resolutions as examples. The Cordova Specific settings are located in the config.xml file and documented in the Cordova Project Settings Guide. Refer to the Resources section for more Apple specific information about building iOS Apps.
+
+## Resources
+
+### Apple
+
+ Some of these references are within the Apple iOS Developer Reference and require an iOS Developer License.
+
+ - [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)
+
+### Apache Cordova
+
+ The [Apache Cordova home page](http://cordova.apache.org/) contains all of the links below and more.
+
+ - Cordova API documentation is available at [http://docs.cordova.io](http://docs.cordova.io)
+ - [PhoneGap google group](https://groups.google.com/forum/?fromgroups=%23!forum/phonegap) to discuss and ask questions about Cordova. This forum is monitored by Cordova developers as well as users. When posting please include the platform, device type, Cordova version and as many details as possible about the error or problem.
+ - File Cordova bugs at [https://issues.apache.org/jira/browse/CB](https://issues.apache.org/jira/browse/CB)
+
+### Credits
+
+ 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/d0153c45/docs/en/2.9.0/guide/getting-started/tizen/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.9.0/guide/getting-started/tizen/index.md b/docs/en/2.9.0/guide/getting-started/tizen/index.md
new file mode 100644
index 0000000..1bc6dae
--- /dev/null
+++ b/docs/en/2.9.0/guide/getting-started/tizen/index.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.
+---
+
+Tizen Platform Guide
+=========================
+
+This guide describes how to set up your development environment for Cordova and run a sample application. Note that Cordova used to be called PhoneGap, so some of the sites still use the old PhoneGap name.
+
+1. Requirements
+---------------
+
+- Linux Ubuntu 10.04/10.10/11.04/11.10 32-bit, Windows XP SP3/7 32-bit.
+
+2. Install SDK + Cordova
+-------------------------
+
+- Download and install the [Tizen SDK](https://developer.tizen.org/sdk).
+- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `tizen` directory.
+- (optional) Install Tizen Cordova template projects: copy the `/templates` directory content into you Tizen Eclipse IDE web templates directory (e.g: `/home/my_username/tizen-sdk/IDE/Templates/web`).
+
+3. Set up New Project
+--------------------
+
+- **Method #1: Import a Cordova Tizen project sample**
+ - Launch Tizen Eclipse IDE
+ - Select **File → Import → Tizen Web Project**
+
+ 
+
+ - Click **Next**
+ - Make sure that **Select root directory** is checked
+ - Make sure **Copy projects into workspace** is checked
+ - Click **Browse**
+ - Browse to one of the Cordova Tizen `samples` project directory (e.g: `/cordova-basic`) and select it
+
+ 
+
+ - Click **Finish**
+
+ 
+
+ - Your project should now be imported and appear in the **Project Explorer** view
+
+- **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
+
+4. Hello World
+--------------
+- To build your project:
+
+ - **Right Click** your project in the **Project Explorer** view and Select **Build Project**
+
+ 
+
+ - A widget package should be generated in your project root directory (e.g: `cordova-basic.wgt`)
+
+ - __NOTE:__ The sample Tizen Cordova projects provided go beyond basic "hello world" applications, and feature example usage of the Battery API.
+
+5A. Deploy to Simulator
+-----------------------
+
+- **Right Click** your project in the **Project Explorer** view and Select **Run As** and **Tizen Web Simulator Application**
+
+ 
+
+5B. Deploy to Device/Emulator
+--------------------
+
+- Make sure that your target device is properly launched, connected and configured. Its __Date and Time__ settings must be set correctly.
+- Select your application deployment target with the **Connection Explorer** view (Select **Window → Show View → Connection Explorer**.)
+
+ 
+
+- **Right-click** your project in the **Project Explorer** view and select **Run As** and **Tizen Web Application**
+
+ 
+
+Done!
+-----
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d0153c45/docs/en/2.9.0/guide/getting-started/windows-8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.9.0/guide/getting-started/windows-8/index.md b/docs/en/2.9.0/guide/getting-started/windows-8/index.md
new file mode 100644
index 0000000..b663d3a
--- /dev/null
+++ b/docs/en/2.9.0/guide/getting-started/windows-8/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 describes how to set up your Cordova development
+environment and run a sample application. Note that Cordova used to
+be called PhoneGap, so some of the sites still use the old PhoneGap
+name.
+
+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/d0153c45/docs/en/2.9.0/guide/getting-started/windows-phone-7/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.9.0/guide/getting-started/windows-phone-7/index.md b/docs/en/2.9.0/guide/getting-started/windows-phone-7/index.md
new file mode 100644
index 0000000..a049fdd
--- /dev/null
+++ b/docs/en/2.9.0/guide/getting-started/windows-phone-7/index.md
@@ -0,0 +1,108 @@
+---
+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 describes how to set up your development environment for Cordova and run a sample application. Note that Cordova used to be called PhoneGap, so some of the sites still use the old PhoneGap name.
+
+Video Tutorials:
+----------------
+
+- [Cordova and Windows Phone quick setup video](http://www.youtube.com/v/wO9xdRcNHIM?autoplay=1)
+- [Cordova and Windows Phone deep dive](http://www.youtube.com/v/BJFX1GRUXj8?autoplay=1)
+
+1. Requirements
+---------------
+
+- Windows 7, Windows 8 or Windows Vista with SP2
+
+__NOTE:__ Running in VM does not work well. If you are on a Mac, you need to set up a bootcamp partition with Windows 7 or Vista.
+
+- Become an [App Hub member](http://create.msdn.com/en-US/home/membership). You need to do so to install onto a device and submit the application to the market place.
+
+2. Install SDK + Cordova
+----------------------------
+
+- Download and install [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` subfolder.
+- Copy the `CordovaWP7_x.x.x.zip` to the `\My Documents\Visual Studio 2012\Templates\ProjectTemplates\` folder.
+(If the template file does not exist, you need to build it as described in 2.1 below.)
+if you have just installed VisualStudio, you should launch it once to create this folder
+if you prefer, you may add the project instead to the `Silverlight for Windows Phone` subfolder of `Visual C#`. This is up to you, and only affects where the project template is shown when creating a new project. Also, You may need to create this folder.
+
+2.1. Building the template
+-----------------------------
+
+__NOTE:__ Skip this step if the `lib\windows-phone` directory already contains a `CordovaWP7_x.x.x.zip` file.
+
+- Open the `lib\windows-phone\templates\standalone\CordovaSolution.sln` in Visual Studio Express for Windows Phone
+- Select __Export Template...__ from the __File__ menu.
+- Choose template type __Project template__
+- Supply a name of the exported template, such as `CordovaStarter-2.1.0` to produce a `CordovaStarter-2.1.0.zip` file.
+
+- Optionally, add a description, icon image, or Preview image. These are displayed in Visual Studio's __New Project__ dialog.
+- __NOTE:__ If you select __Automatically import the template...__, then you don't need to copy the `.zip` file over as outlined in step 2.
+- Press __Finish__.
+
+3. Set up New Project
+--------------------
+
+- Open Visual Studio Express for Windows Phone and choose **New Project**.
+- Select **CordovaStarter**. (The version number displays in the template description.)
+- - __NOTE:__ If you do not see it, you may have to select the top-level 'Visual C#'.
+- Give your 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 needs to be a part of the Visual Studio project, and it must be set as content.
+
+ 
+
+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 else type __F5__.
+
+ 
+
+ 
+
+6. Build your project for the device
+------------------------------------
+
+To test your application on a device, the device must be registered. MSDN provides [documentation][register-url] to help deploy and test your Windows Phone.
+
+- Make sure your phone is connected, and the screen is unlocked
+- In Visual Studio, select 'Windows Phone Device' from the top drop-down menu.
+- Press the green **play** button next to the main drop-down menu to start debugging, or type __F5__.
+
+ 
+
+Done!
+-----
+
+You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/48672055/Getting%20Started%20with%20PhoneGap%20Windows%20Phone%207).
+
+[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/d0153c45/docs/en/2.9.0/guide/getting-started/windows-phone-8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.9.0/guide/getting-started/windows-phone-8/index.md b/docs/en/2.9.0/guide/getting-started/windows-phone-8/index.md
new file mode 100644
index 0000000..9829038
--- /dev/null
+++ b/docs/en/2.9.0/guide/getting-started/windows-phone-8/index.md
@@ -0,0 +1,135 @@
+---
+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 describes how to set up your development environment for Cordova and run a sample application. Note that Cordova used to be called PhoneGap, so some of the sites still use the old PhoneGap name.
+
+__NOTE:__ Applications built with Apache Cordova for Windows Phone 8 run only on Windows Phone 8 devices. If you want to target both 7.5 'and' 8 devices, then use Apache Cordova for Windows Phone 7, which does not have all the advanced features included in IE10, but implements the same APIs.
+
+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 and/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` subfolder.
+- 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 Visual Studio template that allows creating a Cordova application rapidly. This template can be modified if needed and the below steps indicate how to proceed if you want to modify and re-generate the template.
+
+- Open the `lib\windows-phone\templates\standalone\CordovaSolution.sln` file in Visual Studio Express for Windows Phone.
+- Select __Export Template...__ from the __File__ menu.
+- Choose template type __Project template__
+- Give the exported template a name, such as `CordovaStarter-2.1.0`, which produces a `CordovaStarter-2.1.0.zip` archive.
+- Optionally, you may add a description, icon image, and preview image. These display in Visual Studio's __New Project__ dialog.
+- __NOTE:__ If you select __Automatically import the template...__, then you don't need to copy the `.zip` file over as outlined in step 2.
+- Press __Finish__
+
+2.2 About the different templates
+---------------------------------
+
+Apache Cordova for Windows Phone 8 only supports the standalone template.
+
+The 'Stand-Alone' template includes _all_ the source code for Apache
+Cordova. This project is easier to fine-tune to use just the features
+you need, thereby working around the permissions issues of the 'Full'
+template, however this type of project is more difficult to update, as
+you update individual files within your project and manage any
+dependancies yourself. In order to exclude an unused API, simply
+right-click-select the __Command__ class file in Visual Studio and
+choose __do not include in project__.
+
+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/d0153c45/docs/en/2.9.0/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.9.0/guide/overview/index.md b/docs/en/2.9.0/guide/overview/index.md
new file mode 100644
index 0000000..a94de23
--- /dev/null
+++ b/docs/en/2.9.0/guide/overview/index.md
@@ -0,0 +1,388 @@
+---
+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 Cordova 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.
+ <!-- XREF
+ (See the Platform Guides for instructions.)
+ XREF -->
+ 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- or browser-based device
+ emulator, depending on the device feature you want to test.
+ <!-- XREF
+ (See API and Configuration 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.
+<!-- XREF
+(See the Platform Guides for details about each platform's SDK tool set.)
+XREF -->
+An SDK environment is more appropriate if you want implement a hybrid
+app that mixes web-based and native application components.
+<!-- XREF
+(See Extended Hybrid Applications 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_getting-started_index.md.html">IDE platform support</a></th>
+ <td data-col="android" class="y"><a href="guide_getting-started_android_index.md.html"> </a></td>
+ <td data-col="blackberry" class="y"><a href="guide_getting-started_blackberry_index.md.html"> </a></td>
+ <td data-col="blackberry10" class="y"><a href="guide_getting-started_blackberry10_index.md.html"> </a></td>
+ <td data-col="ios" class="y"><a href="guide_getting-started_ios_index.md.html"> </a></td>
+ <td data-col="winphone7" class="y"><a href="guide_getting-started_windows-phone-7_index.md.html"> </a></td>
+ <td data-col="winphone8" class="y"><a href="guide_getting-started_windows-phone-8_index.md.html"> </a></td>
+ <td data-col="win8" class="y"><a href="guide_getting-started_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_cordova-webview_android.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_cordova-webview_ios.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_plugin-development_android_index.md.html"></a></td>
+ <td data-col="blackberry" class="y"><a href="guide_plugin-development_blackberry_index.md.html"></a></td>
+ <td data-col="blackberry10" class="y"><a href="guide_plugin-development_blackberry10_index.md.html"></a></td>
+ <td data-col="ios" class="y"><a href="guide_plugin-development_ios_index.md.html"></a></td>
+ <td data-col="winphone7" class="y"><a href="guide_plugin-development_windows-phone_index.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/d0153c45/docs/en/2.9.0/guide/plugin-development/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/2.9.0/guide/plugin-development/android/index.md b/docs/en/2.9.0/guide/plugin-development/android/index.md
new file mode 100644
index 0000000..2f372e7
--- /dev/null
+++ b/docs/en/2.9.0/guide/plugin-development/android/index.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.
+---
+
+# Developing a Plugin on Android
+
+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
+
+We have JavaScript to fire off a plugin request to the native side. We
+have the Android Java plugin 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
+
+We would add the following to our config.xml:
+
+ <plugin name="Echo" value="org.apache.cordova.plugin.Echo" />
+
+Then we would 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).