http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/f8894a31/docs/en/2.1.0/guide/upgrading/tizen/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.1.0/guide/upgrading/tizen/index.md b/docs/en/2.1.0/guide/upgrading/tizen/index.md new file mode 100644 index 0000000..e575141 --- /dev/null +++ b/docs/en/2.1.0/guide/upgrading/tizen/index.md @@ -0,0 +1,23 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +Upgrading Cordova Tizen +====================== + +This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova.
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/f8894a31/docs/en/2.1.0/guide/upgrading/webos/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.1.0/guide/upgrading/webos/index.md b/docs/en/2.1.0/guide/upgrading/webos/index.md new file mode 100644 index 0000000..a4d4bb1 --- /dev/null +++ b/docs/en/2.1.0/guide/upgrading/webos/index.md @@ -0,0 +1,38 @@ +--- +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 2.1.0 from 2.0.0 ## + +1. remove cordova-2.0.0.js from your project + +2. update the following line in your index.html: + + change this: + <script type="text/javascript" src="cordova-2.0.0.js"></script> + + to: + <script type="text/javascript" src="cordova-2.1.0.js"></script> + +3. run the makefile to generate the newest version of the cordova-2.1.0.js file + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/f8894a31/docs/en/2.1.0/guide/upgrading/windows-phone/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.1.0/guide/upgrading/windows-phone/index.md b/docs/en/2.1.0/guide/upgrading/windows-phone/index.md new file mode 100644 index 0000000..74cbaf3 --- /dev/null +++ b/docs/en/2.1.0/guide/upgrading/windows-phone/index.md @@ -0,0 +1,147 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +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. + +## Upgrade to 2.0.0 from 1.9.0 ## + +There have been considerable changes to the WP7 project structure in Apache Cordova 2.0.0 which make this upgrade a little more involved that the others. Essentially this is not an upgrade but creation of a new project and copy over of existing source files. + +### In Visual Studio's Solution Explorer window: +1. Create a new Apache Cordova WP7 2.0 Project +2. Copy the contents of your 'www' folder to the new project, and be sure these items are added to the VS project. +3. Update your HTML to use the new cordova-2.0.0.js file. +4. Copy and overwrite any splash screen, or icon images. +5. Copy over any plugins from the plugins folder to the new project and ensure that they are also added to the VS project. +6. Build and test. + + +## Upgrade to 1.9.0 from 1.8.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete 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.9.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.9.0.js file. + + +## Upgrade to 1.8.0 from 1.7.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete 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. + +## Upgrade to 1.7.0 from 1.6.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.7.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.7.0.js file. + +## Upgrade to 1.6.1 from 1.6.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete 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.6.1.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.6.1.js file. + +## Upgrade to 1.6.0 from 1.5.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete 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.6.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.6.0.js file. + +## Upgrade to 1.5.0 from 1.4.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete 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.5.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.5.0.js file. + +## Upgrade to 1.4.0 from 1.3.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete 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.4.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.4.0.js file. + +## Upgrade to 1.3.0 from 1.2.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete 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.3.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.3.0.js file. + +## Upgrade to 1.2.0 from 1.1.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete 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.2.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.2.0.js file. + +## Upgrade to 1.1.0 from 1.0.0 ## + +### In Visual Studio's Solution Explorer window: +1. Delete 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.1.0.js into your project ( be sure it is marked as Content ) +6. Update your HTML to use the new cordova-1.1.0.js file. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/f8894a31/docs/en/2.1.0/guide/whitelist/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.1.0/guide/whitelist/index.md b/docs/en/2.1.0/guide/whitelist/index.md new file mode 100644 index 0000000..c7d8055 --- /dev/null +++ b/docs/en/2.1.0/guide/whitelist/index.md @@ -0,0 +1,189 @@ +--- +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/Resources/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. + + +### 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. + +Tizen +---------- + +### Details + +The domain whitelisting rules are found in `config.xml` located in your application root directory. +They are declared with the element `<access origin="..." />`. +For a complete reference, see the [Tizen Accessing External Network Resources documentation][10]. + +### Syntax + +Access to [google.com][2]: + + <access origin="http://google.com"; subdomains="false" /> + +Access to the secure [google.com][3] (`https://`): + + <access origin="https://google.com"; subdomains="false" /> + +Access to all the subdomains on [google.com][2]: + + <access origin="http://google.com"; subdomains="true" /> + +Access to all domains, including `file://` protocol: + + <access origin="*" subdomains="true" /> + +[1]: http://www.w3.org/TR/widgets-access/ +[2]: http://google.com +[3]: https://google.com +[4]: http://maps.google.com +[5]: http://mail.google.com +[6]: http://docs.google.com +[7]: http://developer.mozilla.org +[8]: https://developer.blackberry.com/html5/documentation/ww_developing/Access_element_834677_11.html +[9]: https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_4#8814682_CreatingaProject-AccessingExternalNetworkResources http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/f8894a31/docs/en/2.1.0/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.1.0/index.md b/docs/en/2.1.0/index.md new file mode 100644 index 0000000..8bfe824 --- /dev/null +++ b/docs/en/2.1.0/index.md @@ -0,0 +1,107 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +<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>Command-Line Usage</h2> + <span>Create, build, deploy, and debug from the command-line.</span> + </li> + <li> + <h2>Upgrading Guides</h2> + <span>Upgrade an application to the latest Cordova release.</span> + </li> + <li> + <h2>Plugin Development Guide</h2> + <span>Develop your first Cordova plugin.</span> + </li> + <li> + <h2>Domain Whitelist Guide</h2> + <span>Grant an application access to external domains.</span> + </li> + <li> + <h2>Embedding WebView</h2> + <span>Implement the Cordova WebView in your project.</span> + </li> + <li> + <h2><a href="_index.html">Keyword Index</a></h2> + <span>Full index of the Cordova Documentation.</span> + </li> + </ul> +</div>
