Updated Branches: refs/heads/3.0.x c3b417915 -> 15f11a8e1
[CB-3827] move former 'Project Settings' to new top-level config_ref tree Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/8ea2caa4 Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/8ea2caa4 Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/8ea2caa4 Branch: refs/heads/3.0.x Commit: 8ea2caa499f2abbf0b5ed16865e9deeff21632b8 Parents: c094f96 Author: Mike Sierra <[email protected]> Authored: Thu Jul 18 16:30:46 2013 -0400 Committer: Michael Brooks <[email protected]> Committed: Thu Jul 18 14:05:24 2013 -0700 ---------------------------------------------------------------------- docs/en/edge/config_ref/index.md | 78 +++++++++++++++++++++++ docs/en/edge/guide/project-settings/index.md | 78 ----------------------- 2 files changed, 78 insertions(+), 78 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8ea2caa4/docs/en/edge/config_ref/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/config_ref/index.md b/docs/en/edge/config_ref/index.md new file mode 100644 index 0000000..51af63d --- /dev/null +++ b/docs/en/edge/config_ref/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/8ea2caa4/docs/en/edge/guide/project-settings/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/project-settings/index.md b/docs/en/edge/guide/project-settings/index.md deleted file mode 100644 index 51af63d..0000000 --- a/docs/en/edge/guide/project-settings/index.md +++ /dev/null @@ -1,78 +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. ---- - -# 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`.
