You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/09/13 20:10:52 UTC
[08/17] docs commit: non-default preference values; light edits
non-default preference values; light edits
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/71d8936c
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/71d8936c
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/71d8936c
Branch: refs/heads/master
Commit: 71d8936c7381469ac42d66207398b25063b360c7
Parents: 6dbf38e
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 16:18:35 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:31 2013 -0700
----------------------------------------------------------------------
docs/en/edge/guide/platforms/android/config.md | 76 ++++++++++--------
.../edge/guide/platforms/blackberry10/config.md | 82 ++++++++++++--------
docs/en/edge/guide/platforms/ios/config.md | 41 ++++++----
3 files changed, 118 insertions(+), 81 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/71d8936c/docs/en/edge/guide/platforms/android/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/android/config.md b/docs/en/edge/guide/platforms/android/config.md
index 0be753f..505e8ee 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -24,64 +24,85 @@ across each application and CordovaWebView instance. This section
details preferences that only apply to Android builds. See The
config.xml File for information about global configuration options.
-* `useBrowserHistory` (boolean, defaults to `true`): set to `false` if you
- want to use the history shim that was used to work around the
+<!-- QUERY: deprecated?
+
+* `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)
- <preference name="useBrowserHistory" value="fubar"/>
+ <preference name="useBrowserHistory" value="false"/>
+
+-->
* `loadingDialog`: Display a native loading dialog when loading the
app. The value's format is _Title, Message_
- <preference name="loadingDialog" value="fubar"/>
+ <preference name="loadingDialog" value="Loading, Please wait for application"/>
* `loadingPageDialog`: Display a native loading dialog when loading
sub-pages. The value's format is _Title, Message_
- <preference name="loadingPageDialog" value="fubar"/>
+ <preference name="loadingPageDialog" value="Loading, Please wait for data"/>
+
+<!-- QUERY: when do these apply? -->
* `errorUrl`: Set the error page for your application. Should be
located in your Android project in `file://android_asset/www/`
- <preference name="errorUrl" value="fubar"/>
-
-* `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. For example, `0x00000000` is black.
+ <preference name="errorUrl" value="error.html"/>
- <preference name="backgroundColor" value="fubar"/>
+<!-- QUERY: when do these apply? -->
* `loadUrlTimeoutValue`: How much time Cordova should wait before
throwing a timeout error on the application.
- <preference name="loadUrlTimeoutValue" value="fubar"/>
+ <preference name="loadUrlTimeoutValue" value="20000"/>
+
+<!-- QUERY: expressed in milliseconds? 20000 default?-->
+
+<!-- QUERY
+
+ #### Load URL timeout
+
+ * `load-url-timeout` with a value in milliseconds
+
+ * defaults to 20000 (20 seconds)
+
+ * example: `<preference name="load-url-timeout" value="15000" />`
+
+-->
+
+* `backgroundColor`: Set the app's background color. Supports a
+ four-byte hex value, with the first byte representing and alpha
+ value, and standard RGB values for the following three bytes. The
+ example below is black:
+
+ <preference name="backgroundColor" value="0x00000000"/>
* `keepRunning` (boolean, defaults to `true`): Determines whether
Cordova stays running in the background.
- <preference name="keepRunning" value="fubar"/>
+ <preference name="keepRunning" value="false"/>
+
+<!-- QUERY: does that mean in effect the app continues to execute following pause event? -->
* `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.
+ `res/drawable` directory. Multiple assets must share this common
+ name in various subdirectories. For details, see the _Icons_
+ section in The config.xml File.
- <preference name="splashscreen" value="fubar"/>
+ <preference name="splashscreen" value="splash"/>
* `disallowOverscroll` (boolean, defaults to `false`): set to `true` to
disable the glow when a user scrolls beyond the edge of the webview.
- <preference name="disallowOverscroll" value="fubar"/>
+ <preference name="disallowOverscroll" value="true"/>
-## `<plugin>`
-
-Android supports using `<feature>` as analogues to `<plugin>` elements.
+<!-- QUERY: glow? -->
<!--
- ### Android Specific
-
#### Minimum and Maximum SDK Version
* `android-minSdkVersion` and/or `android-maxSdkVersion`, with integer
@@ -128,12 +149,5 @@ Android supports using `<feature>` as analogues to `<plugin>` elements.
* supported on PhoneGap 2.1.0 and above
- #### Load URL timeout
-
- * `load-url-timeout` with a value in milliseconds
-
- * defaults to 20000 (20 seconds)
-
- * example: `<preference name="load-url-timeout" value="15000" />`
+-->
--->
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/71d8936c/docs/en/edge/guide/platforms/blackberry10/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry10/config.md b/docs/en/edge/guide/platforms/blackberry10/config.md
index f1e28383..ba48622 100644
--- a/docs/en/edge/guide/platforms/blackberry10/config.md
+++ b/docs/en/edge/guide/platforms/blackberry10/config.md
@@ -24,53 +24,67 @@ across each application and CordovaWebView instance. This section
details preferences that only apply to BlackBerry 10 builds. See The
config.xml File for information about global configuration options.
-* `autoHideSplashScreen`: (`true` or `false`): Set to `false` to control when the splashscreen
- is hidden through a JavaScript API. This preference defaults to true.
+* `autoHideSplashScreen`: (`true` or `false`): Set to `false` to
+ control when the splashscreen is hidden through a JavaScript
+ API. This preference defaults to true.
- <preference name="autoHideSplashScreen" value="fubar"/>
+ <preference name="autoHideSplashScreen" value="false"/>
-* `backgroundColor`: Specifies the background color of your app. The value must specify
- a color value in the ARGB pixel format using 8 hexadecimal digits.
+* `backgroundColor`: Specifies the background color of your app. The
+ value must specify a color value in the ARGB pixel format using 8
+ hexadecimal digits.
- <preference name="backgroundColor" value="fubar"/>
+ <preference name="backgroundColor" value="0x00000000"/>
-* `childBrowser`: Disables child browser windows. By default, when the content attempts
- to open a resource in a new window or tab (by using window.open(), or by specifying `_blank`
- as the target of an anchor), the WebWorks app will open a secondary browser window
- to display the resource. This feature is enabled by default. The value must specify
- `disable` to prevent the above actions from occuring.
+<!-- QUERY: remove "0x" from above? Varies from Android -->
- <preference name="childBrowser" value="fubar"/>
+* `childBrowser`: Disables child browser windows. By default, when the
+ content attempts to open a resource in a new window or tab (by using
+ window.open(), or by specifying `_blank` as the target of an
+ anchor), the WebWorks app will open a secondary browser window to
+ display the resource. This feature is enabled by default. The value
+ must specify `disable` to prevent the above actions from occuring.
-* `hideKeyboardFormAccessoryBar`: (`enable` or `disable`) Disables the keyboard form
- accessory bar in an HTML form. The keyboard form accessory bar is a row of
- buttons (Previous, Next, and Submit) that the user can use to navigate through a form.
- By default, when a WebWorks app contains an HTML form and an `<input>` element gets
- focus, WebWorks displays this form accessory bar. This feature allows you to prevent your
- app from displaying the form accessory bar by specifying value as `enable`.
+ <preference name="childBrowser" value="disable"/>
- <preference name="hideKeyboardFormAccessoryBar" value="fubar"/>
+* `hideKeyboardFormAccessoryBar`: (`enable` or `disable`) Disables the
+ keyboard form accessory bar in an HTML form. The keyboard form
+ accessory bar is a row of buttons (__Previous__, __Next__, and
+ __Submit__) that the user can use to navigate through a form. By
+ default, when a WebWorks app contains an HTML form and an `<input>`
+ element gets focus, WebWorks displays this form accessory bar. This
+ feature allows you to prevent your app from displaying the form
+ accessory bar by specifying value as `enable`.
-* `orientation`: (`auto`, `portrait`, or `landscape`) Specifies the persistent orientation
- for screens in your app. By default, if you do not specify a screen orientation,
- the orientation is set to auto.
+ <preference name="hideKeyboardFormAccessoryBar" value="enable"/>
- <preference name="orientation" value="fubar"/>
+<!-- QUERY: appears for >1 input? -->
-* `popupBlocker`: Enables the popup blocker. By default, all popups are displayed by
- BlackBerry WebWorks apps in a child browser window. You can prevent popups from displaying
- without user intervention by enabling the popup blocker. This is done by specifying
- value as `enable`.
+* `orientation`: (`auto`, `portrait`, or `landscape`) Specifies the
+ persistent orientation for screens in your app. By default, if you
+ do not specify a screen orientation, the orientation is set to auto.
- <preference name="popupBlocker" value="fubar"/>
+ <preference name="orientation" value="landscape"/>
-* `webSecurity`: Disables web security. Disabling web security allows you to access
- remote content from unknown sources during development. Before packaging your app for
- distribution, you should remove this setting. This feature is intended as a
- development convenience only. In production, all URIs should be known and should be
- whitelisted using the `<access>` element. To disable, specify value as `disable`.
+<!-- QUERY: different from default? -->
- <preference name="webSecurity" value="fubar"/>
+* `popupBlocker`: Enables the popup blocker. By default, all popups
+ are displayed by BlackBerry WebWorks apps in a child browser
+ window. You can prevent popups from displaying without user
+ intervention by enabling the popup blocker. This is done by
+ specifying value as `enable`.
+
+ <preference name="popupBlocker" value="enable"/>
+
+* `webSecurity`: Disables web security. Disabling web security allows
+ you to access remote content from unknown sources during
+ development. Before packaging your app for distribution, you should
+ remove this setting. This feature is intended as a development
+ convenience only. In production, all URIs should be known and should
+ be whitelisted using the `<access>` element. To disable, specify
+ value as `disable`.
+
+ <preference name="webSecurity" value="disable"/>
<!--
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/71d8936c/docs/en/edge/guide/platforms/ios/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/ios/config.md b/docs/en/edge/guide/platforms/ios/config.md
index 73fb218..5d8e49d 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -27,13 +27,15 @@ File for information about global configuration options.
* `DisallowOverscroll` (boolean, defaults to `false`): set to `true` if
you don't want the WebView to rubber-band.
- <preference name="DisallowOverscroll" value="fubar"/>
+ <preference name="DisallowOverscroll" value="true"/>
* `TopActivityIndicator` (string, defaults to `gray`): this is the top
spinning throbber in the status/battery bar, valid values are
`whiteLarge`, `white`, and `gray`.
- <preference name="TopActivityIndicator" value="fubar"/>
+ <preference name="TopActivityIndicator" value="white"/>
+
+<!-- QUERY: ??? -->
* `EnableLocation` (boolean, defaults to `false`): set to `true`, to
initialize the Geolocation plugin at start-up (so the fix on your
@@ -41,45 +43,49 @@ File for information about global configuration options.
`onload` attribute of the `Geolocation` plugin to `true`
instead.
- <preference name="EnableLocation" value="fubar"/>
+ <preference name="EnableLocation" value="true"/>
+
+<!-- QUERY: deprecated? -->
* `EnableViewportScale` (boolean, defaults to `false`): set to `true` to
prevent viewport scaling through a meta tag.
- <preference name="EnableViewportScale" value="fubar"/>
+ <preference name="EnableViewportScale" value="true"/>
+
+<!-- QUERY: Do viewport tags work in other environments? -->
* `AutoHideSplashScreen` (boolean, defaults to `true`): set to `false` to
control when the splashscreen is hidden through a JavaScript API.
- <preference name="AutoHideSplashScreen" value="fubar"/>
+ <preference name="AutoHideSplashScreen" value="false"/>
* `FadeSplashScreen` (boolean, defaults to `true`): set to `false` to
prevent the splash-screen to fade in and out when showing or hiding
it.
- <preference name="FadeSplashScreen" value="fubar"/>
+ <preference name="FadeSplashScreen" value="false"/>
* `FadeSplashScreenDuration` (float, defaults to 2): The splash-screen
Fade duration in seconds.
- <preference name="FadeSplashScreenDuration" value="fubar"/>
+ <preference name="FadeSplashScreenDuration" value="4"/>
* `ShowSplashScreenSpinner` (boolean, defaults to `true`): set to `false`
to hide the splash-screen spinner.
- <preference name="ShowSplashScreenSpinner" value="fubar"/>
+ <preference name="ShowSplashScreenSpinner" value="false"/>
* `MediaPlaybackRequiresUserAction` (boolean, defaults to `false`): set
to true to not allow autoplayed HTML5 video.
- <preference name="MediaPlaybackRequiresUserAction" value="fubar"/>
+ <preference name="MediaPlaybackRequiresUserAction" value="true"/>
* `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.
- <preference name="AllowInlineMediaPlayback" value="fubar"/>
+ <preference name="AllowInlineMediaPlayback" value="true"/>
* `BackupWebStorage` (string, defaults to `cloud`): valid values are
`none`, `cloud` and `local`. Set to `cloud` to allow the web
@@ -87,26 +93,28 @@ File for information about global configuration options.
allow local backups (iTunes sync). Set to `none` to not allow any
backups of web storage.
- <preference name="BackupWebStorage" value="fubar"/>
+ <preference name="BackupWebStorage" value="local"/>
* `KeyboardDisplayRequiresUserAction` (boolean, defaults to `true`):
set to false to open the keyboard when form elements get focus via
the JavaScript focus() call.
- <preference name="KeyboardDisplayRequiresUserAction" value="fubar"/>
+ <preference name="KeyboardDisplayRequiresUserAction" value="false"/>
* `SuppressesIncrementalRendering` (boolean, defaults to `false`): set
to true to wait until all new view content has been received
before it is rendered.
- <preference name="SuppressesIncrementalRendering" value="fubar"/>
+ <preference name="SuppressesIncrementalRendering" value="true"/>
* `HideKeyboardFormAccessoryBar` (boolean, defaults to `false`): set to
true to hide the additional toolbar that is on top of the
keyboard. This toolbar features the __Prev__, __Next__, and __Done__
buttons.
- <preference name="HideKeyboardFormAccessoryBar" value="fubar"/>
+ <preference name="HideKeyboardFormAccessoryBar" value="true"/>
+
+<!-- QUERY: do form helpers only appear when there's >1 input? -->
* `KeyboardShrinksView` (boolean, defaults to `false`): set to `true` to
shrink the WebView when the keyboard comes up. The WebView shrinks
@@ -115,7 +123,7 @@ File for information about global configuration options.
of the WebView. This is the default behaviour on Android, and makes
a lot of sense when building apps as opposed to webpages.
- <preference name="KeyboardShrinksView" value="fubar"/>
+ <preference name="KeyboardShrinksView" value="true"/>
<!--
@@ -230,4 +238,5 @@ File for information about global configuration options.
* default is _true_
--->
\ No newline at end of file
+-->
+