http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/getting-started/blackberry/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/getting-started/blackberry/index.md b/docs/en/1.8.0/guide/getting-started/blackberry/index.md new file mode 100644 index 0000000..178cba1 --- /dev/null +++ b/docs/en/1.8.0/guide/getting-started/blackberry/index.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. +--- + +Getting Started with Blackberry +============================ + +Cordova for BlackBerry makes use of the [BlackBerry WebWorks framework](https://bdsc.webapps.blackberry.com/html5). BlackBerry WebWorks tooling is available for Windows or Mac environments. WebWorks applications can ONLY be deployed to BlackBerry devices running OS 5.0 and higher or the BlackBerry PlayBook operating system. + +1. Requirements +--------------- + +- Windows XP (32-bit) or Windows 7 (32-bit and 64-bit) or Mac OSX 10.6.4+ +- Java Development Kit (JDK) + - Windows: [Oracle JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html#jdk) (32-Bit Version) + - Mac OS X: Versions prior to Mac OS X 10.7 provided Java by default. OS X 10.7+ requires installation of [Java](http://support.apple.com/kb/DL1421). +- Apache Ant + - Windows: [Apache Ant](http://ant.apache.org/bindownload.cgi). + - Mac OS X: Apache Ant is bundled with Java install. + +2. Install SDK + Cordova +------------------------- + +- PlayBook development requires the [Adobe Air SDK](http://www.adobe.com/devnet/air/air-sdk-download.html) +- Download and install one or more of the WebWorks SDKs. Keep note of the install directory. + - Smartphone Development: [BlackBerry WebWorks Smartphone SDK](https://bdsc.webapps.blackberry.com/html5/download/sdk) + - PlayBook Development: [BlackBerry WebWorks Tablet OS SDK](https://bdsc.webapps.blackberry.com/html5/download/sdk) +- Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. + +3. Setup New Project +-------------------- + +- Open up a command prompt/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 two directories, `sample` and `www`. The `sample` folder contains a complete Cordova project. Copy the `sample` 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 `blackberry.bbwp.dir=` and/or `playbook.bbwp.dir=`. Set the value(s) to the directory containing the `bbwp` binary in the WebWorks SDK(s) installed earlier. + +4. Hello World +-------------- + +Build the Cordova sample project by typing `ant target build` in your command prompt/terminal while you are in your project's directory. Replace `target` with either `blackberry` or `playbook`. Note this is a sample Cordova project and not a basic hello world application. The provided index.html in the www contains example usages of many of the Cordova API. + +5A. Deploy to Simulator +-------------------------------------- + +BlackBerry smartphone simulators are only available on Windows. PlayBook simulators require VMWare Player (Windows) or VMWare Fusion (Mac OS X). The WebWorks SDK provides a default simulator. Additional simulators are [available](http://us.blackberry.com/developers/resources/simulators.jsp). + +- Open the project.properties file with your favorite editor and customize the following properties. + - Smartphone (Optional) + - `blackberry.sim.dir` : Path to directory containing simulator. On windows file separator '\' must be escaped '\\\'. + - `blackberry.sim.bin` : Name of the simulator executable in the specified directory. + - Playbook + - `playbook.sim.ip` : IP address of simulator obtained when placing the simulator in developer mode through simulator security settings. + - `playbook.sim.password` : Simulator password which can be set through simulator security settings. +- While in your project directory, in command prompt/terminal type `ant target load-simulator`. Replace `target` with either `blackberry` or `playbook`. Note, for PlayBook the simulator virtual image must already be started. +- The application will be installed in the All Applications section in the simulator. Note, on BlackBerry OS 5 the application is installed in the Downloads folder. + +5B. Deploy to Device (Windows and Mac) +-------------------------------------- + +- Deploying to a device requires signing keys which can be obtained from RIM. + - Fill out this [form](https://bdsc.webapps.blackberry.com/html5/signingkey). to request signing keys. + - Install the signing keys once they have been received: + - [Setup Smartphone Signing keys](https://bdsc.webapps.blackberry.com/html5/documentation/ww_publishing/signing_setup_smartphone_apps_1920010_11.html) + - [Setup Tablet Signing keys](https://bdsc.webapps.blackberry.com/html5/documentation/ww_publishing/signing_setup_tablet_apps_1920009_11.html) +- Install [BlackBerry Desktop Sofware](http://us.blackberry.com/apps-software/desktop/) to be able to install a signed application to a smartphone device attached via USB. +- Open the project.properties file with your favorite editor and customize the following properties: + - Smartphone (Optional) + - `blackberry.sigtool.password` : Password used when code signing keys were registered. If not specified, a prompt will occur. + - Playbook (Required) + - `playbook.sigtool.csk.password` : Signing key password. + - `playbook.sigtool.p12.password` : Signing key password. + - `playbook.device.ip` : IP address of device obtained when placing the device in developer mode through device security settings. + - `playbook.device.password` : Device password which is set through device security settings. +- While in your project directory, in command prompt/terminal type `ant target load-device`. Replace `target` with either `blackberry` or `playbook`. +- The application will be installed in the All Applications section in the device. Note, on BlackBerry OS 5 the application is installed in the Downloads folder. + +Additional Information +---------------------- + +The following articles provide help to issues you may encounter when developing a Cordova application which is based on 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.blackberry.com/html5/documentation/ww_developing/bestpractice_compiling_ww_apps_1873324_11.html) +
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/getting-started/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/getting-started/index.md b/docs/en/1.8.0/guide/getting-started/index.md new file mode 100644 index 0000000..ac9b754 --- /dev/null +++ b/docs/en/1.8.0/guide/getting-started/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. +--- + +Getting Started Guides +====================== + +- Getting Started with Android +- Getting Started with Blackberry +- Getting Started with iOS +- Getting Started with Symbian +- Getting Started with WebOS +- Getting Started with Windows Phone +- Getting Started with Bada http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/getting-started/ios/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/getting-started/ios/index.md b/docs/en/1.8.0/guide/getting-started/ios/index.md new file mode 100644 index 0000000..070401a --- /dev/null +++ b/docs/en/1.8.0/guide/getting-started/ios/index.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. +--- + +Getting Started with iOS +======================== + +This guide describes how to set up your development environment for Cordova and run a sample application. + +Video Tutorials: +---------------- + +- [Cordova Installer - Xcode 4 Template](http://www.youtube.com/v/R9zktJUN7AI?autoplay=1) + + +1. Requirements +--------------- +- Intel-based computer with Mac OS X Lion (10.7) +- Necessary for Installing on Device: + - An Apple iOS device (iPhone, iPad, iPod Touch) + - iOS ceveloper certification + + +2. Install SDK + Cordova +------------------------ + +- Install Xcode from the [Mac App Store](http://itunes.apple.com/us/app/xcode/id497799835?mt=12) </p> +- Donwload the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the **lib/ios** directory. + + +3. Setup New Project +-------------------- + +- Launch Xcode +- Select the **File** menu +- Select **New**, then **New Project...** +- Select **Cordova-based Application** from the list of templates + +  +- Select the **Next** button +- Fill in the "Product Name" & "Company Identifier" for your app + +  + +- **IMPORTANT! DO NOT CHECK** the "Use Automatic Reference Counting" checkbox +- Select the **Next** button +- **Choose a folder** to save your new app in +- Select the **Create** button, this will create your project +- Select the **Run** button in the top left corner. Your build should succeed and launch in the iOS Simulator + + a. You should see an error in the iOS Simulator informing you that **www/index.html** was not found + + b. To fix this, we need to add a folder reference to the **www** directory into the project. + +  + +- **Right-click** on the project icon in the Project Navigator (left sidebar) and select **Show in Finder** +- **In the Finder**, you should see the **www** directory beside your project + +  + +- **IMPORTANT**! **Drag** the **www** folder into Xcode 4. **Don't** drag the www folder into your app's folder. **It needs to be dragged into Xcode 4.** For example, you would drag and drop it on the **highlighted red section** of the HelloWorld project shown below. + +  +- A window sheet should slide down with a few options, after the **"www"** folder has been dragged and dropped into the project. +- Select the radio-button **Create folder references for any added folders**. + +  + +- Select the **Finish** button + + +4. Hello World +-------------- + +- Select the folder named **www** in your Project Navigator in Xcode +- Select the **index.html** file +- Type `<h1>Hello World</h1>` after the `<body>` tag + +You can also add any associated JavaScript and CSS files there as well. + + +5A. Deploy to Simulator +----------------------- + +- Change the Active SDK in the Scheme drop-down menu on the toolbar to **iOS version# Simulator**. +- Select the **Run** button in your project window's toolbar + + +5B. Deploy to Device +-------------------- + +- Open [AppName]-Info.plist (where [AppName] is your application's name), under the "Supporting Files" group +- Change **BundleIdentifier** to the identifier provided by Apple, or your own bundle identifier. If you have a developer license, you can access and run the Assistant [here](http://developer.apple.com/iphone/manage/overview/index.action) and register your app. +- Change the Active SDK in the Scheme drop-down menu on the toolbar to **[DEVICENAME]** where [DEVICENAME] is the name of the device you want to deploy to. +- Select the **Run** button in your project window's toolbar + +  + + +Done! +----- + +Add more HTML, CSS and JavaScript to your **www** folder outside of Xcode, your file additions will be picked up automatically inside Xcode. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/getting-started/symbian/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/getting-started/symbian/index.md b/docs/en/1.8.0/guide/getting-started/symbian/index.md new file mode 100644 index 0000000..26ff6e4 --- /dev/null +++ b/docs/en/1.8.0/guide/getting-started/symbian/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. +--- + +Getting Started with Symbian +============================ + +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 Installer - Xcode 4 Template](http://www.youtube.com/v/R9zktJUN7AI?autoplay=1) + + +1. Requirements +--------------- + +- Windows, OS X, or Linux + +There are also [QT for Symbian](http://wiki.phonegap.com/w/page/16494811/PhoneGap-Symbian-%28Qt%29) and [Symbian with Sony Ericsson](http://wiki.phonegap.com/w/page/16494782/Getting-Started-with-PhoneGap-Symbian-(WRT-on-Sony-Ericsson)) guides. + + +2. Install SDK + Cordova +------------------------- + +- Download and install [cygwin](http://www.cygwin.com/setup.exe) (Windows only). Make sure you select "make" as it is not included by default +- Donwload the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. + + +3. Setup New Project +-------------------- + +- In cygwin, navigate to where you extracted Cordova and go into the Symbian directory</li> + + +4. Hello World +-------------- + +- Open up index.html located in phonegap/symbian/framework/www with your favourite editor. +- In the `body` tag, remove the line `"Build your phonegap app here! Dude!"` and add the line `<h1>Hello World</h1>` +- In cygwin/terminal, type make. This will produce phonegap-symbian.wrt/app.wgz. + + +5A. Deploy to Simulator +----------------------- + +- For Mac or Linux you should install [Aptana Studio](http://www.aptana.org/products/studio2/download) and [Nokia WRT Plug-in for Aptana Studio](http://www.forum.nokia.com/info/sw.nokia.com/id/00d62bd8-4214-4c86-b608-5f11b94dad54/Nokia_WRT_Plug_in_for_Aptana_Studio.html). This has a browser-based javascript emulator +- For Windows you can download the [S60 SDK](http://www.forum.nokia.com/info/sw.nokia.com/id/ec866fab-4b76-49f6-b5a5-af0631419e9c/S60_All_in_One_SDKs.html) which includes the S60 Emulator +- Load the phonegap-symbian.wrt/app.wgz file into the emulator. + + +5B. Deploy to Device +-------------------- + +- Load the phonegap-symbian.wrt/app.wgz file into the device using bluetooth or email. + + +Done! +----- + +You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/16494780/Getting-Started-with-Phonegap-Nokia-WRT). + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/getting-started/webos/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/getting-started/webos/index.md b/docs/en/1.8.0/guide/getting-started/webos/index.md new file mode 100644 index 0000000..d77eba3 --- /dev/null +++ b/docs/en/1.8.0/guide/getting-started/webos/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. +--- + +Getting Started with WebOS +========================== + +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 HP Palm webOS quick start video](http://www.youtube.com/v/XEnAUbDRZfw?autoplay=1) +- [How to convert iPhone app to a Palm](http://www.youtube.com/v/wWoJfQw79XI?autoplay=1) + + +1. Requirements +--------------- + +- Windows, OS X, or Linux + + +2. Install SDK + Cordova +---------------------------- + +- Download and install [Virtual Box](http://www.virtualbox.org/) +- Download and install [WebOS SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321/) +- Download and install [cygwin SDK](http://developer.palm.com/index.php?option=com_content&view=article&layout=page&id=1788&Itemid=321) (Windows only). Make sure you select "make" as it is not included by default +- Donwload the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. + + + +3. Setup New Project +-------------------- + +- Open up terminal/cygwin and navigate to where you extracted your Cordova Download. Go into the webOS directory. + + +4. Hello World +-------------- + +In phonegap/webOS/framework/www, open up index.html with your favourite editor. After the body tag add `<h1>Hello World</h1>` + + +5A. Deploy to Simulator +----------------------- + +- Open up your Palm Emulator from your applications folder/start menu. +- Type `make` in your terminal/cygwin while in the webOS directory. + + +5B. Deploy to Device +-------------------- + +- Make sure your device is in [Developer Mode and plug it in.](http://developer.palm.com/index.php?option=com_content&view=article&id=1552&Itemid=59#dev_mode) +- Type `make` in your terminal/cygwin while in the webOS directory. + + +Done! +----- + +You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/16494781/Getting-Started-with-PhoneGap-webOS). + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/getting-started/windows-phone/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/getting-started/windows-phone/index.md b/docs/en/1.8.0/guide/getting-started/windows-phone/index.md new file mode 100644 index 0000000..d0ff505 --- /dev/null +++ b/docs/en/1.8.0/guide/getting-started/windows-phone/index.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. +--- + +Getting Started with Windows Phone +================================== + +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 or Windows Vista with SP2 + +Note: Running in VM has issues, if you are on a Mac, you will need to setup a bootcamp partition with Windows 7 or Vista + +Necessary for Installing on Device and Submitting to Market Place: + +- Become an [App Hub member](http://create.msdn.com/en-US/home/membership). + + +2. Install SDK + Cordova +---------------------------- + +- Download and install [Windows Phone SDK](http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=27570/) +- Donwload the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. + + +3. Setup New Project +-------------------- + +- Open Visual Studio Express for Windows Phone and choose **New Project**. +- Select **CordovaStarter**. ( the version number will be displayed in the template description ) +- 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 here 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 to have **Windows Phone Emulator** selected in the top drop-down menu. +- Hit the green **play button** beside the Windows Phone Emulator drop-down menu to start debugging or press F5. + +  +  + + +6. Build your project for the device +------------------------------------ + +In order to test your application on a device, the device must be registered. Click [here](http://msdn.microsoft.com/en-us/library/gg588378(v=VS.92).aspx) to read documentation on deploying and testing on your Windows Phone. + +- Make sure your phone is connected, and the screen is unlocked +- In Visual Studio, select 'Windows Phone Device' from the top drop-down menu. +- Hit the green **play button** beside the drop-down menu to start debugging or press 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). + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/upgrading/android/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/upgrading/android/index.md b/docs/en/1.8.0/guide/upgrading/android/index.md new file mode 100644 index 0000000..bc08f2a --- /dev/null +++ b/docs/en/1.8.0/guide/upgrading/android/index.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. +--- + +Upgrading Cordova Android +========================= + + +This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova. + +- To upgrade to 1.8.0, please go from 1.7.0 +- To upgrade from 1.7.0, please go from 1.6.0 + +## Upgrade to 1.8.0 from 1.7.0 ## + +1. Remove cordova-1.7.0.jar from the libs directory in your project +2. Add cordova-1.8.0.jar to the libs directory in your project +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 the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml + + +## Upgrade to 1.7.0 from 1.6.0 ## + +1. Remove cordova-1.6.0.jar from the libs directory in your project +2. Add cordova-1.7.0.jar to the libs directory in your project +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 your HTML to sue the new cordova-1.7.0.js file +6. Update the res/xml/plugins.xml to be the same as the one found in framework/res/xml/plugins.xml + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/upgrading/bada/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/upgrading/bada/index.md b/docs/en/1.8.0/guide/upgrading/bada/index.md new file mode 100644 index 0000000..8f42d6d --- /dev/null +++ b/docs/en/1.8.0/guide/upgrading/bada/index.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. +--- + +Upgrading Cordova Bada +====================== + +This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova. + +## Upgrade to 1.8.0 from 1.7.0 ## + +1. Remove the cordova.bada.js file from the Res/js directory +2. Add the new cordova.js file to your Res/js directory +3. Update your Res/index.html to reference cordova.js instead of cordova.bada.js + +Change this line: + + <script type="text/javascript" src="./js/cordova.bada.js"></script> + + +*to* + + <script type="text/javascript" src="./js/cordova.js"></script> + +As of Cordova 1.8, Bada 1.2 is no longer supported! The repository will be kept there as an archive for people who still want to use it. It contains some outdated APIs. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/upgrading/blackberry/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/upgrading/blackberry/index.md b/docs/en/1.8.0/guide/upgrading/blackberry/index.md new file mode 100644 index 0000000..c047267 --- /dev/null +++ b/docs/en/1.8.0/guide/upgrading/blackberry/index.md @@ -0,0 +1,70 @@ +--- +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 Cordova BlackBerry +============================ + +This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova. + +- 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/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/upgrading/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/upgrading/index.md b/docs/en/1.8.0/guide/upgrading/index.md new file mode 100644 index 0000000..6e5451c --- /dev/null +++ b/docs/en/1.8.0/guide/upgrading/index.md @@ -0,0 +1,31 @@ +--- +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 Cordova Android +- Upgrading Cordova Bada +- Upgrading Cordova BlackBerry +- Upgrading Cordova iOS +- Upgrading Cordova Symbian +- Upgrading Cordova webOS +- Upgrading Cordova Windows Phone http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/upgrading/ios/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/upgrading/ios/index.md b/docs/en/1.8.0/guide/upgrading/ios/index.md new file mode 100644 index 0000000..078c77d --- /dev/null +++ b/docs/en/1.8.0/guide/upgrading/ios/index.md @@ -0,0 +1,34 @@ +--- +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 Cordova iOS +===================== + +## Upgrading Cordova 1.7.0 projects to 1.8.0 ## + +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 Xcode into your Project Navigator, and press the **Delete** key, then select **Remove Reference** from the dialog that pops up. +3. Drag the new **Capture.bundle** from Step 1. above into Xcode into your Project Navigator, and select the **Create groups for any added folders** radio-button http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/upgrading/symbian/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/upgrading/symbian/index.md b/docs/en/1.8.0/guide/upgrading/symbian/index.md new file mode 100644 index 0000000..77c3d0e --- /dev/null +++ b/docs/en/1.8.0/guide/upgrading/symbian/index.md @@ -0,0 +1,21 @@ +--- +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 Cordova Symbian +========================= http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/upgrading/webos/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/upgrading/webos/index.md b/docs/en/1.8.0/guide/upgrading/webos/index.md new file mode 100644 index 0000000..b022123 --- /dev/null +++ b/docs/en/1.8.0/guide/upgrading/webos/index.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. +--- + +Upgrading Cordova webOS +======================= + +This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova. + +## Upgrade to 1.8.0 from 1.7.0 ## + +1. remove cordova-1.7.0.js from your project + +2. update the following line in your index.html: + + change this: + <script type="text/javascript" src="cordova-1.7.0.js"></script> + + to: + <script type="text/javascript" src="cordova-1.8.0.js"></script> + +3. run the makefile to generate the newest version of the cordova-1.8.0.js file \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/upgrading/windows-phone/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/upgrading/windows-phone/index.md b/docs/en/1.8.0/guide/upgrading/windows-phone/index.md new file mode 100644 index 0000000..84ff440 --- /dev/null +++ b/docs/en/1.8.0/guide/upgrading/windows-phone/index.md @@ -0,0 +1,36 @@ +--- +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 Cordova Windows Phone +=============================== + +This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova. + +- To upgrade to 1.8.0, please go from 1.7.0 + +## Upgrade to 1.8.0 from 1.7.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete the file 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. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/guide/whitelist/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/guide/whitelist/index.md b/docs/en/1.8.0/guide/whitelist/index.md new file mode 100644 index 0000000..2ce8b3c --- /dev/null +++ b/docs/en/1.8.0/guide/whitelist/index.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. +--- + +Domain Whitelist Guide +===================== + +Overview +-------- + +Domain whitelisting in Apache Cordova is a security model that controls access to outside domains, such as `http://google.com`. The default security policy is to block all network access. The application developer can then delcare access to specific network domains and subdomains. + +Specification +------------- + +Domain whitelisting lays the ground work 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 it's 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/cordova.xml` and declared with the element `<access origin="..." />`. + +Android has full support for the whitelisting syntax. + +### Syntax + +Access to [google.com][2]: + + <access origin="http://google.com"; /> + +Bada +---- + +Domain whitelisting is unsupported on Bada. By default, all domains are accessible. + +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 + +1. Open `Cordova.plist`. + - In Xcode, it is found at `AppName/Supporting Files/Cordova.plist` + - In the directory, it is found at `AppName/Cordova.plist` +2. Add a new `String` value under the `ExternalHosts` key. + - We recommend using Xcode to avoid editing raw XML. + +Domain protocols (e.g. `http://` and `https://`) are not supported by iOS. + +### Syntax + +Access to [google.com][2] and the secure [google.com][3] (`https://`): + + google.com + +Access to the subdomain [maps.google.com][4]: + + maps.google.com + +Access to all the subdomains on [google.com][2] (e.g. [mail.google.com][5] and [docs.google.com][6]): + + *.google.com + +Access to all domains (e.g. [google.com][2] and [developer.mozilla.org][7]): + + * + +Wildcards on iOS (`*`) are more flexible than the [W3C Widget Access][1] specification. + +Access to all subdomains and TLDs (`.com`, `.net`, etc): + + *.google.* + +Symbian +------- + +Domain whitelisting is unsupported on Symbian. By default, all domains are accessible. + +webOS +----- + +Domain whitelisting is unsupported on webOS. By default, all domains are accessible. + +Windows Phone +------------- + +Domain whitelisting is unsupported on Windows Phone. By default, all domains are accessible. + +[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 http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/e4c3cec9/docs/en/1.8.0/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.8.0/index.md b/docs/en/1.8.0/index.md new file mode 100644 index 0000000..1dbe090 --- /dev/null +++ b/docs/en/1.8.0/index.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. +--- + +<div id="home"> + <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>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>Storage</h2> + <span>Hook into the devices native storage options.</span> + </li> + </ul> + <h1>Guides</h1> + <ul> + <li> + <h2>Getting Started Guides</h2> + <span>Setup each SDK and create your first Cordova app.</span> + </li> + <li> + <h2>Upgrading Guides</h2> + <span>Upgrade an application to the latest Cordova release.</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 Cordova Documentation.</span> + </li> + </ul> +</div>
