You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by fi...@apache.org on 2013/02/01 22:53:17 UTC
docs commit: CB-1365: moving config.xml example to top-level guide.
formatting for ios + android sub-guides.
Updated Branches:
refs/heads/master 0dec28ffc -> a1c4729ac
CB-1365: moving config.xml example to top-level guide. formatting for ios + android sub-guides.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/a1c4729a
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/a1c4729a
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/a1c4729a
Branch: refs/heads/master
Commit: a1c4729ac041d66d663dfded4dc518e5e6a59004
Parents: 0dec28f
Author: Fil Maj <ma...@gmail.com>
Authored: Fri Feb 1 13:56:56 2013 -0800
Committer: Fil Maj <ma...@gmail.com>
Committed: Fri Feb 1 13:56:56 2013 -0800
----------------------------------------------------------------------
.../edge/guide/project-settings/android/index.md | 30 ++++--------
docs/en/edge/guide/project-settings/index.md | 12 ++++-
docs/en/edge/guide/project-settings/ios/index.md | 37 ++++++---------
3 files changed, 35 insertions(+), 44 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/a1c4729a/docs/en/edge/guide/project-settings/android/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/android/index.md b/docs/en/edge/guide/project-settings/android/index.md
index 197b139..1df7a7c 100644
--- a/docs/en/edge/guide/project-settings/android/index.md
+++ b/docs/en/edge/guide/project-settings/android/index.md
@@ -22,25 +22,15 @@
Project Settings for Android
===================================
-The **config.xml settings file** controls various settings of Cordova. This is application wide, and not set per CordovaWebView Instance. For example:
+The `config.xml` settings file controls various settings of Cordova. This is application wide, and not set per CordovaWebView Instance.
- <cordova>
- <preference name="MySetting" value="true" />
- <plugins>
- <plugin name="MyPlugin" value="MyPluginClass" />
- </plugins>
- <access origin="*" />
- </cordova>
+Various **other** preferences (as **<preference>** tags) default on not breaking existing apps. The available preferences are:
-1. A list of **plugins** allowed to be used in a CordovaWebView.
-2. A **white-list** of hosts that Cordova is allowed to connect to (add an **<access>** tag, and set the origin attribute - wildcards allowed)
-3. Various **other** preferences (as **<preference>** tags) defaults err on not breaking existing apps)
-
-a. **useBrowserHistory (boolean, defaults to true)** - set to false if you want to use the history shim that was used to work around the hashtag error present in Android 3.x prior to the history fix. (Note: This setting will be deprecated in April 2013)
-b. **loadingDialog** - Display a native loading dialog when loading the app. Format for the value is "Title, Message"
-c. **loadingPageDialog** - Display a native loading dialog when loading sub-pages. Format for the value is "Title, Message"
-d. **errorUrl** - Set the error page for your application. Should be located in your Android project in file://android_asset/www/
-e. **backgroundColor** - Set the background color for your application. Supports a four-byte hex value, with the first byte representing alpha value, and the following three bytes with standard RGB values. (i.e. 0x00000000 = Black)
-f. **loadUrlTimeoutValue** - How much time Cordova should wait before throwing a timeout error on the application.
-g. **keepRunning (boolean, defaults to true)** - Determines whether Cordova will keep running in the background or not
-h. **splashscreen** - The name of the file minus its extension in the res/drawable directory. If you have multiple assets, they all must share this common name in their respective directories.
+1. **useBrowserHistory (boolean, defaults to true)** - set to false if you want to use the history shim that was used to work around the hashtag error present in Android 3.x prior to the history fix. (Note: This setting will be deprecated in April 2013)
+2. **loadingDialog** - Display a native loading dialog when loading the app. Format for the value is "Title, Message"
+3. **loadingPageDialog** - Display a native loading dialog when loading sub-pages. Format for the value is "Title, Message"
+4. **errorUrl** - Set the error page for your application. Should be located in your Android project in file://android_asset/www/
+5. **backgroundColor** - Set the background color for your application. Supports a four-byte hex value, with the first byte representing alpha value, and the following three bytes with standard RGB values. (i.e. 0x00000000 = Black)
+6. **loadUrlTimeoutValue** - How much time Cordova should wait before throwing a timeout error on the application.
+7. **keepRunning (boolean, defaults to true)** - Determines whether Cordova will keep running in the background or not
+8. **splashscreen** - The name of the file minus its extension in the res/drawable directory. If you have multiple assets, they all must share this common name in their respective directories.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/a1c4729a/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
index 5c230bd..2699bc0 100644
--- a/docs/en/edge/guide/project-settings/index.md
+++ b/docs/en/edge/guide/project-settings/index.md
@@ -48,6 +48,16 @@ abstractions that are heavily standards driven and adopted by the web community.
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:
+
+ <cordova>
+ <preference name="MySetting" value="true" />
+ <plugins>
+ <plugin name="MyPlugin" value="MyPluginClass" />
+ </plugins>
+ <access origin="*" />
+ </cordova>
+
A list of supported elements across major platforms which are supported in Apache Cordova follow.
### `<plugin>`
@@ -66,4 +76,4 @@ These elements define how your whitelist works. Please see the Domain Whitelist
### `<content>`
-This element defines the start page of your application. The default is "index.html".
+This element defines the start page of your application, relative to the project's standard web assets root folder. The default is "index.html".
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/a1c4729a/docs/en/edge/guide/project-settings/ios/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/project-settings/ios/index.md b/docs/en/edge/guide/project-settings/ios/index.md
index 5e0f390..ba1a0db 100644
--- a/docs/en/edge/guide/project-settings/ios/index.md
+++ b/docs/en/edge/guide/project-settings/ios/index.md
@@ -22,38 +22,29 @@
Project Settings for iOS
========================
-The **config.xml settings file** controls various settings of Cordova. This is application wide, and not set per CDVViewController instance. An example:
+The `config.xml` settings file controls various settings of Cordova. This is application wide, and not set per CDVViewController instance.
+The `config.xml` file is located in your `<project folder>/<appname>` directory.
- <cordova>
- <preference name="MySetting" value="true" />
- <plugins>
- <plugin name="MyPlugin" value="MyPluginClass" />
- </plugins>
- <access origin="*" />
- </cordova>
+Various preferences (as **<preference>** tags) default on not breaking existing apps. The available preferences are:
-1. A list of **plugins** (plugin tags under **<cordova>/<plugins>**) allowed to be used in a CDVViewController (set in the Plugins dictionary - name is the servicename used in JavaScript, and the value is the Objective-C class for the plugin that is a CDVPlugin sub-class)
-2. A **white-list** of hosts that Cordova is allowed to connect to (add an **<access>** tag, and set the origin attribute - wildcards allowed)
-3. Various **other** preferences (as **<preference>** tags) defaults err on not breaking existing apps)
+1. **UIWebViewBounce (boolean, defaults to true)** - set to false if you don't want the WebView to rubber-band
- a. **UIWebViewBounce (boolean, defaults to true)** - set to false if you don't want the WebView to rubber-band
+2. **TopActivityIndicator (string, defaults to 'gray')** - this is the top spinning throbber in the status/battery bar, valid values are "whiteLarge", "white" and "gray"
- b. **TopActivityIndicator (string, defaults to 'gray')** - this is the top spinning throbber in the status/battery bar, valid values are "whiteLarge", "white" and "gray"
+3. **EnableLocation (boolean, defaults to false)** - set to true, to initialize the Geolocation plugin at start-up (so the fix on your location can be more accurate)
- c. **EnableLocation (boolean, defaults to false)** - set to true, to initialize the Geolocation plugin at start-up (so the fix on your location can be more accurate)
+4. **EnableViewportScale (boolean, defaults to false)** - set to true to prevent viewport scaling through a meta tag
- d. **EnableViewportScale (boolean, defaults to false)** - set to true to prevent viewport scaling through a meta tag
+5. **AutoHideSplashScreen (boolean, defaults to true)** - set to false to control when the splashscreen is hidden through a JavaScript API
- e. **AutoHideSplashScreen (boolean, defaults to true)** - set to false to control when the splashscreen is hidden through a JavaScript API
+6. **ShowSplashScreenSpinner (boolean, defaults to true)** - set to false to hide the splash-screen spinner
- f. **ShowSplashScreenSpinner (boolean, defaults to true)** - set to false to hide the splash-screen spinner
+7. **MediaPlaybackRequiresUserAction (boolean, defaults to false)** - set to true to not allow autoplayed HTML5 video
- g. **MediaPlaybackRequiresUserAction (boolean, defaults to false)** - set to true to not allow autoplayed HTML5 video
+8. **AllowInlineMediaPlayback (boolean, defaults to false)** - set to true to allow inline HTML5 media playback, also, the video element in the HTML document must also include the webkit-playsinline attribute
- h. **AllowInlineMediaPlayback (boolean, defaults to false)** - set to true to allow inline HTML5 media playback, also, the video element in the HTML document must also include the webkit-playsinline attribute
-
- i. **BackupWebStorage (string, defaults to 'cloud')** - valid values are 'none', 'cloud' and 'local'. Set to 'cloud' to allow the web storage data to be backed up to iCloud, and set to 'local' to only allow local backups (iTunes sync). Set to 'none' to not allow any backups of web storage.
+9. **BackupWebStorage (string, defaults to 'cloud')** - valid values are 'none', 'cloud' and 'local'. Set to 'cloud' to allow the web storage data to be backed up to iCloud, and set to 'local' to only allow local backups (iTunes sync). Set to 'none' to not allow any backups of web storage.
- j. **KeyboardDisplayRequiresUserAction (boolean, defaults to true)** - set to false to open the keyboard when form elements get focus via the JavaScript focus() call.
+10. **KeyboardDisplayRequiresUserAction (boolean, defaults to true)** - set to false to open the keyboard when form elements get focus via the JavaScript focus() call.
- k. **SuppressesIncrementalRendering (boolean, defaults to false)** - set to true to wait until all new view content has been received before it is rendered.
+11. **SuppressesIncrementalRendering (boolean, defaults to false)** - set to true to wait until all new view content has been received before it is rendered.