Return-Path: X-Original-To: apmail-cordova-commits-archive@www.apache.org Delivered-To: apmail-cordova-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id E034010CE6 for ; Wed, 4 Sep 2013 03:11:14 +0000 (UTC) Received: (qmail 53687 invoked by uid 500); 4 Sep 2013 03:11:11 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 53670 invoked by uid 500); 4 Sep 2013 03:11:10 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cordova.apache.org Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 52030 invoked by uid 99); 4 Sep 2013 03:10:55 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 04 Sep 2013 03:10:55 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 8EAAE8C7B3D; Wed, 4 Sep 2013 03:10:51 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: agrieve@apache.org To: commits@cordova.apache.org Date: Wed, 04 Sep 2013 03:11:33 -0000 Message-Id: <4f229d1e0bc8426fa5600fd287e80dcc@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [50/51] [partial] Delete rc versions of docs http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/config.json ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/config.json b/docs/en/1.5.0rc1/config.json deleted file mode 100644 index 5752429..0000000 --- a/docs/en/1.5.0rc1/config.json +++ /dev/null @@ -1,170 +0,0 @@ -{ - "language": "English", - "merge": { - "accelerometer.md": [ - "phonegap/accelerometer/accelerometer.md", - "phonegap/accelerometer/accelerometer.getCurrentAcceleration.md", - "phonegap/accelerometer/accelerometer.watchAcceleration.md", - "phonegap/accelerometer/accelerometer.clearWatch.md", - "phonegap/accelerometer/acceleration/acceleration.md", - "phonegap/accelerometer/parameters/accelerometerSuccess.md", - "phonegap/accelerometer/parameters/accelerometerError.md", - "phonegap/accelerometer/parameters/accelerometerOptions.md" - ], - "camera.md": [ - "phonegap/camera/camera.md", - "phonegap/camera/camera.getPicture.md", - "phonegap/camera/parameter/cameraSuccess.md", - "phonegap/camera/parameter/cameraError.md", - "phonegap/camera/parameter/cameraOptions.md" - ], - "capture.md": [ - "phonegap/media/capture/capture.md", - "phonegap/media/capture/captureAudio.md", - "phonegap/media/capture/captureAudioOptions.md", - "phonegap/media/capture/captureImage.md", - "phonegap/media/capture/captureImageOptions.md", - "phonegap/media/capture/captureVideo.md", - "phonegap/media/capture/captureVideoOptions.md", - "phonegap/media/capture/CaptureError.md", - "phonegap/media/capture/CaptureCB.md", - "phonegap/media/capture/CaptureErrorCB.md", - "phonegap/media/capture/ConfigurationData.md", - "phonegap/media/capture/MediaFile.md", - "phonegap/media/capture/MediaFile.getFormatData.md", - "phonegap/media/capture/MediaFileData.md" - ], - "compass.md": [ - "phonegap/compass/compass.md", - "phonegap/compass/compass.getCurrentHeading.md", - "phonegap/compass/compass.watchHeading.md", - "phonegap/compass/compass.clearWatch.md", - "phonegap/compass/compass.watchHeadingFilter.md", - "phonegap/compass/compass.clearWatchFilter.md", - "phonegap/compass/parameters/compassSuccess.md", - "phonegap/compass/parameters/compassError.md", - "phonegap/compass/parameters/compassOptions.md", - "phonegap/compass/parameters/compassHeading.md", - "phonegap/compass/compassError/compassError.md" - ], - "contacts.md": [ - "phonegap/contacts/contacts.md", - "phonegap/contacts/contacts.create.md", - "phonegap/contacts/contacts.find.md", - "phonegap/contacts/Contact/contact.md", - "phonegap/contacts/ContactAddress/contactaddress.md", - "phonegap/contacts/ContactField/contactfield.md", - "phonegap/contacts/ContactFindOptions/contactfindoptions.md", - "phonegap/contacts/ContactName/contactname.md", - "phonegap/contacts/ContactOrganization/contactorganization.md", - "phonegap/contacts/ContactError/contactError.md", - "phonegap/contacts/parameters/contactSuccess.md", - "phonegap/contacts/parameters/contactError.md", - "phonegap/contacts/parameters/contactFields.md", - "phonegap/contacts/parameters/contactFindOptions.md" - ], - "device.md": [ - "phonegap/device/device.md", - "phonegap/device/device.name.md", - "phonegap/device/device.phonegap.md", - "phonegap/device/device.platform.md", - "phonegap/device/device.uuid.md", - "phonegap/device/device.version.md" - ], - "events.md": [ - "phonegap/events/events.md", - "phonegap/events/events.deviceready.md", - "phonegap/events/events.pause.md", - "phonegap/events/events.resume.md", - "phonegap/events/events.online.md", - "phonegap/events/events.offline.md", - "phonegap/events/events.backbutton.md", - "phonegap/events/events.batterycritical.md", - "phonegap/events/events.batterylow.md", - "phonegap/events/events.batterystatus.md", - "phonegap/events/events.menubutton.md", - "phonegap/events/events.searchbutton.md", - "phonegap/events/events.startcallbutton.md", - "phonegap/events/events.endcallbutton.md", - "phonegap/events/events.volumedownbutton.md", - "phonegap/events/events.volumeupbutton.md" - ], - "file.md": [ - "phonegap/file/file.md", - "phonegap/file/fileobj/fileobj.md", - "phonegap/file/filereader/filereader.md", - "phonegap/file/filewriter/filewriter.md", - "phonegap/file/filesystem/filesystem.md", - "phonegap/file/fileentry/fileentry.md", - "phonegap/file/directoryentry/directoryentry.md", - "phonegap/file/directoryreader/directoryreader.md", - "phonegap/file/filetransfer/filetransfer.md", - "phonegap/file/fileuploadoptions/fileuploadoptions.md", - "phonegap/file/fileuploadresult/fileuploadresult.md", - "phonegap/file/flags/flags.md", - "phonegap/file/localfilesystem/localfilesystem.md", - "phonegap/file/metadata/metadata.md", - "phonegap/file/fileerror/fileerror.md", - "phonegap/file/filetransfererror/filetransfererror.md" - ], - "geolocation.md": [ - "phonegap/geolocation/geolocation.md", - "phonegap/geolocation/geolocation.getCurrentPosition.md", - "phonegap/geolocation/geolocation.watchPosition.md", - "phonegap/geolocation/geolocation.clearWatch.md", - "phonegap/geolocation/Coordinates/coordinates.md", - "phonegap/geolocation/Position/position.md", - "phonegap/geolocation/PositionError/positionError.md", - "phonegap/geolocation/parameters/geolocationSuccess.md", - "phonegap/geolocation/parameters/geolocationError.md", - "phonegap/geolocation/parameters/geolocation.options.md" - ], - "media.md": [ - "phonegap/media/media.md", - "phonegap/media/media.getCurrentPosition.md", - "phonegap/media/media.getDuration.md", - "phonegap/media/media.pause.md", - "phonegap/media/media.play.md", - "phonegap/media/media.release.md", - "phonegap/media/media.seekTo.md", - "phonegap/media/media.startRecord.md", - "phonegap/media/media.stop.md", - "phonegap/media/media.stopRecord.md", - "phonegap/media/MediaError/mediaError.md", - "phonegap/media/Parameters/mediaError.md" - ], - "network.md": [ - "phonegap/network/network.md", - "phonegap/network/network.isReachable.md", - "phonegap/network/NetworkStatus/NetworkStatus.md", - "phonegap/network/parameters/reachableCallback.md", - "phonegap/network/parameters/reachableHostname.md", - "phonegap/network/parameters/reachableOptions.md" - ], - "connection.md": [ - "phonegap/connection/connection.md", - "phonegap/connection/connection.type.md" - ], - "notification.md": [ - "phonegap/notification/notification.md", - "phonegap/notification/notification.alert.md", - "phonegap/notification/notification.confirm.md", - "phonegap/notification/notification.beep.md", - "phonegap/notification/notification.vibrate.md" - ], - "storage.md": [ - "phonegap/storage/storage.md", - "phonegap/storage/storage.opendatabase.md", - "phonegap/storage/parameters/name.md", - "phonegap/storage/parameters/version.md", - "phonegap/storage/parameters/display_name.md", - "phonegap/storage/parameters/size.md", - "phonegap/storage/database/database.md", - "phonegap/storage/sqltransaction/sqltransaction.md", - "phonegap/storage/sqlresultset/sqlresultset.md", - "phonegap/storage/sqlresultsetlist/sqlresultsetlist.md", - "phonegap/storage/sqlerror/sqlerror.md", - "phonegap/storage/localstorage/localstorage.md" - ] - } -} http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/guide/getting-started/android/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/guide/getting-started/android/index.md b/docs/en/1.5.0rc1/guide/getting-started/android/index.md deleted file mode 100644 index 08b510f..0000000 --- a/docs/en/1.5.0rc1/guide/getting-started/android/index.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -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 Android -============================ - - -Video Tutorials: ----------------- - -- [PhoneGap and Android Quick Start Video Using Eclipse](http://www.youtube.com/v/MzcIcyBYJMA?autoplay=1) - - -1. Requirements ---------------- - -- Eclipse 3.4+ - -There is also a [Terminal](http://wiki.phonegap.com/w/page/30864168/phonegap-android-terminal-quickstart) of this tutorial that doesn't use Eclipse. - - -2. Install SDK + PhoneGap ----------------------------- - -- Download and install [Eclipse Classic](http://www.eclipse.org/downloads/) -- Download and install [Android SDK](http://developer.android.com/sdk/index.html) -- Download and install [ADT Plugin](http://developer.android.com/sdk/eclipse-adt.html#installing) -- Download the latest copy of [PhoneGap](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. - - 3. Setup New Project ------------------------ - -- Launch Eclipse, then under the menu select **New > Android Project** - - ![](img/guide/getting-started/android/new_android_project.jpeg) -- In the root directory of the project, create two new directories: - - **/libs** - - **assets/www** -- Copy **cordova-1.5.0.js** from your PhoneGap download earlier to **assets/www** -- Copy **cordova-1.5.0.jar** from your PhoneGap download earlier to **/libs** -- Copy **xml** folder from your PhoneGap download earlier to **/res** -- Make a few adjustments too the project's main Java file found in the **src** folder in Eclipse: (view image below) - - Change the class's extend from **Activity** to **DroidGap** - - Replace the **setContentView()** line with **super.loadUrl("file:///android_asset/www/index.html");** - - Add **import com.phonegap.*;** - - Remove **import android.app.Activity;** - - ![](img/guide/getting-started/android/javaSrc.jpg) -- You might experience an error here, where Eclipse can't find cordova-1.5.0.jar. In this case, right click on the /libs folder and go to Build Paths/ > Configure Build Paths. Then, in the Libraries tab, add cordova-1.5.0.jar to the Project. If Eclipse is being temperamental, you might need to refresh (F5) the project once again. -- Right click on AndroidManifest.xml and select **Open With > Text Editor** -- Paste the following permissions under versionName: (view image below) - - - - - - - - - - - - - - - - - - -- Add `android:configChanges="orientation|keyboardHidden"` to the activity tag in AndroidManifest. (view image below) -- Add a second activity under you application tag in AndroidManifest. (view image below) - - - - ![](img/guide/getting-started/android/manifest.jpg) - -4. Hello World --------------- - -Now create and open a new file named **index.html** in the **assets/www** directory. Paste the following code: - - - - - PhoneGap - - - -

Hello World

- - - -5A. Deploy to Simulator ------------------------ - -- Right click the project and go to **Run As** and click **Android Application** -- Eclipse will ask you to select an appropriate AVD. If there isn't one, then you'll need to create it. - - -5B. Deploy to Device --------------------- - -- Make sure USB debugging is enabled on your device and plug it into your system. (Settings > Applications > Development) -- Right click the project and go to **Run As** and click **Android Application** - - -Done! ------ - -You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/30862722/phonegap-android-eclipse-quickstart). - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/guide/getting-started/blackberry/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/guide/getting-started/blackberry/index.md b/docs/en/1.5.0rc1/guide/getting-started/blackberry/index.md deleted file mode 100644 index c7966f0..0000000 --- a/docs/en/1.5.0rc1/guide/getting-started/blackberry/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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 -============================ - - -Video Tutorials: ----------------- - -- [PhoneGap and BlackBerry Widgets uick Start Video](http://www.youtube.com/v/eF0h0K0OLwI?autoplay=1) - - - -1. Requirements ---------------- - -- Windows XP (32-bit) or Windows 7 (32-bit and 64-bit) or Mac OSX 10.6.4+ - -For 4.x devices check out [this guide](http://wiki.phonegap.com/w/page/25653281/Getting%20Started%20with%20PhoneGap-BlackBerry%20with%20the%20Latest%20Environment). - - -2. Install SDK + PhoneGap -------------------------- - -- (Windows Only) Download and install [SUN JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html#jdk) (32-Bit Version). Add it to your PATH variable. -- (Windows Only) Download and extract [Apache Ant](http://ant.apache.org/bindownload.cgi). Add it to your PATH variable. -- Download [BlackBerry WebWorks Smartphone SDK](ttps://bdsc.webapps.blackberry.com/html5/download/sdk) for BlackBerry development and/or [BlackBerry WebWorks Tablet OS SDK](https://bdsc.webapps.blackberry.com/html5/download/sdk) for Playbook development. Keep note of the directories you install these SDKs. -- Download the latest copy of [PhoneGap](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. - - -3. Setup New Project --------------------- - -- Open up a command prompt/terminal and navigate to where you extracted PhoneGap. CD into the PhoneGapBlackBerry directory. -- Create a PhoneGap BlackBerry and PlayBook project. Type 'ant create -Dproject.path='followed by the location you wish to create your project into the command prompt/terminal. -- Change to the newly created directory located at `C:\Dev\bbw\sample`. -- Open up the project.properties file with your favourite editor and change the lines `BlackBerry.bbwp.dir=` and `PlayBook.bbwp.dir=` to equal the respective install locations of the SDKs you downloaded earlier. - - -4. Hello World --------------- - -Build the PhoneGap sample project by typing `ant target build` in your command prompt/terminal while you are in your project's directory. Replace the target with either blackberry or playbook. Note this is the sample PhoneGap project and not a basic hello world application. You can go edit the index.html file located in the www directory of your project to make it say Hello World if you wish. - - -5A. Deploy to Simulator (Windows Only) --------------------------------------- - -- While in your project directory, in command prompt/terminal type `ant target load-simulator`. Replace the target with either blackberry or playbook. -- Press the BlackBerry button on the simulator, go to downloads and you should see your app loaded there. - - -5B. Deploy to Device (Windows and Mac) --------------------------------------- - -- You have to have your signing keys from RIM by filling out this [form](https://www.blackberry.com/SignedKeys/). -- While in your project directory, in command prompt/terminal type `ant target load-device`. Replace the target with either blackberry or playbook. -- Press the BlackBerry button on the simulator, go to downloads and you should see your app loaded there. - - -Done! ------ - -You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/31930982/Getting-Started-with-PhoneGap-BlackBerry-WebWorks). - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/guide/getting-started/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/guide/getting-started/index.md b/docs/en/1.5.0rc1/guide/getting-started/index.md deleted file mode 100644 index 7f96862..0000000 --- a/docs/en/1.5.0rc1/guide/getting-started/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/guide/getting-started/ios/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/guide/getting-started/ios/index.md b/docs/en/1.5.0rc1/guide/getting-started/ios/index.md deleted file mode 100644 index 3bdc35b..0000000 --- a/docs/en/1.5.0rc1/guide/getting-started/ios/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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 -======================== - - -Video Tutorials: ----------------- - -- [PhoneGap Installer - Xcode 4 Template](http://www.youtube.com/v/R9zktJUN7AI?autoplay=1) - - -1. Requirements ---------------- -- Intel-based computer with Mac OS X Snow Leopard (10.6) -- Necessary for Installing on Device: - - An Apple iOS device (iPhone, iPad, iPod Touch) - - iOS developer certification - - -2. Install SDK + PhoneGap -------------------------- - -- Download and install Xcode from [Apple Developer Portal](http://developer.apple.com) (Membership required)

-- Download the latest copy of [PhoneGap](http://phonegap.com/download) and extract its contents. We will be working with the Android directory. - - -3. Setup New Project --------------------- - -- Launch Xcode, then under the File menu select **New** and then **New Project...** -- Select **PhoneGap-based Application** from the list of templates - - ![](img/guide/getting-started/ios/XCode4-templates.png) -- Select the **Next** button, Fill in the "Product Name" & "Company Identifier" for your app - - ![](img/guide/getting-started/ios/xcode4-name_your_app.png) - -- Choose a directory to store your app -- You should see your project in Xcode 4 now. Press the **Run** button in the top left corner. Your build should succeed and launch in the simulator -- You should see a error in your simulator informing you index.html was not found -- To fix this, we need to copy the **www** directory into the project. Right click on the project in the left navigation window and click show in finder -- In Finder, you should see the **www** directory beside your project -- Next step is **IMPORTANT**! Drag the **www** folder into Xcode 4. You can't just drag the www folder into your app's folder. It needs to be dragged into Xcode 4!! In my case I would drag it and drop it on HiWorld shown below. - - ![](img/guide/getting-started/ios/project.jpg) -- After you drag, you should see a prompt with a few options. Make sure to select **Create folder references for any added folders**. Click Finish - - -4. Hello World --------------- - -Open the folder named **www** and type `

Hello World

` after the `` tag in **index.html**. You can also add any associated Javascript and CSS files there as well. - - -5A. Deploy to Simulator ------------------------ - -- Make sure to change the Active SDK in the top left menu to **Simulator+version#**. -- Hit **Run** in your project window header. - - -5B. Deploy to Device --------------------- - -- Open [AppName]-Info.plist and change **BundleIdentifier** to the identifier provided by Apple. If you have a developer license, you can access and run the Assistant at [here](http://developer.apple.com/iphone/manage/overview/index.action) and register your App. -- Make sure to change the Active SDK in the top left menu to **Device+version#**. -- Hit **Run** in your project window header. - - ![](img/guide/getting-started/ios/HelloWorldiPhone4.png) - - -Done! ------ - -You can also checkout more detailed version of this guide [here](http://wiki.phonegap.com/w/page/39991939/Getting-Started-with-PhoneGap-iOS-using-Xcode-4-%28Template-Version%29). - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/guide/getting-started/symbian/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/guide/getting-started/symbian/index.md b/docs/en/1.5.0rc1/guide/getting-started/symbian/index.md deleted file mode 100644 index d4a4c3b..0000000 --- a/docs/en/1.5.0rc1/guide/getting-started/symbian/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 -============================ - - -Video Tutorials: ----------------- - -- [PhoneGap 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 + PhoneGap -------------------------- - -- Download and install [cygwin](http://www.cygwin.com/setup.exe) (Windows only). Make sure you select "make" as it is not included by default -- Download the latest copy of [PhoneGap](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 PhoneGap and go into the Symbian directory - - -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 `

Hello World

` -- 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/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/guide/getting-started/webos/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/guide/getting-started/webos/index.md b/docs/en/1.5.0rc1/guide/getting-started/webos/index.md deleted file mode 100644 index fee50ca..0000000 --- a/docs/en/1.5.0rc1/guide/getting-started/webos/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 -========================== - - -Video Tutorials: ----------------- - -- [PhoneGapPhoneGap 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 + PhoneGap ----------------------------- - -- 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 -- Download the latest copy of [PhoneGap](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 PhoneGap 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 `

Hello World

` - - -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/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/guide/getting-started/windows-phone/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/guide/getting-started/windows-phone/index.md b/docs/en/1.5.0rc1/guide/getting-started/windows-phone/index.md deleted file mode 100644 index fbb3d87..0000000 --- a/docs/en/1.5.0rc1/guide/getting-started/windows-phone/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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 -================================== - - -Video Tutorials: ----------------- - -- [PhoneGap and Windows Phone quick setup video](http://www.youtube.com/v/wO9xdRcNHIM?autoplay=1) -- [PhoneGap 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 + PhoneGap ----------------------------- - -- Download and install [Windows Phone SDK](http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=27570/) -- Download the latest copy of [PhoneGap](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 **PhoneGapStarter**. -- Give your project a name, and select OK. - - ![](img/guide/getting-started/windows-phone/wpnewproj.png) - - -4. Review the project structure -------------------------------- - -- The 'www' folder contains your PhoneGap 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. - - ![](img/guide/getting-started/windows-phone/wp7projectstructure.png) - - -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. - - ![](img/guide/getting-started/windows-phone/wprun.png) - ![](img/guide/getting-started/windows-phone/wpfirstrun.png) - - -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. - -- 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. - - ![](img/guide/getting-started/windows-phone/wpd.png) - - -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/875c8fe2/docs/en/1.5.0rc1/guide/upgrading/blackberry/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/guide/upgrading/blackberry/index.md b/docs/en/1.5.0rc1/guide/upgrading/blackberry/index.md deleted file mode 100644 index 45edc45..0000000 --- a/docs/en/1.5.0rc1/guide/upgrading/blackberry/index.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -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. - -Note: 1.5.0 represents a semi-major change to the PhoneGap/Cordova project! All references to PhoneGap have been changed to Cordova. - -- To upgrade to 1.5.0rc1, please go from 1.4.1 - -## Upgrade to 1.5.0rc1 from 1.4.1 ## - -Updating just the www folder: - -1. Open your `www/` folder, which contains your app. -2. Remove and update the old phonegap.1.4.1.jar file in the `ext/` folder and replace it with cordova.1.5.0.jar. -3. Update the contents of the `ext-air/` folder and make sure to rename the folders with Phonegap with them to Cordova. -4. Copy the new `cordova-1.5.0rc1.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.5.0rc1.js` file. -6. Update your www/plugins.xml file - remember all of the references to PhoneGap need to be changed to Cordova: - -From: - - - - - - - - - - - - - -To: - - - - - - - - - - - - - -Updating the sample folder (ie, updating using the ant tools): - -1. Open the `sample/lib/` folder. -2. Update the .jar file in the `phonegap.1.4.1/ext/` folder. -3. Update the contents of the `phonegap.1.4.1/ext-air/` folder. -4. Update the .js file in the `phonegap.1.4.1/javascript/` folder. -5. Open the `sample/lib/` folder and rename the `cordova.1.4.1/` folder to `cordova.1.5.0rc1/`. -6. Update build.xml to update the ant tools. -7. Type `ant blackberry build` or `ant playbook build` to update the `www/` folder with updated Cordova. -8. Open the `www/` folder and update your HTML to use the new `cordova-1.5.0rc1.js` file. -9. Update your www/plugins.xml file - remember all of the references to PhoneGap need to be changed to Cordova: - -From: - - - - - - - - - - - - - -To: - - - - - - - - - - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/guide/upgrading/webos/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/guide/upgrading/webos/index.md b/docs/en/1.5.0rc1/guide/upgrading/webos/index.md deleted file mode 100644 index 6a4462d..0000000 --- a/docs/en/1.5.0rc1/guide/upgrading/webos/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 PhoneGap 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.5.0 from 1.4.1 ## - -1. remove phonegap-1.4.1.js from your project - -2. update the following line in your index.html: - - change this: - - - to: - - -3. run the makefile to generate the newest version of the phonegap-1.5.0.js file \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/index.md b/docs/en/1.5.0rc1/index.md deleted file mode 100644 index 0a6a617..0000000 --- a/docs/en/1.5.0rc1/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. ---- - -
-

API Reference

-
    -
  • -

    Accelerometer

    - Tap into the device's motion sensor. -
    • -
  • -

    Camera

    - Capture a photo using the device's camera. -
    • -
  • -

    Capture

    - Capture media files using device's media capture applications. -
    • -
  • -

    Compass

    - Obtain the direction that the device is pointing. -
    • -
  • -

    Connection

    - Quickly check the network state, and cellular network information. -
    • -
  • -

    Contacts

    - Work with the devices contact database. -
    • -
  • -

    Device

    - Gather device specific information. -
    • -
  • -

    Events

    - Hook into native events through JavaScript. -
    • -
  • -

    File

    - Hook into native file system through JavaScript. -
    • -
  • -

    Geolocation

    - Make your application location aware. -
    • -
  • -

    Media

    - Record and play back audio files. -
    • -
  • -

    Notification

    - Visual, audible, and tactile device notifications. -
    • -
  • -

    Storage

    - Hook into the devices native storage options. -
    • -
-

Guides

-
    -
  • -

    Getting Started Guides

    - Setup each SDK and create your first PhoneGap app. -
    • -
  • -

    Keyword Index

    - Full index of the PhoneGap Documentation. -
    • -
-
\ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/phonegap/accelerometer/acceleration/acceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/phonegap/accelerometer/acceleration/acceleration.md b/docs/en/1.5.0rc1/phonegap/accelerometer/acceleration/acceleration.md deleted file mode 100644 index c3d0f5f..0000000 --- a/docs/en/1.5.0rc1/phonegap/accelerometer/acceleration/acceleration.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -Acceleration -============ - -Contains `Accelerometer` data captured at a specific point in time. - -Properties ----------- - -- __x:__ Amount of motion on the x-axis. Range [0, 1] (`Number`) -- __y:__ Amount of motion on the y-axis. Range [0, 1] (`Number`) -- __z:__ Amount of motion on the z-axis. Range [0, 1] (`Number`) -- __timestamp:__ Creation timestamp in milliseconds. (`DOMTimeStamp`) - -Description ------------ - -This object is created and populated by PhoneGap, and returned by an `Accelerometer` method. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone -- Windows Phone 7 ( Mango ) -- webOS - -Quick Example -------------- - - function onSuccess(acceleration) { - alert('Acceleration X: ' + acceleration.x + '\n' + - 'Acceleration Y: ' + acceleration.y + '\n' + - 'Acceleration Z: ' + acceleration.z + '\n' + - 'Timestamp: ' + acceleration.timestamp + '\n'); - }; - - function onError() { - alert('onError!'); - }; - - navigator.accelerometer.getCurrentAcceleration(onSuccess, onError); - -Full Example ------------- - - - - - Acceleration Example - - - - - -

Example

-

getCurrentAcceleration

- - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.clearWatch.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.clearWatch.md b/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.clearWatch.md deleted file mode 100644 index 57805ea..0000000 --- a/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.clearWatch.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -accelerometer.clearWatch -======================== - -Stop watching the `Acceleration` referenced by the watch ID parameter. - - navigator.accelerometer.clearWatch(watchID); - -- __watchID__: The ID returned by `accelerometer.watchAcceleration`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options); - - // ... later on ... - - navigator.accelerometer.clearWatch(watchID); - -Full Example ------------- - - - - - Acceleration Example - - - - - -
Waiting for accelerometer...
- - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md deleted file mode 100644 index 58731ec..0000000 --- a/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -accelerometer.getCurrentAcceleration -==================================== - -Get the current acceleration along the x, y, and z axis. - - navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError); - -Description ------------ - -The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation. The accelerometer can detect 3D movement along the x, y, and z axis. - -The acceleration is returned using the `accelerometerSuccess` callback function. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - function onSuccess(acceleration) { - alert('Acceleration X: ' + acceleration.x + '\n' + - 'Acceleration Y: ' + acceleration.y + '\n' + - 'Acceleration Z: ' + acceleration.z + '\n' + - 'Timestamp: ' + acceleration.timestamp + '\n'); - }; - - function onError() { - alert('onError!'); - }; - - navigator.accelerometer.getCurrentAcceleration(onSuccess, onError); - -Full Example ------------- - - - - - Acceleration Example - - - - - -

Example

-

getCurrentAcceleration

- - - -iPhone Quirks -------------- - -- iPhone doesn't have the concept of getting the current acceleration at any given point. -- You must watch the acceleration and capture the data at given time intervals. -- Thus, the `getCurrentAcceleration` function will give you the last value reported from a phoneGap `watchAccelerometer` call. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.md b/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.md deleted file mode 100644 index b84eeb9..0000000 --- a/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -Accelerometer -============= - -> Captures device motion in the x, y, and z direction. - -Methods -------- - -- accelerometer.getCurrentAcceleration -- accelerometer.watchAcceleration -- accelerometer.clearWatch - -Arguments ---------- - -- accelerometerSuccess -- accelerometerError -- accelerometerOptions - -Objects (Read-Only) -------------------- - -- Acceleration \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.watchAcceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.watchAcceleration.md b/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.watchAcceleration.md deleted file mode 100644 index 265b29b..0000000 --- a/docs/en/1.5.0rc1/phonegap/accelerometer/accelerometer.watchAcceleration.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -accelerometer.watchAcceleration -=============================== - -At a regular interval, get the acceleration along the x, y, and z axis. - - var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess, - accelerometerError, - [accelerometerOptions]); - -Description ------------ - -The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current position. The accelerometer can detect 3D movement along the x, y, and z axis. - -The `accelerometer.watchAcceleration` gets the device's current acceleration at a regular interval. Each time the `Acceleration` is retrieved, the `accelerometerSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object. - -The returned watch ID references references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - - -Quick Example -------------- - - function onSuccess(acceleration) { - alert('Acceleration X: ' + acceleration.x + '\n' + - 'Acceleration Y: ' + acceleration.y + '\n' + - 'Acceleration Z: ' + acceleration.z + '\n' + - 'Timestamp: ' + acceleration.timestamp + '\n'); - }; - - function onError() { - alert('onError!'); - }; - - var options = { frequency: 3000 }; // Update every 3 seconds - - var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options); - -Full Example ------------- - - - - - Acceleration Example - - - - - -
Waiting for accelerometer...
- - - - iPhone Quirks -------------- - -- At the interval requested, PhoneGap will call the success callback function and pass the accelerometer results. -- However, in requests to the device PhoneGap restricts the interval to minimum of every 40ms and a maximum of every 1000ms. - - For example, if you request an interval of 3 seconds (3000ms), PhoneGap will request an interval of 1 second from the device but invoke the success callback at the requested interval of 3 seconds. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerError.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerError.md b/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerError.md deleted file mode 100644 index c908c16..0000000 --- a/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerError.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -accelerometerError -================== - -onError callback function for acceleration functions. - - function() { - // Handle the error - } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerOptions.md b/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerOptions.md deleted file mode 100644 index 197f416..0000000 --- a/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerOptions.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -accelerometerOptions -==================== - -An optional parameter to customize the retrieval of the accelerometer. - -Options -------- - -- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerSuccess.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerSuccess.md b/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerSuccess.md deleted file mode 100644 index 277fca8..0000000 --- a/docs/en/1.5.0rc1/phonegap/accelerometer/parameters/accelerometerSuccess.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -accelerometerSuccess -==================== - -onSuccess callback function that provides the Acceleration information. - - function(acceleration) { - // Do something - } - -Parameters ----------- - -- __acceleration:__ The acceleration at a single moment in time. (Acceleration) - -Example -------- - - function onSuccess(acceleration) { - alert('Acceleration X: ' + acceleration.x + '\n' + - 'Acceleration Y: ' + acceleration.y + '\n' + - 'Acceleration Z: ' + acceleration.z + '\n' + - 'Timestamp: ' + acceleration.timestamp + '\n'); - }; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/phonegap/camera/camera.getPicture.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/phonegap/camera/camera.getPicture.md b/docs/en/1.5.0rc1/phonegap/camera/camera.getPicture.md deleted file mode 100644 index fd2ca88..0000000 --- a/docs/en/1.5.0rc1/phonegap/camera/camera.getPicture.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -camera.getPicture -================= - -Takes a photo using the camera or retrieves a photo from the device's album. The image is returned as a base64 encoded `String` or as the URI of an image file. - - navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] ); - -Description ------------ - -Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `Camera.sourceType = Camera.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored. - -If `Camera.sourceType = Camera.PictureSourceType.PHOTOLIBRARY` or `Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected. - -The return value will be sent to the `cameraSuccess` function, in one of the following formats, depending on the `cameraOptions` you specify: - -- A `String` containing the Base64 encoded photo image. -- A `String` representing the image file location on local storage (default). - -You can do whatever you want with the encoded image or URI, for example: - -- Render the image in an `` tag _(see example below)_ -- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc) -- Post the data to a remote server - -Note: The image quality of pictures taken using the camera on newer devices is quite good. _Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800)._ Therefore, using FILE_URI as the 'Camera.destinationType' is highly recommended. - -Supported Platforms -------------------- - -- Android -- Blackberry WebWorks (OS 5.0 and higher) -- iPhone -- Windows Phone 7 ( Mango ) -- webOS - -Quick Example -------------- - -Take photo and retrieve Base64-encoded image: - - navigator.camera.getPicture(onSuccess, onFail, { quality: 50 }); - - function onSuccess(imageData) { - var image = document.getElementById('myImage'); - image.src = "data:image/jpeg;base64," + imageData; - } - - function onFail(message) { - alert('Failed because: ' + message); - } - -Take photo and retrieve image file location: - - navigator.camera.getPicture(onSuccess, onFail, { quality: 50, - destinationType: Camera.DestinationType.FILE_URI }); - - function onSuccess(imageURI) { - var image = document.getElementById('myImage'); - image.src = imageURI; - } - - function onFail(message) { - alert('Failed because: ' + message); - } - - -Full Example ------------- - - - - - Capture Photo - - - - - -
-
-
-
- - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/phonegap/camera/camera.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/phonegap/camera/camera.md b/docs/en/1.5.0rc1/phonegap/camera/camera.md deleted file mode 100644 index d23563b..0000000 --- a/docs/en/1.5.0rc1/phonegap/camera/camera.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -Camera -====== - -> The `camera` object provides access to the device's default camera application. - -Methods -------- - -- camera.getPicture \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.5.0rc1/phonegap/camera/parameter/cameraError.md ---------------------------------------------------------------------- diff --git a/docs/en/1.5.0rc1/phonegap/camera/parameter/cameraError.md b/docs/en/1.5.0rc1/phonegap/camera/parameter/cameraError.md deleted file mode 100644 index 7ee091b..0000000 --- a/docs/en/1.5.0rc1/phonegap/camera/parameter/cameraError.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -cameraError -=========== - -onError callback function that provides an error message. - - function(message) { - // Show a helpful message - } - -Parameters ----------- - -- __message:__ The message is provided by the device's native code. (`String`) \ No newline at end of file