Updated Branches: refs/heads/master 8f78f9c2f -> 17ffa3e52 Updated Tags: refs/tags/3.0.0rc1 [created] 17ffa3e52
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/project-settings/index.md ---------------------------------------------------------------------- diff --git a/docs/en/3.0.0rc1/guide/project-settings/index.md b/docs/en/3.0.0rc1/guide/project-settings/index.md new file mode 100644 index 0000000..51af63d --- /dev/null +++ b/docs/en/3.0.0rc1/guide/project-settings/index.md @@ -0,0 +1,78 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +# Configuration Reference + +You can set various application configuration parameters using a platform-agnostic configuration file, `config.xml`. +This file is based on the W3C [Packaged Web Apps (Widgets)](http://www.w3.org/TR/widgets/) specification. + +The location of the `config.xml` file is different depending on the platform. The contents, in general, are not. + +## Platform-Specific Properties + +As with any abstraction layer, Apache Cordova cannot be a perfect silver bullet. As such, some native and platform-specific +properties, characteristics and behaviours are encapsulated as much as possible as `<preference>` elements inside the +`config.xml` file. The following sub-sections linked to are guides which go into more details about these preferences. + +- iOS Configuration +- Android Configuration +- BlackBerry Configuration +- Windows Phone 7 Configuration +- Windows Phone 8 Configuration +- Windows 8 Configuration +- FirefoxOS Configuration + +## config.xml Elements + +The [Apache Cordova](http://cordova.io) project strives abstract away native platform specifics via web-inspired and web-based +abstractions that are heavily standards driven and adopted by the web community. Please take a few minutes to familiarize +yourself with the [config.xml specification](http://www.w3.org/TR/widgets/), to understand the type of application metadata the +Apache Cordova project aims to abstract and provide simple entry points for. + +An example: + + <widget> + <preference name="MySetting" value="true" /> + <plugins> + <plugin name="MyPlugin" value="MyPluginClass" /> + </plugins> + <access origin="*" /> + <content src="index.html" /> + </widget> + +A list of supported elements across major platforms which are supported in Apache Cordova follow. + +### `<plugin>` + +These elements map to native APIs that the application accesses. At +runtime, the Apache Cordova framework checks the `<plugin>` elements +and maps them to native code to enable your Cordova application to +access device APIs otherwise unavailable to typical web-based +applications. + +### `<access>` + +These elements define how your whitelist works. Please see the +Domain Whitelist Guide for more information. + +### `<content>` + +This element defines your application's start page relative to the +project's standard web assets root folder. This element is optional, +the default is `index.html`. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/upgrading/index.md ---------------------------------------------------------------------- diff --git a/docs/en/3.0.0rc1/guide/upgrading/index.md b/docs/en/3.0.0rc1/guide/upgrading/index.md new file mode 100644 index 0000000..e365fec --- /dev/null +++ b/docs/en/3.0.0rc1/guide/upgrading/index.md @@ -0,0 +1,29 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +# Upgrading Guides + +> Learn how to upgrade an application to the latest Apache Cordova release. + +- Upgrading Android +- Upgrading BlackBerry +- Upgrading iOS +- Upgrading Windows Phone +- Upgrading Windows 8 + http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/webviews/index.md ---------------------------------------------------------------------- diff --git a/docs/en/3.0.0rc1/guide/webviews/index.md b/docs/en/3.0.0rc1/guide/webviews/index.md new file mode 100644 index 0000000..937db59 --- /dev/null +++ b/docs/en/3.0.0rc1/guide/webviews/index.md @@ -0,0 +1,26 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +# Embedding WebViews + +> Implement the Cordova WebView in your own project. + +- Android WebViews +- iOS WebViews + http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/guide/whitelist/index.md ---------------------------------------------------------------------- diff --git a/docs/en/3.0.0rc1/guide/whitelist/index.md b/docs/en/3.0.0rc1/guide/whitelist/index.md new file mode 100644 index 0000000..6307b3f --- /dev/null +++ b/docs/en/3.0.0rc1/guide/whitelist/index.md @@ -0,0 +1,164 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +# Domain Whitelist Guide + +## Overview + +Domain whitelisting is a security model that controls access to +outside domains, such as `http://google.com`. Apache Cordova's +default security policy allows access to any site. Before moving your +application to production, you should review its whitelist and declare +access to specific network domains and subdomains. + +## Specification + +Domain whitelisting lays the groundwork for the [W3C Widget Access][1] specification. In the Widget Access specification, the `<access>` element is used to declare access to specific network domains. In the future, Apache Cordova will abstract the platform whitelisting implementations to the W3C Widget Access specification. However, for now each platform must implement its own domain whitelisting. + +## Syntax + +Access to [google.com][2]: + + http://google.com + +Access to the secure [google.com][3] (`https://`): + + https://google.com + +Access to the subdomain [maps.google.com][4]: + + http://maps.google.com + +Access to all the subdomains on [google.com][2] (e.g. [mail.google.com][5] and [docs.google.com][6]): + + http://*.google.com + +Access to all domains (e.g. [google.com][2] and [developer.mozilla.org][7]): + + * + +## Android + +### Details + +The whitelisting rules are found in `res/xml/config.xml` and declared +with the element `<access origin="..." />`. + +Android fully supports whitelisting syntax. + +### Syntax + +Access to [google.com][2]: + + <access origin="http://google.com"; /> + +## BlackBerry + +### Details + +The whitelisting rules are found in `www/config.xml` and declared with the element `<access uri="..." />`. + +For a complete reference, see the [BlackBerry WebWorks Access Element documentation][8]. + +### Syntax + +Access to [google.com][2]: + + <access uri="http://google.com"; subdomains="false" /> + +Access to [maps.google.com][4]: + + <access uri="http://maps.google.com"; subdomains="false" /> + +Access to all the subdomains on [google.com][2]: + + <access uri="http://google.com"; subdomains="true" /> + +Access to all domains, including `file://` protocol: + + <access uri="*" subdomains="true" /> + +iOS +--- + +### Details + +The whitelisting rules are found in `AppName/config.xml` and declared with the element `<access origin="..." />`. + +iOS fully supports whitelisting syntax. + +__NOTE:__ origins specified without a protocol, such as +`www.apache.org` rather than `http://www.apache.org`, default to all +of the `http`, `https`, `ftp`, and `ftps` schemes. + +### Syntax + +Wildcards on iOS (`*`) are more flexible than the [W3C Widget Access][1] specification. + +Access to all subdomains and TLDs (`.com`, `.net`, etc): + + *.google.* + +## Windows Phone (7 & 8) + +The whitelisting rules are found in `config.xml` and declared with the element `<access origin="..." />`. + +Android fully supports whitelisting syntax. + +### Syntax + +Access to [google.com][2]: + + <access origin="http://google.com"; /> + +## Tizen + +### Details + +The application root directory's `config.xml` file specifies domain +whitelisting rules, using the `<access origin="..." />` element. +For a complete reference, see the [Tizen Accessing External Network Resources documentation][10]. + +### Syntax + +Access to [google.com][2]: + + <access origin="http://google.com"; subdomains="false" /> + +Access to the secure [google.com][3] (`https://`): + + <access origin="https://google.com"; subdomains="false" /> + +Access to all the subdomains on [google.com][2]: + + <access origin="http://google.com"; subdomains="true" /> + +Access to all domains, including `file://` protocol: + + <access origin="*" subdomains="true" /> + +[1]: http://www.w3.org/TR/widgets-access/ +[2]: http://google.com +[3]: https://google.com +[4]: http://maps.google.com +[5]: http://mail.google.com +[6]: http://docs.google.com +[7]: http://developer.mozilla.org +[8]: https://developer.blackberry.com/html5/documentation/ww_developing/Access_element_834677_11.html +[9]: https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_4#8814682_CreatingaProject-AccessingExternalNetworkResources http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17ffa3e5/docs/en/3.0.0rc1/index.md ---------------------------------------------------------------------- diff --git a/docs/en/3.0.0rc1/index.md b/docs/en/3.0.0rc1/index.md new file mode 100644 index 0000000..afd255f --- /dev/null +++ b/docs/en/3.0.0rc1/index.md @@ -0,0 +1,134 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +<div id="home"> + + <h1>Guides</h1> + <ul> + <li> + <h2>Overview</h2> + <span>Start here if you are new to Cordova.</span> + </li> + <li> + <h2>The Command-line Interface</h2> + <span>Create, build, and deploy from the command-line.</span> + </li> + <li> + <h2>Platform Guides</h2> + <span>Set up each SDK to create your first app.</span> + </li> + <li> + <h2>Upgrading Guides</h2> + <span>Upgrade an application to the latest release.</span> + </li> + <li> + <h2>Configuration Reference</h2> + <span>Customize the features of your app.</span> + </li> + <li> + <h2>Embedding WebViews</h2> + <span>Implement the Cordova WebView in your project.</span> + </li> + <li> + <h2>Plugin Development Guide</h2> + <span>Develop your first plugin.</span> + </li> + <li> + <h2>Privacy Guide</h2> + <span>Learn about important mobile privacy issues.</span> + </li> + <li> + <h2>Domain Whitelist Guide</h2> + <span>Grant an application access to external domains.</span> + </li> + <li> + <h2><a href="_index.html">Keyword Index</a></h2> + <span>Full index of the documentation.</span> + </li> + </ul> + + <h1>API Reference</h1> + <ul> + <li> + <h2>Accelerometer</h2> + <span>Tap into the device's motion sensor.</span> + </li> + <li> + <h2>Camera</h2> + <span>Capture a photo using the device's camera.</span> + </li> + <li> + <h2>Capture</h2> + <span>Capture media files using device's media capture applications.</span> + </li> + <li> + <h2>Compass</h2> + <span>Obtain the direction that the device is pointing.</span> + </li> + <li> + <h2>Connection</h2> + <span>Quickly check the network state, and cellular network information.</span> + </li> + <li> + <h2>Contacts</h2> + <span>Work with the devices contact database.</span> + </li> + <li> + <h2>Device</h2> + <span>Gather device specific information.</span> + </li> + <li> + <h2>Events</h2> + <span>Hook into native events through JavaScript.</span> + </li> + <li> + <h2>File</h2> + <span>Hook into native file system through JavaScript.</span> + </li> + <li> + <h2>Geolocation</h2> + <span>Make your application location aware.</span> + </li> + <li> + <h2>Globalization</h2> + <span>Enable representation of objects specific to a locale.</span> + </li> + <li> + <h2>InAppBrowser</h2> + <span>Launch URLs in another in-app browser instance.</span> + </li> + <li> + <h2>Media</h2> + <span>Record and play back audio files.</span> + </li> + <li> + <h2>Notification</h2> + <span>Visual, audible, and tactile device notifications.</span> + </li> + <li> + <h2>Splashscreen</h2> + <span>Show and hide the applications splash screen.</span> + </li> + <li> + <h2>Storage</h2> + <span>Hook into the devices native storage options.</span> + </li> + </ul> + +</div>
