You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2014/01/08 21:11:56 UTC
docs commit: CB-4910 Update docs for CLI moving www/config.xml ->
config.xml
Updated Branches:
refs/heads/master b58b6b16a -> d65fd9ace
CB-4910 Update docs for CLI moving www/config.xml -> config.xml
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/d65fd9ac
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/d65fd9ac
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/d65fd9ac
Branch: refs/heads/master
Commit: d65fd9acefe3ee61a9fe067dc3c34406eb330df5
Parents: b58b6b1
Author: Andrew Grieve <ag...@chromium.org>
Authored: Wed Jan 8 15:11:11 2014 -0500
Committer: Andrew Grieve <ag...@chromium.org>
Committed: Wed Jan 8 15:11:11 2014 -0500
----------------------------------------------------------------------
docs/en/edge/config_ref/images.md | 2 +-
docs/en/edge/config_ref/index.md | 43 +++++++----------------
docs/en/edge/guide/appdev/whitelist/index.md | 2 +-
3 files changed, 14 insertions(+), 33 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d65fd9ac/docs/en/edge/config_ref/images.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/config_ref/images.md b/docs/en/edge/config_ref/images.md
index 6c9bf98..ca4245b 100644
--- a/docs/en/edge/config_ref/images.md
+++ b/docs/en/edge/config_ref/images.md
@@ -150,7 +150,7 @@ supporting
[screen sizes](http://developer.android.com/guide/practices/screens_support.html) and
[alternate resources](http://developer.android.com/guide/topics/resources/providing-resources.html#AlternativeResources).
-In `config.xml` in the project's `www` directory, add the following preferences:
+In `config.xml`, add the following preferences:
<preference name="SplashScreen" value="splash" />
<preference name="SplashScreenDelay" value="10000" />
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d65fd9ac/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
index f337324..2df9931 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -20,37 +20,27 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# The config.xml File
Many aspects of an app's behavior can be controlled with a global
-configuration file, `config.xml`, that belongs in the top-level web
-asset directory along with the app's home page. This
+configuration file, `config.xml`. This
platform-agnostic XML file is arranged based on the W3C's [Packaged
Web Apps (Widgets)](http://www.w3.org/TR/widgets/) specification, and
extended to specify core Cordova API features, plugins, and
platform-specific settings.
For projects created with the Cordova CLI (described in The
-Command-Line Interface), this file can be found in the top-level `www`
+Command-Line Interface), this file can be found in the top-level
directory:
- app/www/config.xml
+ app/config.xml
+
+Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
+and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied along with other web-asset source files into various
-`platforms/*/www` subdirectories, for example:
+passively copied into various `platforms/` subdirectories, for example:
- app/platforms/ios/www/config.xml
+ app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
-
-An exception is Android, whose path specifies an additional `assets`
-subdirectory:
-
- app/platforms/android/assets/www/config.xml
-
-If you use the CLI to create a project, but then shift your workflow
-to an SDK, you need to use an alternate set of source files for
-Android and iOS:
-
- app/platforms/android/res/www/config.xml
- app/platforms/ios/<APP_NAME>/config.xml
+ app/platforms/android/res/xml/config.xml
This section details global and cross-platform configuration options.
See the following sections for platform-specific options:
@@ -78,12 +68,8 @@ This example shows the default `config.xml` generated by the CLI's
</author>
<content src="index.html" />
<access origin="*" />
- <preference name="Fullscreen" value="true" />
- <preference name="WebViewBounce" value="true" />
</widget>
-<!-- QUERY: is WebViewBounce superseded by DisallowOverscroll? -->
-
The following configuration elements appear in the top-level
`config.xml` file, and are supported across all supported Cordova
platforms:
@@ -174,14 +160,9 @@ to enable device APIs. This does not modify the top-level `config.xml`
file, so the `<feature>` element does not apply to your workflow. If
you work directly in an SDK and using the platform-specific
`config.xml` file as source, you use the `<feature>` tag to enable
-device-level APIs and external plugins. They typically appear in this
-form:
-
- <feature name="Plugin" value="PluginID" />
-
-They often appear with custom values in platform-specific `config.xml`
-files. For example, here is how to specify the Device API for Android
-projects:
+device-level APIs and external plugins. They often appear with custom values in
+platform-specific `config.xml` files. For example, here is how to specify the
+Device API for Android projects:
<feature name="Device">
<param name="android-package" value="org.apache.cordova.device.Device" />
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d65fd9ac/docs/en/edge/guide/appdev/whitelist/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/appdev/whitelist/index.md b/docs/en/edge/guide/appdev/whitelist/index.md
index d734a3e..29dd735 100644
--- a/docs/en/edge/guide/appdev/whitelist/index.md
+++ b/docs/en/edge/guide/appdev/whitelist/index.md
@@ -29,7 +29,7 @@ Cordova adheres to the [W3C Widget Access][1] specification, which
relies on the `<access>` element within the app's `config.xml` file to
enable network access to specific domains. For projects that rely on
the CLI workflow described in The Command-Line Interface, this file is
-located in the project's top-level `www` directory. Otherwise for
+located in the project's top-level directory. Otherwise for
platform-specific development paths, locations are listed in the
sections below. (See the various Platform Guides for more information
on each platform.)